UserVariable

All Superinterfaces:

java.lang.Cloneable, Variable

All Known Subinterfaces:

IMMOItemVariable, RoomVariable

All Known Implementing Classes:

MMOItemVariable, SFSRoomVariable, SFSUserVariable
```
public interface UserVariable
extends Variable
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isHidden()`	Checks if the variable is "hidden".
`boolean`	`isPrivate()`
`boolean`	`isStorable()`	Storable variables can be saved by the Room Persistence API
`void`	`setHidden(boolean flag)`	Set the variable as "hidden".
`void`	`setNull()`	This is used by the system to mark removed variables.
`void`	`setPrivate(boolean flag)`
`void`	`setStorable(boolean value)`	Flags this variable as storable (default = true).

Methods inherited from interface com.smartfoxserver.v2.entities.variables.Variable
getBoolValue, getDoubleValue, getIntValue, getName, getSFSArrayValue, getSFSObjectValue, getStringValue, getType, getValue, isNull, toSFSArray

- Method Detail
  - 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 the client.
    
    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()
```
  - setPrivate
```
void setPrivate(boolean flag)
```
  - setNull
```
void setNull()
```
    This is used by the system to mark removed variables.
  - isStorable
```
boolean isStorable()
```
    Storable variables can be saved by the Room Persistence API
    
    Returns:
    
    true if the variable is storable, false otherwise
    
    Since:
    
    2.14.x
  - setStorable
```
void setStorable(boolean value)
```
    Flags this variable as storable (default = true). All non-storable variables are ignored by the Room Persistence API
    
    Since:
    
    2.14.x