RoomGroup
Groups Rooms together to allow common functionality.
Although Room behavior can be specified individually, sometimes it is faster and more convenient to write functionality for a group of rooms.
s should be placed as children of the room list (the parent of your Rooms), and s should be placed in turn as children of a RoomGroup
in order to assign them to the RoomGroup.
A RoomGroup
can for example be used to specify Rooms that are outside, and switch on or off a directional light, sky, or rain effect as the player enters / exits the area.
Default | |
Setter | set_roomgroup_priority(value) |
Getter | get_roomgroup_priority() |
When the is within more than one room (regular and internal), the higher priority room will take precedence. So with for example, a house inside a terrain ‘room’, you would make the house higher priority, so that when the camera is within the house, the house is used as the source room, but outside the house, the terrain room would be used instead.