Difference between revisions of "NDGIR"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
 
Line 6: Line 6:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadInt32FromPlugin()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadInt32FromPlugin()</p>Returns<br>int32 - value || Reads an Int32 value directly from a C# gameplay plugin.
 
|}
 
|}
 
</center>
 
</center>
Line 17: Line 17:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadInt64FromPlugin()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadInt64FromPlugin()</p>Returns<br>int64 - value || Reads an Int64 value directly from a C# gameplay plugin.
 
|}
 
|}
 
</center>
 
</center>
Line 28: Line 28:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadBooleanFromPlugin()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadBooleanFromPlugin()</p>Returns<br>bool - value || Reads a boolean value directly from a C# gameplay plugin.
 
|}
 
|}
 
</center>
 
</center>
Line 39: Line 39:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadDoubleFromPlugin()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadDoubleFromPlugin()</p>Params<br>double - value || Reads a double value directly from a C# gameplay plugin.
 
|}
 
|}
 
</center>
 
</center>
Line 50: Line 50:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadObjectFromPlugin()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadObjectFromPlugin()</p>Returns<br>object - value || Reads an object directly from a C# gameplay plugin.
 
|}
 
|}
 
</center>
 
</center>
Line 61: Line 61:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadStringFromPlugin()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReadStringFromPlugin()</p>Returns<br>string - value || Reads a string value directly from a C# gameplay plugin.
 
|}
 
|}
 
</center>
 
</center>
Line 72: Line 72:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">RefreshView()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">RefreshView()</p>Params<br>eventid - event identifier of view to refresh || Force a search subscription to update outside of its normal update timer.
 
|}
 
|}
 
</center>
 
</center>
Line 83: Line 83:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">RegisterEventHandler()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">RegisterEventHandler()</p>Params<br>eventtype - event type to be fired<br>eventid - event identifier of the specific event<br>function - Handler function reference. Can be a function name or a function defined inline || Registers an event handler which calls the specified function when the Events fires with a matching event identifier. These handlers are not saved and must be registered every time the object is loaded.
 
|}
 
|}
 
</center>
 
</center>
Line 94: Line 94:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">RegisterSingleEventHandler()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">RegisterSingleEventHandler()</p>Params<br>eventtype - event type to be fired<br>eventid - event identifier of the specific event<br>function - Handler function reference. Can be a function name or a function defined inlin || Registers an event handler that will only fire once, which calls the specified function when the Events fires with a matching event identifier. These handlers are not saved and must be registered every time the object is loaded .
 
|}
 
|}
 
</center>
 
</center>
Line 105: Line 105:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReloadModule()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReloadModule()</p>Params<br>modulename - module or script name to reload || Reloads the specified behavior in memory.
 
|}
 
|}
 
</center>
 
</center>
Line 116: Line 116:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReloadTemplates()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReloadTemplates()</p> || Reloads all templates in memory.
 
|}
 
|}
 
</center>
 
</center>
Line 127: Line 127:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ResetPermanentObjectStates()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ResetPermanentObjectStates()</p> || Reset all permanent objects to their default state.
 
|}
 
|}
 
</center>
 
</center>

Latest revision as of 20:13, 23 November 2019

[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

ReadInt32FromPlugin()

Returns
int32 - value
Reads an Int32 value directly from a C# gameplay plugin.

Example

 CODE EXAMPLE BLOCK

ReadInt64FromPlugin()

Returns
int64 - value
Reads an Int64 value directly from a C# gameplay plugin.

Example

 CODE EXAMPLE BLOCK

ReadBooleanFromPlugin()

Returns
bool - value
Reads a boolean value directly from a C# gameplay plugin.

Example

 CODE EXAMPLE BLOCK

ReadDoubleFromPlugin()

Params
double - value
Reads a double value directly from a C# gameplay plugin.

Example

 CODE EXAMPLE BLOCK

ReadObjectFromPlugin()

Returns
object - value
Reads an object directly from a C# gameplay plugin.

Example

 CODE EXAMPLE BLOCK

ReadStringFromPlugin()

Returns
string - value
Reads a string value directly from a C# gameplay plugin.

Example

 CODE EXAMPLE BLOCK

RefreshView()

Params
eventid - event identifier of view to refresh
Force a search subscription to update outside of its normal update timer.

Example

 CODE EXAMPLE BLOCK

RegisterEventHandler()

Params
eventtype - event type to be fired
eventid - event identifier of the specific event
function - Handler function reference. Can be a function name or a function defined inline
Registers an event handler which calls the specified function when the Events fires with a matching event identifier. These handlers are not saved and must be registered every time the object is loaded.

Example

 CODE EXAMPLE BLOCK

RegisterSingleEventHandler()

Params
eventtype - event type to be fired
eventid - event identifier of the specific event
function - Handler function reference. Can be a function name or a function defined inlin
Registers an event handler that will only fire once, which calls the specified function when the Events fires with a matching event identifier. These handlers are not saved and must be registered every time the object is loaded .

Example

 CODE EXAMPLE BLOCK

ReloadModule()

Params
modulename - module or script name to reload
Reloads the specified behavior in memory.

Example

 CODE EXAMPLE BLOCK

ReloadTemplates()

Reloads all templates in memory.

Example

 CODE EXAMPLE BLOCK

ResetPermanentObjectStates()

Reset all permanent objects to their default state.

Example

 CODE EXAMPLE BLOCK