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.

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.


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 / Number

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

Number - is similar to “Text”, except you can use it to display just numbers.

Default Text/Number - sets the default value that will appear inside the text box.


Direction (Angle)

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


Rotation (Angle)

Displays a picture panel where you can set the angle orientation.


Color

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


Color with Alpha

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


Time

Displays three text boxes for hour, minute and second time intervals.


Time with Delay

Similar to “Time”, except a “Delay” check box is also added that will pause the script.


Speed

Displays a text box where you can set a numeric value for speed.


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.


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

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.


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: 2017/02/11 05:50 by Lee