NDOIG

[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

GetAccessLevel() Returns accesslevel - access level of user

Get the access level of the user attached to this object.

Example

 CODE EXAMPLE BLOCK

GetAllEquippedObjects() Returns table - array of all equipped objects in the gameobject

Get object equipped in the specified slot.

Example

 CODE EXAMPLE BLOCK

GetAllModules() table - array of all current lua modles

Gets a list of all the script modules that are currently attached to the given object.

Example

 CODE EXAMPLE BLOCK

GetAllObjVars() Returns table - a table of object variables on the given object

Returns a (table) of all given object variables for a given object.

Example

 CODE EXAMPLE BLOCK

GetAllSharedObjectProperties() Returns table of all shared object properties

Returns all shared object properties for the object.

Example

 CODE EXAMPLE BLOCK

GetAllStats() Returns table - a table of an object's given stat variables

Returns a (table) of all given stat variables for a given object. Table fields are dependent on "Type" key. Type maps to either Regen or Simple.(String). All entries have Value -> (double) Regen types include keys MaxValue -> (double) and RegenRate (double).

Example

 CODE EXAMPLE BLOCK

GetAssetBundleName() Returns string - asset bundle name

Get the asset bundle name this object is associated with if not the default.

Example

 CODE EXAMPLE BLOCK

GetAttachedUserId() Params userid - userid of attached player

If a player is attached to this object, it will return the unique user id for that player. This is a unique identifier for a player. Can be used to identify a player regardless of character. This works even if the character is offline!

Example

 CODE EXAMPLE BLOCK

GetBaseMoveSpeed() Returns number - base movement speed

Get the base movement speed of this mobile.

Example

 CODE EXAMPLE BLOCK

GetCharacterName() Returns string - name of the character

Returns a characters name regardless if they are online on this region or not.

Example

 CODE EXAMPLE BLOCK

GetColor() Returns string - New color in format (FFFFFF) ie: Red,Green,Blue in hexidecimal format

Gets the color of this object.

Example

 CODE EXAMPLE BLOCK

GetContainedObjects()

.

Example

 CODE EXAMPLE BLOCK

GetCreationTemplateId()

.

Example

 CODE EXAMPLE BLOCK

GetCurrentMoveSpeedModifier()

.

Example

 CODE EXAMPLE BLOCK

GetDest()

.

Example

 CODE EXAMPLE BLOCK

GetEquippedObject()

.

Example

 CODE EXAMPLE BLOCK

GetFacing()

.

Example

 CODE EXAMPLE BLOCK

GetHue()

.

Example

 CODE EXAMPLE BLOCK

GetIconId()

.

Example

 CODE EXAMPLE BLOCK

GetIPAddress()

.

Example

 CODE EXAMPLE BLOCK

GetItemCount()

.

Example

 CODE EXAMPLE BLOCK

GetLoc()

.

Example

 CODE EXAMPLE BLOCK

GetMobileType()

.

Example

 CODE EXAMPLE BLOCK

GetName()

.

Example

 CODE EXAMPLE BLOCK

GetObjVar()

.

Example

 CODE EXAMPLE BLOCK

GetObjVarType()

.

Example

 CODE EXAMPLE BLOCK

GetObjectOwner()

.

Example

 CODE EXAMPLE BLOCK

GetObjectOwner()

.

Example

 CODE EXAMPLE BLOCK

GetObjectTag()

.

Example

 CODE EXAMPLE BLOCK

GetObjectTags()

.

Example

 CODE EXAMPLE BLOCK

GetPathTarget()

.

Example

 CODE EXAMPLE BLOCK

GetRestrictedStatUpdateLevel()

.

Example

 CODE EXAMPLE BLOCK

GetRotation()

.

Example

 CODE EXAMPLE BLOCK

GetScale()

.

Example

 CODE EXAMPLE BLOCK

GetSharedObjectProperty()

.

Example

 CODE EXAMPLE BLOCK

GetStatMaxValue()

.

Example

 CODE EXAMPLE BLOCK

GetStatRegenRate()

.

Example

 CODE EXAMPLE BLOCK

GetStatValue()

.

Example

 CODE EXAMPLE BLOCK

GetStatVisibility()

.

Example

 CODE EXAMPLE BLOCK

GetTimerDelay()

.

Example

 CODE EXAMPLE BLOCK

GetUpdateRange()

.

Example

 CODE EXAMPLE BLOCK