NDGIS

[Main] [Lua Examples]

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Global Functions & Examples

SaveSeedGroup() Params seedgroup - seed group to save bool - Should this group be excluded from the list of seed groups that are initially loaded seedobjectsarray - Array of seed object data in the side table format to the right.

Save seed objects for a specific seed group table_template = { Template = templateId, Position = pos, Rotation = rot, Scale = scale, ObjVarOverrides = { Name = Value, Name = Value ... }, SharedStateOverrides = { Name = Value, Name = Value ... }, }.

Example

 CODE EXAMPLE BLOCK

SaveTemplateData() Params templatedata - template table data categoryname - category name templatename - template name Returns bool - true if save was successful, false if not

Save template data to a template.

Example

 CODE EXAMPLE BLOCK

SendMessageToPlugin() Params pluginname - plug-in name to send to eventid - event identifier name (...) One or more object arguments to be passed to the plug-in

Sends a message to a C# gameplay plugin.

Example

 CODE EXAMPLE BLOCK

SendRemoteMessage() Params regionaddress - target region address location - target location range - range around target location eventid - message to event handler object - serializable event parameters

Sends a message to all objects at a location on another region server.

Example

 CODE EXAMPLE BLOCK

SendRequestToPlugin() Params pluginname - plug-in name to send to (...) One or more object arguments to be passed to the plug-in Returns a single value, or an array of values

Sends a direct request to a C# gameplay plugin.

Example

 CODE EXAMPLE BLOCK

ServerTimeMs() Returns number - server time in milliseconds

Return the current server time in milliseconds.

Example

 CODE EXAMPLE BLOCK

SetEvent() Params key - key unique key identifier value - value string value (ex JSON string)

Redis set command, will create if doesn't exist and overwrite what does exist at given key.

Example

 CODE EXAMPLE BLOCK

SetLuaDebugLevel() Params debuglevel - debug level (All,Off,Error,Warning,Information,Verbose)

Set the debug log output level for the lua environment.

Example

 CODE EXAMPLE BLOCK

SetLuaProfilingEnabled() Params bool - isenabled

Enabled/disable lua profiling.

Example

 CODE EXAMPLE BLOCK

SortedSetEvent() Params key - key unique key identifier value - value string value (generally JSON string)

Redis database Sorted Set with automatic timestamp score.

Example

 CODE EXAMPLE BLOCK

SortedSetScoreEvent() Params key - key unique key identifier value - value string value(generally JSON string) number - value score value

Redis database Sorted Set with an explicit score value.

Example

 CODE EXAMPLE BLOCK

ShutdownServer()

Shuts the server down.

Example

 CODE EXAMPLE BLOCK