Packagecom.smartfoxserver.v2.entities.variables
Classpublic class BaseVariable
InheritanceBaseVariable Inheritance Object
Implements Variable
Subclasses MMOItemVariable, SFSBuddyVariable, SFSRoomVariable, SFSUserVariable

The BaseVariable object is the base class for all SmartFoxServer Variable entities on the client.

See also

SFSUserVariable
SFSRoomVariable
SFSBuddyVariable
MMOItemVariable
SFSObject
SFSArray


Public Properties
 PropertyDefined By
  name : String
[read-only] Indicates the name of this variable.
BaseVariable
  type : String
[read-only] Indicates the type of this variable.
BaseVariable
Public Methods
 MethodDefined By
  
getBoolValue():Boolean
Retrieves the value of a boolean variable.
BaseVariable
  
Retrieves the value of a numeric variable.
BaseVariable
  
Retrieves the value of an integer variable.
BaseVariable
  
Retrieves the value of a SFSArray variable.
BaseVariable
  
Retrieves the value of a SFSObject variable.
BaseVariable
  
Retrieves the value of a string variable.
BaseVariable
  
Retrieves the untyped value of this variable.
BaseVariable
  
isNull():Boolean
Indicates if the variable is null.
BaseVariable
Property Detail
nameproperty
name:String  [read-only]

Indicates the name of this variable.


Implementation
    public function get name():String
typeproperty 
type:String  [read-only]

Indicates the type of this variable.


Implementation
    public function get type():String
Method Detail
getBoolValue()method
public function getBoolValue():Boolean

Retrieves the value of a boolean variable.

Returns
Boolean — The variable value as a Boolean.
getDoubleValue()method 
public function getDoubleValue():Number

Retrieves the value of a numeric variable.

Returns
Number — The variable value as a Number.
getIntValue()method 
public function getIntValue():int

Retrieves the value of an integer variable.

Returns
int — The variable value as an int.
getSFSArrayValue()method 
public function getSFSArrayValue():ISFSArray

Retrieves the value of a SFSArray variable.

Returns
ISFSArray — The variable value as an ISFSArray.
getSFSObjectValue()method 
public function getSFSObjectValue():ISFSObject

Retrieves the value of a SFSObject variable.

Returns
ISFSObject — The variable value as an ISFSObject.
getStringValue()method 
public function getStringValue():String

Retrieves the value of a string variable.

Returns
String — The variable value as a String.
getValue()method 
public function getValue():*

Retrieves the untyped value of this variable.

Returns
* — The variable untyped value.
isNull()method 
public function isNull():Boolean

Indicates if the variable is null.

Returns
Booleantrue if the variable has a null value.