Modding Flash in The Secret World

[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.

[Cairenn]

Example File

You can find a very simple example UI made following this guide in the Customized folder.

It is called Test01.swf