Package | com.smartfoxserver.v2.entities |
Interface | public interface IMMOItem |
Implementors | MMOItem |
In the SmartFoxServer 2X client API this interface is implemented by the MMOItem class. Read the class description for additional informations.
See also
Property | Defined 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 |
Method | Defined By | ||
---|---|---|---|
containsVariable(name:String):Boolean
Indicates whether this item has the specified MMOItem Variable set or not. | IMMOItem | ||
getVariable(name:String):IMMOItemVariable
Retrieves an MMOItem Variable from its name. | IMMOItem | ||
getVariables():Array
Retrieves all the MMOItem Variables of this item. | IMMOItem |
aoiEntryPoint | property |
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.
public function get aoiEntryPoint():Vec3D
See also
id | property |
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.
public function get id():int
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.
|
Boolean — true 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.
|
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.
ReturnsArray — The list of MMOItemVariable objects associated to this item.
|
See also