Difference between revisions of "NDOII"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
<center><p style="width: 60%">[[NDOIA|A]][[NDOIB|B]][[NDOIC|C]][[NDOID|D]][[NDOIE|E]][[NDOIF|F]][[NDOIG|G]][[NDOIH|H]][[NDOII|I]][[NDOIJ|J]][[NDOIK|K]][[NDOIL|L]][[NDOIM|M]][[NDOIN|N]][[NDOIO|O]][[NDOIP|P]][[NDOIQ|Q]][[NDOIR|R]][[NDOIS|S]][[NDOIT|T]][[NDOIU|U]][[NDOIV|V]][[NDOIW|W]][[NDOIX|X]][[NDOIY|Y]][[NDOIZ|Z]]</p></center>
+
<p style="width:60%;margin: 0 auto">[[NewDawnHome|[Main]]] [[NDServerIndexScriptsMain|[Lua Examples]]]</p>
 +
<center><p style="width: 60%">[[NDOIA|A]] [[NDOIB|B]] [[NDOIC|C]] [[NDOID|D]] [[NDOIE|E]] [[NDOIF|F]] [[NDOIG|G]] [[NDOIH|H]] [[NDOII|I]] [[NDOIJ|J]] [[NDOIK|K]] [[NDOIL|L]] [[NDOIM|M]] [[NDOIN|N]] [[NDOIO|O]] [[NDOIP|P]] [[NDOIQ|Q]] [[NDOIR|R]] [[NDOIS|S]] [[NDOIT|T]] [[NDOIU|U]] [[NDOIV|V]] [[NDOIW|W]] [[NDOIX|X]] [[NDOIY|Y]] [[NDOIZ|Z]]</p></center>
 
<p style="color: #DDDD88;font-size: 22px;width:60%;margin: 0 auto">Object Functions & Examples</p>
 
<p style="color: #DDDD88;font-size: 22px;width:60%;margin: 0 auto">Object Functions & Examples</p>
  
Line 5: Line 6:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsBeingCarriedBy() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsBeingCarriedBy()</p>Params<br>gameobject - carrier<br>Returns<br>bool -  If the object is being carried by the specified object, true. Otherwise false || Is this object currently in the carry slot for this mobile. The carry slot is used when a user has picked up an object but not dropped it..
 
|}
 
|}
 
</center>
 
</center>
Line 13: Line 14:
 
</div>
 
</div>
  
 +
<center>
 +
{| class="wikitable" | style="width: 60%"
 +
|-
 +
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsCloaked()</p>Returns<br>bool - is cloaked true/false || Is the object cloaked.
 +
|}
 +
</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">IsContainedBy()</p>Params<br>gameobject - container object if its contained, nil if not<br>bool - should we check multiple levles up<br>Returns<br>bool - is the object inside the specified target || Returns true if the object is inside the specified container.
 +
|}
 +
</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">IsContainer()</p>Returns<br>bool - true if this object is a container || Returns if its a container object.
 +
|}
 +
</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">IsEquipped()</p>Returns<br>bool - true if item is equipped, false if not || Checks to see if the object is equipped by anyone.
 +
|}
 +
</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">IsEquippedOn()</p>Params<br>gameobject - equipper object<br>Returns<br>bool - true if this object is equipped on a given object || Checks to see if the object is equipped on the specified object.
 +
|}
 +
</center>
 +
<p style="width: 60%;margin: 0 auto">Example</p>
 +
<div style="width:60%;margin: 0 auto">
 +
  CODE EXAMPLE BLOCK
 +
</div>
  
 
<center>
 
<center>
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsContainedBy() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsFull()</p>Returns<br>bool - true if full, false if not || Determine if this container is full and cannot accept more items.
 
|}
 
|}
 
</center>
 
</center>
Line 28: Line 83:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsContainer() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsInContainer()</p>Returns<br>bool - true if object is inside a container || Returns if the object is inside a contianer.
 
|}
 
|}
 
</center>
 
</center>
Line 39: Line 94:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsEquipped() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsInRegion()</p>Params<br>regionname - the name of the region<br>Returns<br>bool - true if is in the specified region || Is the object in the specified region.
 
|}
 
|}
 
</center>
 
</center>
Line 50: Line 105:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsEquippedOn() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsMobile()</p>Returns<br>bool - true if the object is a mobile object || Returns if its a mobile object. A mobile is a special class of object that can travel around fluidly.
 
|}
 
|}
 
</center>
 
</center>
Line 61: Line 116:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsFull() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsMobileFrozen()</p>Params<br>bool - true if frozem, false if not || Is the mobile object frozen. This only works for Mobiles. The argument is always set to true,OptionaL check if the mobs turn is frozen also (default true) meaning the argument is unused.
 +
|}
 +
</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">IsMoving()</p>Returns<br>bool - true if moving, false if not || Returns true if a mobile is currently moving.
 
|}
 
|}
 
</center>
 
</center>
Line 72: Line 139:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsInContainer() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsPathingToTarget()</p>Returns<br>bool - true if is pathing, false if not || Returns if the current mobile has a PathToTarget set on it or not.
 
|}
 
|}
 
</center>
 
</center>
Line 83: Line 150:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsMobile() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsPermanent()</p>Returns<br>??????? || Returns if this object is a permanent, static object or a dynamic, nonpermanent object. Defined under dynamic objects as well.
 
|}
 
|}
 
</center>
 
</center>
Line 94: Line 161:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsMoving() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsPlayer()</p>Returns<br>bool - true if a player false if not || Is this object a player.
 
|}
 
|}
 
</center>
 
</center>
Line 105: Line 172:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsPermanent() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsRegeneratingStat()</p>Params<br>statname - stat name<br>Returns<br>bool - true if regenerating stat || Returns true if the specified stat support regen and max value.
 
|}
 
|}
 
</center>
 
</center>
Line 116: Line 183:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsUser() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsUser()</p>Returns<br>bool - has a user attached to, if so true, if not then false || Returns if object has a user attached to it.
 
|}
 
|}
 
</center>
 
</center>
Line 127: Line 194:
 
{| class="wikitable" | style="width: 60%"
 
{| class="wikitable" | style="width: 60%"
 
|-
 
|-
−
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsValid() || .
+
|style="width: 40%"| <p style="color: #DDDD88;font-size: 18px">IsValid()</p> || .
 
|}
 
|}
 
</center>
 
</center>

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

IsBeingCarriedBy()

Params
gameobject - carrier
Returns
bool - If the object is being carried by the specified object, true. Otherwise false		 Is this object currently in the carry slot for this mobile. The carry slot is used when a user has picked up an object but not dropped it..

Example

 CODE EXAMPLE BLOCK

IsCloaked()

Returns
bool - is cloaked true/false		 Is the object cloaked.

Example

 CODE EXAMPLE BLOCK

IsContainedBy()

Params
gameobject - container object if its contained, nil if not
bool - should we check multiple levles up
Returns
bool - is the object inside the specified target		 Returns true if the object is inside the specified container.

Example

 CODE EXAMPLE BLOCK

IsContainer()

Returns
bool - true if this object is a container		 Returns if its a container object.

Example

 CODE EXAMPLE BLOCK

IsEquipped()

Returns
bool - true if item is equipped, false if not		 Checks to see if the object is equipped by anyone.

Example

 CODE EXAMPLE BLOCK

IsEquippedOn()

Params
gameobject - equipper object
Returns
bool - true if this object is equipped on a given object		 Checks to see if the object is equipped on the specified object.

Example

 CODE EXAMPLE BLOCK

IsFull()

Returns
bool - true if full, false if not		 Determine if this container is full and cannot accept more items.

Example

 CODE EXAMPLE BLOCK

IsInContainer()

Returns
bool - true if object is inside a container		 Returns if the object is inside a contianer.

Example

 CODE EXAMPLE BLOCK

IsInRegion()

Params
regionname - the name of the region
Returns
bool - true if is in the specified region		 Is the object in the specified region.

Example

 CODE EXAMPLE BLOCK

IsMobile()

Returns
bool - true if the object is a mobile object		 Returns if its a mobile object. A mobile is a special class of object that can travel around fluidly.

Example

 CODE EXAMPLE BLOCK

IsMobileFrozen()

Params
bool - true if frozem, false if not		 Is the mobile object frozen. This only works for Mobiles. The argument is always set to true,OptionaL check if the mobs turn is frozen also (default true) meaning the argument is unused.

Example

 CODE EXAMPLE BLOCK


IsMoving()

Returns
bool - true if moving, false if not		 Returns true if a mobile is currently moving.

Example

 CODE EXAMPLE BLOCK

IsPathingToTarget()

Returns
bool - true if is pathing, false if not		 Returns if the current mobile has a PathToTarget set on it or not.

Example

 CODE EXAMPLE BLOCK

IsPermanent()

Returns
???????		 Returns if this object is a permanent, static object or a dynamic, nonpermanent object. Defined under dynamic objects as well.

Example

 CODE EXAMPLE BLOCK

IsPlayer()

Returns
bool - true if a player false if not		 Is this object a player.

Example

 CODE EXAMPLE BLOCK

IsRegeneratingStat()

Params
statname - stat name
Returns
bool - true if regenerating stat		 Returns true if the specified stat support regen and max value.

Example

 CODE EXAMPLE BLOCK

IsUser()

Returns
bool - has a user attached to, if so true, if not then false		 Returns if object has a user attached to it.

Example

 CODE EXAMPLE BLOCK

IsValid()

 .

Example

 CODE EXAMPLE BLOCK
Retrieved from "https://adminwiki.legendsofaria.com/index.php?title=NDOII&oldid=11657"