User Tools

Site Tools


networkmessages

Network Messages

Network Messages allow you to create unique script events that are transferred between the server and its clients. These events will then show at the top of the event list in the Script Editor.

General

Display Name - is used to identify the Network Message in the editor.

Scripting ID - is used to identify the Network Message through scripting.

Description - a brief summary of what the Network Message does.

Icon (32×32) - a 32×32 image to make it easier to identify your Network Message in the event list.

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

Server can send this to clients - when ticked, this will allow the server to execute this script on connected client machines.

Clients can send this to server - when ticked, this will allow connected client machines to execute this script on the server.

Guaranteed delivery (TCP) - when ticked, Network Messages will use reliable TCP to communicate with the client/server. When unticked, Network Messages will instead use the less reliable, but faster, UDP to communicate with the client/server - with a fall back mechanism to use TCP if UDP is unavailable.

Transfer Collections - when ticked, the contents of a Collection will be transferred when the Network Message is executed. You may select multiple Collections.

Transfer Tables - when ticked, the contents of a Table will be transferred when the Network Message is executed. You may select multiple Tables.


Parameters (optional)

By clicking “Add” and “Remove”, you can control which parameters will be available when the Network Message 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.


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.


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.

networkmessages.txt · Last modified: 2017/02/11 05:50 by Lee