Room

Name
Room
Examples
Room: guestRoom
{
name: "Guest Room"
image: "img_guestRoom"
desc: "There is a bed for a guest to sleep on."
tooltip: "To the Guest Room"
// Tooltip of a room is shown when the mouse is over a navigation button pointing to that room

west = livingRoom
// guestRoom is connected to livingRoom to the west
// livingRoom is connected to questRoom to the east

chars: someChar
items: someItem
// These two objects are within this room at the start of the game

Event: "Examine" {
display(this)
}
}

Character: someChar
Item: someItem

Room: livingRoom
{
name: "Living Room"
image: "img_livingRoom"
desc: "There is a tv, a couch and some other furniture here."

Event: "Examine" {
display(this)
}
}
Description
Room is used to declare a room object for the game.

Initial properties can be assigned to a room object doing declaration.

If name is unassigned doing declaration, the instance of the room will be used as name.

This object can contain characters and items.
Syntax
- Room: instance
- Room: instance {statements}
Methods
- allObjects()
  Returns a list of all objects present in the room.
- disableEvent()
  Disables the event for the room, if declared
- enableEvent()
  Enables the event for the room, if declared
- enterRoom()
  Moves the player to the room. (Triggers leave- and enter room events)
- hasItem()
  Returns a boolean value of whether the room has an item
- getChars()
  Returns a list of all characters in the room
- getDesc()
  Returns the description of the room
- getImage()
  Returns the image of the room
- getItems()
  Returns a list of all items in the room
- getName()
  Returns the name of the room
- getPath()
  Returns the Room object in the given direction
- getPaths()
  Returns a list of all paths from the room
- getTooltip()
  Returns the tooltip of the room
- giveItem()
  Moves an item to the room
- isEnabled()
  Returns a boolean value of whether the event is enabled on the room
- setChars()
  Replaces the current character list on the room with a new list of characters
- setDesc()
  Sets the description of the room
- setImage()
  Sets the image of the room
- setItems()
  Replaces the current item list on the room with a new list of items
- setName()
  Sets the name of the room
- setPath()
  Sets the Room object the player can travel to in the given direction
- setTooltip()
  Sets the tooltip of the room
- showEvents()
  Shows a list of custom events for the room
- trigger()
  Triggers an event on the room remotely
Properties
- chars
  Holds a list of characters in the room
- desc
  Holds the description of the room
- down
  Declares a navigation path to a room going down
- east
  Declares a navigation path to a room going east
- image
  Holds the image of the room
- in
  Declare a navigation path to a room going inside
- items
  Holds a list of items in the room.
- name
  Holds the name of the room
- north
  Declares a navigation path to a room going north
- northeast
  Declares a navigation path to a room going north east
- northwest
  Declares a navigation path to a room going north west
- out
  Declares a navigation path to a room going outside
- south
  Declares a navigation path to a room going South
- southeast
  Declares a navigation path to a room going south east
- southwest
  Declares a navigation path to a room going south west
- tooltip
  Holds the tooltip for the room
- up
  Declares a navigation path to a room going up
- west
  Declares a navigation path to a room going west
Related

Name

Examples

Description

Syntax

Methods

Properties

Related