Difference between revisions of "NDGIR"
(9 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
+ | <p style="width:60%;margin: 0 auto">[[NewDawnHome|[Main]]] [[NDServerIndexScriptsMain|[Lua Examples]]]</p> | ||
<center><p style="width: 60%">[[NDGIA|A]] [[NDGIB|B]] [[NDGIC|C]] [[NDGID|D]] [[NDGIE|E]] [[NDGIF|F]] [[NDGIG|G]] [[NDGIH|H]] [[NDGII|I]] [[NDGIJ|J]] [[NDGIK|K]] [[NDGIL|L]] [[NDGIM|M]] [[NDGIN|N]] [[NDGIO|O]] [[NDGIP|P]] [[NDGIQ|Q]] [[NDGIR|R]] [[NDGIS|S]] [[NDGIT|T]] [[NDGIU|U]] [[NDGIV|V]] [[NDGIW|W]] [[NDGIX|X]] [[NDGIY|Y]] [[NDGIZ|Z]]</p></center> | <center><p style="width: 60%">[[NDGIA|A]] [[NDGIB|B]] [[NDGIC|C]] [[NDGID|D]] [[NDGIE|E]] [[NDGIF|F]] [[NDGIG|G]] [[NDGIH|H]] [[NDGII|I]] [[NDGIJ|J]] [[NDGIK|K]] [[NDGIL|L]] [[NDGIM|M]] [[NDGIN|N]] [[NDGIO|O]] [[NDGIP|P]] [[NDGIQ|Q]] [[NDGIR|R]] [[NDGIS|S]] [[NDGIT|T]] [[NDGIU|U]] [[NDGIV|V]] [[NDGIW|W]] [[NDGIX|X]] [[NDGIY|Y]] [[NDGIZ|Z]]</p></center> | ||
<p style="color: #DDDD88;font-size: 22px;width:60%;margin: 0 auto">Global Functions & Examples</p> | <p style="color: #DDDD88;font-size: 22px;width:60%;margin: 0 auto">Global Functions & Examples</p> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |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> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ReloadTemplates()</p> || Reloads all templates in memory. | ||
+ | |} | ||
+ | </center> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> | ||
+ | |||
+ | <center> | ||
+ | {| class="wikitable" | style="width: 60%" | ||
+ | |- | ||
+ | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">ResetPermanentObjectStates()</p> || Reset all permanent objects to their default state. | ||
+ | |} | ||
+ | </center> | ||
+ | <p style="width: 60%;margin: 0 auto">Example</p> | ||
+ | <div style="width:60%;margin: 0 auto"> | ||
+ | CODE EXAMPLE BLOCK | ||
+ | </div> |
Latest revision as of 20:13, 23 November 2019
Global Functions & Examples
ReadInt32FromPlugin() Returnsint32 - value |
Reads an Int32 value directly from a C# gameplay plugin. |
Example
CODE EXAMPLE BLOCK
ReadInt64FromPlugin() Returnsint64 - value |
Reads an Int64 value directly from a C# gameplay plugin. |
Example
CODE EXAMPLE BLOCK
ReadBooleanFromPlugin() Returnsbool - value |
Reads a boolean value directly from a C# gameplay plugin. |
Example
CODE EXAMPLE BLOCK
ReadDoubleFromPlugin() Paramsdouble - value |
Reads a double value directly from a C# gameplay plugin. |
Example
CODE EXAMPLE BLOCK
ReadObjectFromPlugin() Returnsobject - value |
Reads an object directly from a C# gameplay plugin. |
Example
CODE EXAMPLE BLOCK
ReadStringFromPlugin() Returnsstring - value |
Reads a string value directly from a C# gameplay plugin. |
Example
CODE EXAMPLE BLOCK
RefreshView() Paramseventid - event identifier of view to refresh |
Force a search subscription to update outside of its normal update timer. |
Example
CODE EXAMPLE BLOCK
RegisterEventHandler() Paramseventtype - 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() Paramseventtype - 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() Paramsmodulename - 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