| Package | com.smartfoxserver.v2.entities.variables |
| Class | public class BaseVariable |
| Inheritance | BaseVariable  Object |
| Implements | Variable |
| Subclasses | MMOItemVariable, SFSBuddyVariable, SFSRoomVariable, SFSUserVariable |
See also
| Property | Defined By | ||
|---|---|---|---|
| name : String [read-only]
Indicates the name of this variable. | BaseVariable | ||
| type : String [read-only]
Indicates the type of this variable. | BaseVariable | ||
| Method | Defined By | ||
|---|---|---|---|
getBoolValue():Boolean
Retrieves the value of a boolean variable. | BaseVariable | ||
getDoubleValue():Number
Retrieves the value of a numeric variable. | BaseVariable | ||
getIntValue():int
Retrieves the value of an integer variable. | BaseVariable | ||
Retrieves the value of a SFSArray variable. | BaseVariable | ||
Retrieves the value of a SFSObject variable. | BaseVariable | ||
getStringValue():String
Retrieves the value of a string variable. | BaseVariable | ||
getValue():*
Retrieves the untyped value of this variable. | BaseVariable | ||
isNull():Boolean
Indicates if the variable is null. | BaseVariable | ||
| name | property |
name:String [read-only] Indicates the name of this variable.
public function get name():String| type | property |
type:String [read-only] Indicates the type of this variable.
public function get type():String| getBoolValue | () | method |
public function getBoolValue():BooleanRetrieves the value of a boolean variable.
ReturnsBoolean — The variable value as a Boolean.
|
| getDoubleValue | () | method |
public function getDoubleValue():NumberRetrieves the value of a numeric variable.
ReturnsNumber — The variable value as a Number.
|
| getIntValue | () | method |
public function getIntValue():intRetrieves the value of an integer variable.
Returnsint — The variable value as an int.
|
| getSFSArrayValue | () | method |
public function getSFSArrayValue():ISFSArrayRetrieves the value of a SFSArray variable.
ReturnsISFSArray — The variable value as an ISFSArray.
|
| getSFSObjectValue | () | method |
public function getSFSObjectValue():ISFSObjectRetrieves the value of a SFSObject variable.
ReturnsISFSObject — The variable value as an ISFSObject.
|
| getStringValue | () | method |
public function getStringValue():StringRetrieves the value of a string variable.
ReturnsString — 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.
Boolean — true if the variable has a null value.
|