Room type description.

Properties

hasTick:Bool

If enabled, Room.tick() will be called.

id:String

Room type string ID.

optional isPersistent:Null<Bool>

If enabled, rooms of this type are considered persistent and the data in _RoomType.persistent array will be stored into the room block and loaded on room creation.

Note that if you're using persistent rooms of the same type on more than one slave server thread (or on different slave servers altogether), you have to make sure that no room instances with the same ID are created on different slave server threads. If it happens, the room block will already be locked and room creation will fail.

optional persistent:Null<Array<String>>

Room instance fields that are persistent. They will be stored in the room block and loaded on room creation.

replicated:Array<String>

Room instance fields that are public to the clients and will be automatically replicated on Room.updated() and Room.replicate() calls.

roomClass:Dynamic

Room class. Must be a child of snipe.packages.room.Room class.

tickTime:Float

Time in seconds between when room ticks are called. Minimum time is 0.1s and should be a multiple of 100ms because timer thread runs every 100ms.