Class: Lich::DragonRealms::DRRoom

Inherits:
Object
  • Object
show all
Defined in:
documented/dragonrealms/drinfomon/drroom.rb

Overview

Represents a room in the DragonRealms game.

This class manages the state of the room, including NPCs, PCs, and various room attributes.

See Also:

Class Method Summary collapse

Class Method Details

.dead_npcs ⇒ Array

Returns the list of dead non-player characters (NPCs) in the room.

Returns:

  • (Array) —

    an array of dead NPCs.



105
106
107
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 105

def self.dead_npcs
  @@dead_npcs
end

.dead_npcs=(val) ⇒ void

This method returns an undefined value.

Sets the list of dead non-player characters (NPCs) in the room.

Parameters:

  • val (Array) —

    an array of dead NPCs to set for the room.



112
113
114
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 112

def self.dead_npcs=(val)
  @@dead_npcs = val
end

.description ⇒ String

Returns the description of the room.

Returns:

  • (String) —

    the description of the room.



60
61
62
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 60

def self.description
  XMLData.room_description
end

.exits ⇒ Array

Returns the exits available from the room.

Returns:

  • (Array) —

    an array of exits defined in the room.



48
49
50
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 48

def self.exits
  XMLData.room_exits
end

.group_members ⇒ Array

Returns the list of group members in the room.

Returns:

  • (Array) —

    an array of group members.



66
67
68
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 66

def self.group_members
  @@group_members
end

.group_members=(val) ⇒ void

This method returns an undefined value.

Sets the list of group members in the room.

Parameters:

  • val (Array) —

    an array of group members to set for the room.



73
74
75
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 73

def self.group_members=(val)
  @@group_members = val
end

.npcs ⇒ Array

Returns the list of non-player characters (NPCs) in the room.

Returns:

  • (Array) —

    an array of NPCs currently in the room.



22
23
24
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 22

def self.npcs
  @@npcs
end

.npcs=(val) ⇒ void

This method returns an undefined value.

Sets the list of non-player characters (NPCs) in the room.

Parameters:

  • val (Array) —

    an array of NPCs to set for the room.



29
30
31
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 29

def self.npcs=(val)
  @@npcs = val
end

.pcs ⇒ Array

Returns the list of player characters (PCs) in the room.

Returns:

  • (Array) —

    an array of PCs currently in the room.



35
36
37
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 35

def self.pcs
  @@pcs
end

.pcs=(val) ⇒ void

This method returns an undefined value.

Sets the list of player characters (PCs) in the room.

Parameters:

  • val (Array) —

    an array of PCs to set for the room.



42
43
44
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 42

def self.pcs=(val)
  @@pcs = val
end

.pcs_prone ⇒ Array

Returns the list of player characters (PCs) that are prone in the room.

Returns:

  • (Array) —

    an array of PCs that are currently prone.



79
80
81
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 79

def self.pcs_prone
  @@pcs_prone
end

.pcs_prone=(val) ⇒ void

This method returns an undefined value.

Sets the list of player characters (PCs) that are prone in the room.

Parameters:

  • val (Array) —

    an array of PCs to set as prone.



86
87
88
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 86

def self.pcs_prone=(val)
  @@pcs_prone = val
end

.pcs_sitting ⇒ Array

Returns the list of player characters (PCs) that are sitting in the room.

Returns:

  • (Array) —

    an array of PCs that are currently sitting.



92
93
94
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 92

def self.pcs_sitting
  @@pcs_sitting
end

.pcs_sitting=(val) ⇒ void

This method returns an undefined value.

Sets the list of player characters (PCs) that are sitting in the room.

Parameters:

  • val (Array) —

    an array of PCs to set as sitting.



99
100
101
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 99

def self.pcs_sitting=(val)
  @@pcs_sitting = val
end

.room_objs ⇒ Array

Returns the list of objects in the room.

Returns:

  • (Array) —

    an array of objects present in the room.



118
119
120
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 118

def self.room_objs
  @@room_objs
end

.room_objs=(val) ⇒ void

This method returns an undefined value.

Sets the list of objects in the room.

Parameters:

  • val (Array) —

    an array of objects to set for the room.



125
126
127
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 125

def self.room_objs=(val)
  @@room_objs = val
end

.title ⇒ String

Returns the title of the room.

Returns:

  • (String) —

    the title of the room.



54
55
56
 
# File 'documented/dragonrealms/drinfomon/drroom.rb', line 54

def self.title
  XMLData.room_title
end