com.electrotank.electroserver4.extensions.api.value
Interface ReadOnlyRoomVariable

public interface ReadOnlyRoomVariable

Room Variables are name/value pairs stored on the server and scoped to a room. These variables are seen by users in that room and are accessible by server extensions. Room variables can be created during the room creation process, by users in the room, or by server extensions. The value of a room variable is an EsObject.

See Also:

ElectroServer 4 Manual, Room Variables, RoomVariableEvents, ElectroServerApi.getRoomVariable

Method Summary

String	getName() Gets the name of the room variable.
EsObjectRO	getValue() Gets the value of the room variable, as an EsObject.
boolean	isLocked() Is the room variable locked? If true then the variable cannot be modified until it is unlocked.
boolean	isPersistent() Is this room variable persistent? If true then when the user that creates the room variable leaves the room the variable remains.

Method Detail

isPersistent

boolean isPersistent()

Is this room variable persistent? If true then when the user that creates the room variable leaves the room the variable remains. If false then when the user that created the room variable leaves the room the variable is removed.

Returns:

true if the room variable is persistent

getName

String getName()

Gets the name of the room variable.

Returns:

name

getValue

EsObjectRO getValue()

Gets the value of the room variable, as an EsObject.

Returns:

value of the room variable

isLocked

boolean isLocked()

Is the room variable locked? If true then the variable cannot be modified until it is unlocked. If false then the variable value can be modified.

Returns:

true if the room variable is locked