NDGIG

[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

GetAllRegions() Params prefix - prefix (optional) Returns table - array of each region's name

Returns a list of all region names.

Example

 CODE EXAMPLE BLOCK

GetAllSeedGroups() Params grouptype - All, DefaultOnly, ModOnly bool - should result include groups that are excluded from the initial load Returns table - Array of group names

Get the list of all seed object groups.

Example

 CODE EXAMPLE BLOCK

GetAllTemplateNames() Params filter - filter string by category Returns table - Array of template names

Get a list of template names.

Example

 CODE EXAMPLE BLOCK

GetBans() Params eventid - event identifier for the resulting getbanlist event

Gets a list of all active bans on the server.

Example

 CODE EXAMPLE BLOCK

GetCharacterListForUser() Params userid - userid to get the character list for eventid - event identifier for the resulting characterlistrequestresult event Returns table - table of characters names and matching character ids.

.

Example

 CODE EXAMPLE BLOCK

GetClusterRegions() Returns table - table of regions in the cluster key = region address, value = {WorldName=worldname, SubregionName=subregion} NOTE: Subregion will be nil if no subregion is being used for that region server

Returns a table containing the available regions in the cluster INCLUDING itself.

Example

 CODE EXAMPLE BLOCK

GetCollisionInfoAtLoc() Params location - location to test<returns>array - array of strings

Returns an array of strings containing information about the objects with collision at the specified location. This is in the form of the type of object Dynamic Object / Permanent Object and the items ID. If there is also a static collision entry present at this location the AARect2D bounds of this static collision entry are returned

Example

 CODE EXAMPLE BLOCK

GetCurrentModule() Returns string - name of current script

Returns the name of the top-level script/module this function is called in.

Example

 CODE EXAMPLE BLOCK

GetCurrentObject() Returns string - objectreference to the currently executing script

Returns the object reference of the object the current script is executing upon.

Example

 CODE EXAMPLE BLOCK

GetInitializerFromTemplate() Params templateid - template id luamod - lua module to extract initializer Returns table - Null of the initialization string that was used

Returns the Initializer that was used for this templete and module.

Example

 CODE EXAMPLE BLOCK

GetLuaExtensionsEnabled() Returns avgrunframetime - Average running frametime of simulation thread

Returns if it is possible to load lua exceptions .

Example

 CODE EXAMPLE BLOCK

GetModName() Returns string - name of currently running mod

Returns the name of the currently running mod.

Example

 CODE EXAMPLE BLOCK

GetPrefabExtents() Params prefabname - Prefab Name Returns box - prefab extents

.

Example

 CODE EXAMPLE BLOCK

GetLuaProfilingEnabled() Returns bool - is this enabled

Returns lua profiling enabled state.

Example

 CODE EXAMPLE BLOCK

GetRegion() Params regionname - Region Name Returns GameRegion - region object

Returns the game region by name.

Example

 CODE EXAMPLE BLOCK

GetPath() Params pathname - the path name Returns table - path elements

Returns the static world path by name.

Example

 CODE EXAMPLE BLOCK

GetRegionsAtLoc() Params location - location to check prefix - prefix to filter Returns table - Array of region objects

Returns all game regions found at this location.

Example

 CODE EXAMPLE BLOCK

GetSmallestRegionAtLoc() Params location - location to check prefix - prefix to filter Returns table - Array of region objects

Returns the smallest game region found at this location.

Example

 CODE EXAMPLE BLOCK

GetSeedGroupCount() Params seedgroup - Seed group full name Returns table - array of group entries

Get the number of seed objects in a group.

Example

 CODE EXAMPLE BLOCK

GetSeedGroupData() Params seedgroup - Seed group full name Returns table - array of group entries

Get the seed object data for a given seed object groups.

Example

 CODE EXAMPLE BLOCK

GetTemplateCategories() Returns table - array of template categories

Get a list of template categories.

Example

 CODE EXAMPLE BLOCK

GetTemplateData() Params templateid - Template id Returns table - template data

Get all of the data for a given template id in table form.

Example

 CODE EXAMPLE BLOCK

GetTemplateIconId() Params templateid - template id Returns objectid - template object icon id

Get all of the data for a given template id in table form.

Example

 CODE EXAMPLE BLOCK

GetTemplateObjVar() Params templateid - template to get the variable from varaiblename - variable name to get Returns the value of the objvar

Get an object variable entry from a specified template.

Example

 CODE EXAMPLE BLOCK

GetTemplateObjectBounds() Params templateid - template id Returns table - lua array of object bounds 3d rectangles

Get the object bounds for the client id specified in the template. Not all objects have object bounds specified.

Example

 CODE EXAMPLE BLOCK

GetTempmlateObjectName() Params templateid - template id Returns string - template object name

Get the name specified in the template.

Example

 CODE EXAMPLE BLOCK

GetTemplateObjectProperty() Params templateid - template id propertyname - object property name Returns string - template object name

Get the default object property specified in the template.

Example

 CODE EXAMPLE BLOCK

GetTemplateRoofBounds() Params templateid - templateid Returns templateid - template id

Get the roof bounds for the client id specified in the template. Not all objects have roof bounds specified.

Example

 CODE EXAMPLE BLOCK

GetUserdataType() Params object - any userdata type object Returns string - type of given object

Attempts to return the C# type of a given userdata value.

Example

 CODE EXAMPLE BLOCK

GetViewObjectCount()

.

Example

 CODE EXAMPLE BLOCK

GetViewObjects() Params eventid event identifier to look for Returns table - array of objects currently in the view

Get the list of known objects for this subscription/view.

Example

 CODE EXAMPLE BLOCK

GlobalVarDelete() Params recordname - name of record to delte eventid - event identifier for the globalvarupdateresult message

Requests an asyncronous delete of a global variable.

Example

 CODE EXAMPLE BLOCK

GlobalVarListRecords() Params recordpath - record path Returns table - table array of matching record names

Returns list of record names matching (starting with) the record path.

Example

 CODE EXAMPLE BLOCK

GlobalVarRead() Params recordname - record name Returns table - table record for global variable

Returns a global record table. These records are accessible to every region in a cluster.

Example

 CODE EXAMPLE BLOCK

GlobalVarReadKey() Params recordkey - record key objectkey - object key Returns object - table record key value for global variable

Returns a global record table key value. These records are accessible to every region in a cluste.

Example

 CODE EXAMPLE BLOCK

GlobalVarWrite() Params recordname - name of record to write to eventid - event identifier for the globalvarupdateresult message function - Callback function to be called when the lock is granted (must accept a table as a parameter and return true to commit the change)

Request a lock on a given global variable so the callback can make changes to the record. The callback function passed must take a table parameter and return true if it wants to commit the change. If it returns false or nil, the write will be cancelled. You can not replace the table that is passed to the callback. You can only edit the entries in the table. For example [[ function(record) record = { NewTable = true } end ]] will not modify the record table at all. Instead, you should do function(record) record.NewTable = true end . NOTE: This is an asynchronous operation. The callback function will not be called until the global var database grants you a lock. Make sure the object is not destroyed while it's waiting for a lock or the callback will never execute.

Example

 CODE EXAMPLE BLOCK