Difference between revisions of "NDGIF"
(2 intermediate revisions by the same user not shown) | |||
Line 6: | Line 6: | ||
{| class="wikitable" | style="width: 60%" | {| class="wikitable" | style="width: 60%" | ||
|- | |- | ||
− | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindObject() || . | + | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindObject()</p>Params<br>ObjectSearcher - object searcher to use<br>gameobject - Optional source object(default:object current behavior is attached to)<br>Returns<br>gameobject - first object matching the criteria || Return the first object that matches the search criteria.The source object is always excluded from the search.The source object location is used as the search center for most searchers |
|} | |} | ||
</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">FindObjectWithTag() || . | + | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindObjectWithTag()</p>Params<br>tag - tag to search<br>Returns<br>gameobject - first object matching the criteria || Return the first object with the specified tag. |
|} | |} | ||
</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">FindObjectWithTagInRange() || . | + | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindObjectWithTagInRange()</p>Params<br>tag - tag to search<br>location - location to search around<br>distance - distances from location<br>Returns<br>gameobject - first object matching criteria || Return the first object with the specified tag within a range of a specified location (does not take height into account). |
|} | |} | ||
</center> | </center> | ||
Line 38: | Line 38: | ||
{| class="wikitable" | style="width: 60%" | {| class="wikitable" | style="width: 60%" | ||
|- | |- | ||
− | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindObjects() || . | + | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindObjects()</p>ObjectSearcher - object searcher to use<br>gameobject - Optional source object(default:object current behavior is attached to)<br>Returns<br>table - Array of objects matching the criteria || Return an array of objects that match the search criteria. The source object is always excluded from the search. The source object location is used as the search center for most searchers.. |
|} | |} | ||
</center> | </center> | ||
Line 49: | Line 49: | ||
{| class="wikitable" | style="width: 60%" | {| class="wikitable" | style="width: 60%" | ||
|- | |- | ||
− | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindObjectsWithTagInRange() || . | + | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindObjectsWithTagInRange()</p>Params<br>tag - tag to search<br>location - location to search around<br>distance - distances from location<br>Returns<br>table- Array of objects matching criteria || . |
|} | |} | ||
</center> | </center> | ||
Line 59: | Line 59: | ||
{| class="wikitable" | style="width: 60%" | {| class="wikitable" | style="width: 60%" | ||
|- | |- | ||
− | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindPermanentObjects() || . | + | |style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">FindPermanentObjects()</p>Params<br>ObjectSearcher - Object searcher to use<br>Returns<br>table - Array of objects matching the criteria || Return an array of permanent objects that match the search criteria. |
+ | |} | ||
+ | </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">ForceBackup()</p> || Force the server to perform a backup cycle. | ||
+ | |} | ||
+ | </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">ForceDisconnect()</p>Params<br>objectid - the players objectid to disconnect || Forces a given player to be disconnected and logged off without triggering a character save. | ||
|} | |} | ||
</center> | </center> |
Latest revision as of 05:07, 18 November 2019
Global Functions & Examples
FindObject() ParamsObjectSearcher - object searcher to use gameobject - Optional source object(default:object current behavior is attached to) Returns gameobject - first object matching the criteria |
Return the first object that matches the search criteria.The source object is always excluded from the search.The source object location is used as the search center for most searchers |
Example
CODE EXAMPLE BLOCK
FindObjectWithTag() Paramstag - tag to search Returns gameobject - first object matching the criteria |
Return the first object with the specified tag. |
Example
CODE EXAMPLE BLOCK
FindObjectWithTagInRange() Paramstag - tag to search location - location to search around distance - distances from location Returns gameobject - first object matching criteria |
Return the first object with the specified tag within a range of a specified location (does not take height into account). |
Example
CODE EXAMPLE BLOCK
FindObjects() ObjectSearcher - object searcher to usegameobject - Optional source object(default:object current behavior is attached to) Returns table - Array of objects matching the criteria |
Return an array of objects that match the search criteria. The source object is always excluded from the search. The source object location is used as the search center for most searchers.. |
Example
CODE EXAMPLE BLOCK
FindObjectsWithTagInRange() Paramstag - tag to search location - location to search around distance - distances from location Returns table- Array of objects matching criteria |
. |
Example
CODE EXAMPLE BLOCK
FindPermanentObjects() ParamsObjectSearcher - Object searcher to use Returns table - Array of objects matching the criteria |
Return an array of permanent objects that match the search criteria. |
Example
CODE EXAMPLE BLOCK
ForceBackup() |
Force the server to perform a backup cycle. |
Example
CODE EXAMPLE BLOCK
ForceDisconnect() Paramsobjectid - the players objectid to disconnect |
Forces a given player to be disconnected and logged off without triggering a character save. |
Example
CODE EXAMPLE BLOCK