Modding Flash in The Secret World

[Cairenn]

USEFUL SHORTCUTS/COMMANDS

• CTRL+SHIFT+F1 or /reloadui
  • Reloads all the GUI framework
• /loadclip <swf-file>
  • Load a swf file into the game. Game will look first in the Customized folder for the specified name.
• /unloadclip <swf-file>
  • Unload a previously loaded flash file.
• /loadclip DebugWindow.swf
  • Flash Debug window
    • Use this debug window to inspect all the variables in the UI. Please note that you can scroll on this UI (even though no scrolling bar is shown!).

[Cairenn]

HOW TO ADD A NEW UI:

Step 1
Create a Modules.xml file (or edit if one already exists) in the Customized folder.

Step 2
Add your own module by adding the info below (if Modules.xml already exists, just add the Module section to the existing file):

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<Root>
  <Module name="Test01"
    movie             = "Test01.swf"
    flags             = "GMF_CLOSE_ON_ESCAPE"
    depth_layer       = "Middle"
    sub_depth         = "0"
    variable          = "test01_module"
    criteria          = "test01_module &amp;&amp; (guimode &amp; GUIMODEFLAGS_INPLAY)"
  />
</Root>

Step 3
Register your module in the preferences

• For character based UI, use CharPrefs.xml
• For account based UI, use LoginPrefs.xml
• For machine based UI, use MainPrefs.xml

Example:

• Create a file with the name you selected from above in the Customized folder (or edit if one already exists)
• Add the following lines (for example in CharPrefs.xml):

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<Root>
  <Value name="test01_module" value="true"/>
</Root>

• "true" will have it open by default

Step 4
Load and see you UI in the game client by copying your Test01.swf into the Customized/Flash folder.
You can use the following commands to see your UI in game:

• /setoption test01_module <true|false>
• /setoption test01_module !test01_module
  • (Use this one to be able to easily toggle.)

NOTE: Please note that your movie clips MUST implement a onRelease() function for it to receive any mouse events. (It can be an empty function.)

NOTE: Please note that you will need to embed the fonts you use into the flash file.

[Cairenn]

ADDITIONAL INFO

depth_layer

"depth_layer" values map to an enum in CPP code. Here is the mapping:

enum ViewLayer_e
{
  e_ViewLayerDebugBack,        // "DebugBack"
  e_ViewLayerBack,        // "Back"
  e_ViewLayerMiddle,        // "Middle"
  e_ViewLayerTop,        // "Top"
  e_ViewLayerOptions,        // "Options"
  e_ViewLayerDialogs,        // "Dialogs"
  e_ViewLayerTooltip,        // "Tooltip"
  e_ViewLayerDragAndDrop,    // "DragAndDrop"
  e_ViewLayerOnScreenMessage,    // "OnScreenMessage"
  e_ViewLayerSplashScreen,    // "SplashScreen"
  e_ViewLayerSplashScreenTop,    // "SplashScreenTop"
  e_ViewLayerDebugTop        // "DebugTop"
};

[Cairenn]

sub_depth

"sub_depth" sorts the UIs within a depth_layer.

If you have all UIs in a layer to have a sub_depth of 0, then the framework will sort by the last clicked.

[Cairenn]

flags

Module flags define certain behaviours. See the list below.

GMF_DONT_UNLOAD           = 0x0020, // Loaded at first use and kept forever
  GMF_PRELOAD               = 0x0040, // Loaded at client startup and it is kept forever
  GMF_CLOSE_ON_ESCAPE       = 0x0080, // Closes when pressen ESC key

[Cairenn]

criteria

Defines an expression that will determine when your UI can be opened.

The start of your expression should always be the variable you defined. In our example: test01_module.

Then you should usually only allow the UI to open while your character is in play.

This prevents the UI from showing while on the loading screen or cinematics, etc.

This is achieved by adding the section:

 && (guimode & GUIMODEFLAGS_INPLAY)

[Cairenn]

Scaleform CLIK

Funcom uses the Scaleform middleware in our GUI framework. Scaleform has their own set of basic components called CLIK.

Please note that you will not be able to reuse/edit/improve Funcom's flash files that use CLIK components unless you own a license yourself.

You may, however, build your own components (buttons, lists, etc) from scratch.