Class Objects.Room
-Rooms
+Room object.
@@ -109,8 +109,12 @@
Functions
Room:GetActive() | -Determine whether the room is active or not | +Room:GetRoomNumber() | +Get the room's number. | +
Room:GetName() | +Get the room's unique string identifier. | ||
Room:GetColor() | @@ -121,28 +125,28 @@Get the room's reverb type. | ||
Room:SetReverbType(new) | +Room:SetName(name) | +Set the room's unique string identifier. | +|
Room:SetReverbType(Reverb) | Set the room's reverb type. | ||
Room:GetName() | -Get the room's unique string identifier. | -||
Room:SetName(name) | -Set the room's name (its unique string identifier). | +Room:SetFlag(flagID, Boolean) | +Set the room's specified flag. |
Room:GetFlag(flagID) | Get the room's specified flag value (true or false). | ||
Room:SetFlag(flagID, the) | -Set the room's specified flag value. | +Room:IsTagPresent(tag) | +Check if the specified tag is set for the room. |
Room:IsTagPresent(tag) | -Checks if specified tag is set for this room. | +Room:GetActive() | +Check if the room is active. |
- - - Room:GetActive() + + Room:GetRoomNumber()
-
- Determine whether the room is active or not
+ Get the room's number. ()
@@ -166,8 +170,29 @@
Returns:
-
- bool
- true if the room is active
+ int
+ Room number.
+
+ - + + Room:GetName() + +
-
+ Get the room's unique string identifier. ()
+
+
+
+
+
Returns:
+-
+
+ string
+ Room name.
- - Get the room's ambient light color. + Get the room's ambient light color. () @@ -188,7 +213,7 @@
-
Color
- ambient light color of the room
+ Ambient light color.
- - Get the room's reverb type. + Get the room's reverb type. () @@ -209,50 +234,7 @@
--
RoomReverb
- room's reverb type
-
- - Get the room's ambient light color. + Get the room's ambient light color. () @@ -188,7 +213,7 @@
- - - Room:SetReverbType(new) - -
-
- Set the room's reverb type.
-
-
-
-
Parameters:
--
-
- new - RoomReverb - reverb type of the room - -
- - - - Room:GetName() - -
-
- Get the room's unique string identifier.
-
-
-
-
-
Returns:
--
-
- string
- the room's name
+ Reverb type.
- - Set the room's name (its unique string identifier). + Set the room's unique string identifier. () @@ -272,7 +254,55 @@
+- name string - The room's new name + New name. + +
- - Set the room's name (its unique string identifier). + Set the room's unique string identifier. () @@ -272,7 +254,55 @@
- + + Room:SetReverbType(Reverb) + +
-
+ Set the room's reverb type. ()
+
+
+
+
Parameters:
+-
+
- Reverb + RoomReverb + type. + +
+ - + + Room:SetFlag(flagID, Boolean) + +
-
+ Set the room's specified flag. ()
+
+
+
+
Parameters:
+-
+
- flagID + RoomFlagID + Room flag ID. + +
- Boolean + bool + to set the flag to.
- - Get the room's specified flag value (true or false). + Get the room's specified flag value (true or false). () @@ -294,39 +324,7 @@
-- flagID RoomFlagID - The room's flag ID - -
Returns:
--
-
- bool
- the room's specified flag value
-
- - - Room:SetFlag(flagID, the) - -
-
- Set the room's specified flag value.
-
-
-
-
Parameters:
--
-
- flagID - RoomFlagID - The room's flag ID - -
- the - bool - room's new flag value + Room flag ID.
- - Checks if specified tag is set for this room. + Check if the specified tag is set for the room. () @@ -348,7 +346,7 @@
+- tag string - A text tag to check (case sensitive) + Text tag to check (case sensitive).
-
bool
- true if tag is present, false if not
+ Boolean of the tag's presence.
+
- + + Room:GetActive() + +
-
+ Check if the room is active. ()
+
+
+
+
+
Returns:
+-
+
+ bool
+ Boolean of the room's active status.