User Tools

Site Tools


customevents

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.

Branch Possibilities - sets the amount of “nodes” that will appear underneath the event when placed in the Script Editor.


Parameters (optional)

By clicking “Add” and “Remove”, you can control which parameters will be available when the Custom Event is used. These parameters can also 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. These parameters include:

Text

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


Paragraph (Multi-line Text)

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


Number

Similar to “Text”, except you can use it to display just numbers.


Direction (Angle)

Displays a directional dial where you can select angles from 0 to 359.


Direction (Cardinal)

Displays a panel where you can select between eight different cardinal directions: “Right”, “Right-Down”, “Down”, “Left-Down”, “Left”, “Left-Up”, “Up” and “Right-Up”.


Color

Displays a standard Windows color window where you can choose from different swatches or define your own color using RGB values.


Color with Transparency

Similar to “Color”, except it also includes a transparency slider.


X, Y and Z

Similar to “Text”, except you can enter X, Y and Z coordinates.


Toggle

Displays two radio buttons that you can choose between. When setting up the script, refer to the parameters as either 0 or 1 as indicated.


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.


Object Listing

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.

customevents.txt · Last modified: 2016/07/13 03:46 by Lee