Custom Events

Custom Events allow you to create unique script events specifically tailored for your projects. If there’s something specific you need to be done but an event doesn’t exist for it, then you can simply create your own. These events will then show at the top of the event list in the Script Editor.


General

Display Name – is used to identify the Custom Event in the editor.

Scripting ID – is used to identify the Custom Event through scripting.

Description – a brief summary of what the Custom Event does.

Icon (32×32) – a 32×32 image to make it easier to identify your Custom Event in the event list.

Use Value / Function (returns a value) – when ticked, the Custom Event will appear in the Use Value window.

Make last multi-select object listing parameter a collection – when ticked, 001 Game Creator will treat the last multi-selection parameter as a Collection.

Complexity – is used to set how the event will be listed in the Script Editor.

Branch Possibilities – sets the amount of “nodes” that will appear underneath the event when placed in the Script Editor. Which node is taken is determined by the number that is returned at the end of the custom event via the Return Value scripting event.


Parameters (optional)

By clicking Add and Remove buttons, you can control which parameters will be available when the Custom Event is used. These parameters also need to be named separately to identify them using the Variable Name text box. An optional tooltip will display for said parameter if the Tooltip Description text box is filled. Any parameter that allows you to pick multiple objects will run the custom event multiple times for each option selected, unless the Make last multi-select object listing parameter a collection is checked, and the parameter is the last in the list.


Text / Number / List

Text – Displays a text box where you can type in letters, numbers and other characters.

Number – Similar to Text, except you can use it to display just numbers. Any text typed into this box will be treated as a Use Value.

List – Contains a custom set list of entries that you can select from. This is useful when you need to pick a choice, that requires more than 2 options. If you pick multiple list options the event will run for each option picked.

Default/Listing – sets the default value that will appear inside the text box. When using a List, you can separate options using a semi-colon (;). Example: Option 1;Option 2;Option 3;Option 4


Direction (Angle) / Rotation (Angle)

Allows you to pick a direction or a rotation/orientation, which is a value between -3.14 and 3.14.


Color / Color with Alpha

Displays a standard Windows color window where you can choose from different swatches or define your own color using RGB values. The alpha option allows you to also specify how transparent the color is.


Time / Time with Delay

Displays three text boxes for hour, minute and second time intervals. The delay option allows you to pause the script until this amount of time has passed.


Speed

Displays a text box where you can set a numeric value for speed. The number returned will be Number/100, so an input of 10 will actually be an input of 0.1 in the script.


Multi-Line Text

Similar to “Text”, except you are provided with a text box with multiple lines and also provides a box to change text color. This provides spaces for a lot more text to be displayed.


Text Cluster

Displays 20 text boxes, with Use Value buttons, to allow for multiple values.


Branch Text Cluster

Similar to “Text Cluster”, except each of the 20 text boxes creates a new scripting node underneath it.


X, Y and Z

Allows you to pick co-ordinates on a map visually. To set this up, your custom event must contain a Dynamic List – Map, X, Y and Z parameters. Once you pick a map it will allow you to pick map co-ordinates by clicking on the preview window.


Toggle

Displays two radio buttons that you can choose between. When setting up the script, the value of this parameter will either be 0 or 1.


Ranged Number

Displays a sliding bar between the minimum and maximum values. The value will be set to whatever is specified in the Default text box.


Dynamic List

Displays a list of elements from your project. For elements like Maps, Actors and Doors to Teams, Actor Templates and Sounds/Music.


Branch Possibilities

Displays a sliding bar between the minimum and maximum values. The value set will correspond to the amount of “nodes” that will appear underneath the event when placed in the Script Editor.