UserVariable

All Superinterfaces:: Cloneable, Variable

All Known Subinterfaces:: IMMOItemVariable, RoomVariable

All Known Implementing Classes:: MMOItemVariable, SFSRoomVariable, SFSUserVariable

public interface UserVariable extends Variable

Method Summary

Modifier and Type

Method

Description

boolean

isHidden()

Checks if the variable is hidden

boolean

isPrivate()

A private UserVariable is only known and updated for the owner, not other clients

boolean

isStorable()

Storable variables can be saved by the Room Persistence API

void

setHidden(boolean flag)

Set the variable as hidden.

void

setNull()

void

setPrivate(boolean flag)

A private UserVariable is only known and updated for the owner, not other clients

void

setStorable(boolean value)

Flags this variable as storable (default = true).

Methods inherited from interface com.smartfoxserver.entities.variables.Variable
getBoolValue, getByteValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getName, getSFSArrayValue, getSFSObjectValue, getShortValue, getStringValue, getType, getValue, getVector2Value, getVector3Value, isNull, toSFSArray

Method Details
- setHidden
  
  void setHidden(boolean flag)
  
  Set the variable as hidden. When this flag is turned on the variable will be available exclusively on the server side and it will never be transmitted to clients.
  
  Parameters:
  
  flag -
- isHidden
  
  boolean isHidden()
  
  Checks if the variable is hidden
  Returns:
  
  true if the variable is hidden
  
  See Also:
  
  setHidden(boolean)
- isPrivate
  
  boolean isPrivate()
  
  A private UserVariable is only known and updated for the owner, not other clients
  
  Returns:
  
  true if private
- setPrivate
  
  void setPrivate(boolean flag)
  
  A private UserVariable is only known and updated for the owner, not other clients
  
  Parameters:
  
  flag -
- setNull
  
  void setNull()
  
  Internal
- isStorable
  
  boolean isStorable()
  
  Storable variables can be saved by the Room Persistence API
  
  Returns:
  
  true if the variable is storable, false otherwise
- setStorable
  
  void setStorable(boolean value)
  
  Flags this variable as storable (default = true). All non-storable variables are ignored by the Room Persistence API