Packagecom.smartfoxserver.v2.entities
Interfacepublic interface IMMOItem
Implementors MMOItem

The IMMOItem interface defines all the methods and properties that an object representing a SmartFoxServer MMOItem entity exposes.

In the SmartFoxServer 2X client API this interface is implemented by the MMOItem class. Read the class description for additional informations.

See also

MMOItem


Public Properties
 PropertyDefined By
  aoiEntryPoint : Vec3D
[read-only] Returns the entry point of this item in the current user's AoI.
IMMOItem
  id : int
[read-only] Indicates the id of this item.
IMMOItem
Public Methods
 MethodDefined By
  
containsVariable(name:String):Boolean
Indicates whether this item has the specified MMOItem Variable set or not.
IMMOItem
  
Retrieves an MMOItem Variable from its name.
IMMOItem
  
getVariables():Array
Retrieves all the MMOItem Variables of this item.
IMMOItem
Property Detail
aoiEntryPointproperty
aoiEntryPoint:Vec3D  [read-only]

Returns the entry point of this item in the current user's AoI.

The returned coordinates are those that the item had when its presence in the current user's Area of Interest was last notified by a SFSEvent.PROXIMITY_LIST_UPDATE event. This field is populated only if the MMORoom in which the item exists is configured to receive such data.


Implementation
    public function get aoiEntryPoint():Vec3D

See also

idproperty 
id:int  [read-only]

Indicates the id of this item. It is unique and it is generated by the server when the item is created.


Implementation
    public function get id():int
Method Detail
containsVariable()method
public function containsVariable(name:String):Boolean

Indicates whether this item has the specified MMOItem Variable set or not.

Parameters

name:String — The name of the MMOItem Variable whose existance must be checked.

Returns
Booleantrue if an MMOItem Variable with the passed name is set for this item.
getVariable()method 
public function getVariable(name:String):IMMOItemVariable

Retrieves an MMOItem Variable from its name.

Parameters

name:String — The name of the MMOItem Variable to be retrieved.

Returns
IMMOItemVariable — The MMOItemVariable object, or null if no MMOItem Variable with the passed name is associated to this item.

See also

getVariables()method 
public function getVariables():Array

Retrieves all the MMOItem Variables of this item.

Returns
Array — The list of MMOItemVariable objects associated to this item.

See also