Difference between revisions of "NDOIH"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 5: Line 5:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasAccessLevel()</p> || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasAccessLevel()</p>Params<br>accesslevel - access level requirement<br>bool - true if users satisfy's requirement || Does the attached user's access level satisfy the access requirement.
 
|}
 
|}
 
</center>
 
</center>
Line 16: Line 16:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasEventHandler()</p>  || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasEventHandler()</p>Params<br>eventtype - even type name<br>Returns<br>true if exists || Is there an event handler registered on any module attached to this object that matches the parameters.
 
|}
 
|}
 
</center>
 
</center>
Line 27: Line 27:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasLineOfSightToLoc()</p>  || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasLineOfSightToLoc()</p>Params<br>location - location to check<br>number - (number) Optional: Height of line. Ignore all collision that is lower than this height (Default 0.0f)<br>Returns<br>bool - True if it has LOS, false if not. || Does this object have line of sight to the specified location.
 
|}
 
|}
 
</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">HasLineOfSightToObj()</p>  || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasLineOfSightToObj()</p>Params<br>gameobject - target game object<br>number - Optional: Height of line. Ignore all collision that is lower than this height (Default 0.0f)<br>Returns<br>bool - True if it has LOS, false if not. || Does this object have line of sight to the specified object (This should be used for objects so the collision for the targetted object can be ignored for the LOS check).
 
|}
 
|}
 
</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">HasObjVar()</p>  || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasObjVar()</p>Params<br>name - name of given object variable<br>Returns<br>bool - true if exists, false if not || Check to see if a given object variable exists in the current object. Use this to check beforehand so that you aren't getting an error getting object variables that don't exist.
 
|}
 
|}
 
</center>
 
</center>
Line 60: Line 60:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasObjectTag()</p>  || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasObjectTag()</p>Returns<br>bool - true if exists, false if not || Checks if this object has a specific tag based on it's client type.
 
|}
 
|}
 
</center>
 
</center>
Line 71: Line 71:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasModule()</p>  || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasModule()</p>Params<br>name - module name to check for<br>Returns<br>bool - true if exists, false if not || Determines if the current object has a script module from the given name.
 
|}
 
|}
 
</center>
 
</center>
Line 82: Line 82:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasSharedObjectProperty()</p>  || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasSharedObjectProperty()</p>Params<br>name -  Name of the SharedObjectProperties to check<br>Returns<br>bool - Does it have this property? True if yes, False if no || Does the object have the SharedObjectProperties specified.
 
|}
 
|}
 
</center>
 
</center>
Line 93: Line 93:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasTimer()</p>  || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">HasTimer()</p>Params<br>name - name of the timer identifier<br>Returns<br>bool - true if exists || Is there a timer scheduled in the future with this identifier.
 
|}
 
|}
 
</center>
 
</center>

Latest revision as of 07:35, 27 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

Object Functions & Examples

HasAccessLevel()

Params
accesslevel - access level requirement
bool - true if users satisfy's requirement
Does the attached user's access level satisfy the access requirement.

Example

 CODE EXAMPLE BLOCK

HasEventHandler()

Params
eventtype - even type name
Returns
true if exists
Is there an event handler registered on any module attached to this object that matches the parameters.

Example

 CODE EXAMPLE BLOCK

HasLineOfSightToLoc()

Params
location - location to check
number - (number) Optional: Height of line. Ignore all collision that is lower than this height (Default 0.0f)
Returns
bool - True if it has LOS, false if not.
Does this object have line of sight to the specified location.

Example

 CODE EXAMPLE BLOCK

HasLineOfSightToObj()

Params
gameobject - target game object
number - Optional: Height of line. Ignore all collision that is lower than this height (Default 0.0f)
Returns
bool - True if it has LOS, false if not.
Does this object have line of sight to the specified object (This should be used for objects so the collision for the targetted object can be ignored for the LOS check).

Example

 CODE EXAMPLE BLOCK

HasObjVar()

Params
name - name of given object variable
Returns
bool - true if exists, false if not
Check to see if a given object variable exists in the current object. Use this to check beforehand so that you aren't getting an error getting object variables that don't exist.

Example

 CODE EXAMPLE BLOCK

HasObjectTag()

Returns
bool - true if exists, false if not
Checks if this object has a specific tag based on it's client type.

Example

 CODE EXAMPLE BLOCK

HasModule()

Params
name - module name to check for
Returns
bool - true if exists, false if not
Determines if the current object has a script module from the given name.

Example

 CODE EXAMPLE BLOCK

HasSharedObjectProperty()

Params
name - Name of the SharedObjectProperties to check
Returns
bool - Does it have this property? True if yes, False if no
Does the object have the SharedObjectProperties specified.

Example

 CODE EXAMPLE BLOCK

HasTimer()

Params
name - name of the timer identifier
Returns
bool - true if exists
Is there a timer scheduled in the future with this identifier.

Example

 CODE EXAMPLE BLOCK