Jump to: navigation, search

Room

Contents

Rooms

Room.Player.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, useHidden As Boolean, Optional ByVal roomID As Integer = -1) As Integer
  • Description=Try to find a player in in the specific room.
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • data=Player to find.
  • useHidden=Ignore hidden players or use them in the search.
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=The ID of the player found in the room.
  • Example=Room.Player.Find(21, false, "NiteHawk", true)


Room.Player.List(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer()
  • Description=List all players in the room.
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=An array of players in the room.
  • Example=Room.Player.List(21, false)


Room.Player.Count(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer
  • Description=Get the total number of players. Normally used if you use the above, as the array won't return a specific array length (due to C# to Lua transtitions).
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=An integer value with the total amount of players in the room.
  • Example=Room.Player.Count(21, false)


Room.NPC.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, useHidden As Boolean, Optional ByVal roomID As Integer = -1) As Integer
  • Description=Try to find a npc in in the specific room.
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • data=NPC to find.
  • useHidden=Ignore hidden NPCs or use them in the search.
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=The ID of the NPC found in the room.
  • Example=Room.NPC.Find(1, true, "Rat", false, 500)


Room.NPC.List(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer()
  • Description=List all NPCs in the room.
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=An array of NPCs in the room.
  • Example=Room.NPC.List(21, false)


Room.NPC.Count(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer
  • Description=Get the total number of NPCs. Normally used if you use the above, as the array won't return a specific array length (due to C# to Lua transtitions).
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=An integer value with the total amount of NPCs in the room.
  • Example=Room.NPC.Count(21, false)


Room.Item.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, Optional ByVal roomID As Integer = -1) As Boolean
  • Description=Try to find an item in the room.
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • data=Item to find.
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=The ID of the item found in the room.
  • Example=Room.Item.Find(21, false, "ration")


Room.Item.List(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer()
  • Description=List all items in the room.
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=An array of items in the room.
  • Example=Room.Item.List(21, false)


Room.Item.Count(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer
  • Description=Get the total number of items. Normally used if you use the above, as the array won't return a specific array length (due to C# to Lua transtitions).
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=An integer value with the total amount of items in the room.
  • Example=Room.Item.Count(21, false)


Room.Item.Add(pid As Integer, pidIsPlayer As Boolean, ByVal itemName As String, Optional ByVal roomID As Integer = -1) As Boolean
  • Description=Try to find an item in the room.
Values
  • pid=ID calling this.
  • pidIsPlayer=Is the ID a player or NPC?
  • itemName=Item to spawn.
  • roomID=Do not specify this (use -1 or do not use at all) unless you want to search in a different room associated via the ID.
  • Returns=The ID of the item found in the room.
  • Example=Room.Item.Add(21, false, "ration")


Room.NPC.Spawn(ByVal NPCName As String, ByVal roomID As Integer, Optional bypassExpGoldItem As Boolean = False, Optional byPassSay As Boolean = False, Optional updateRoom As Boolean = True, Optional arenaMob As Boolean = False) As Integer
  • Description=Spawns an NPC to the current room.
Values
  • NPCName=NPC to spawn (the filename without the extension.)
  • roomID=The room to spawn it in.
  • bypassExpGoldItem=If set to true, this will allow XP/Gold/Items to drop or be earned.
  • byPassSay=Bypass spawn message.
  • updateRoom=Update the room with the NPC. Not needed if the NPC is joining a party as party joining will update the room.
  • arenaMob=If this mob is spawned in an arena area, it will reduce XP/Gold a little bit.
  • Returns=The ID of the new NPC, -1 if invalid.
  • Example=Room.NPC.Spawn("Troll", 250, true)


Room.Initialize(rid As Integer)
  • Description=Initialize a room. If a room is not initilized and you try to do functions/calls in it, the script will fail as the room is not loaded yet.
Values
  • rid=The room ID to load
  • Example=Room.Initialize(25)


Room.Get.BypassImmunity(rID As Integer) As Boolean
  • Description=Does the room bypass immunity?
Values
  • rID=The room ID.
  • Returns=True or False of the BypassImmunity value.
  • Example=Room.Get.BypassImmunity(1)


Room.Get.Tracks(pID As Integer, mode As Integer, Optional name As String = ") As String
  • Description=Get all the tracks for stalking/tracking players.
Values
  • pID=The player ID calling this.
  • mode=The mode type. Mode 0 only returns one specific player. Mode 1 returns a list with limited data. Mode 2 returns a list with full data. Any mode can search for an individual name as well long as the 'name' value is specified.
  • name "=The player to search track for.
  • Returns=A individual player or player listing with limited or full information.
  • Example=Room.Get.Tracks(1, 2)


Room.Get.Loaded(ByVal rID As Integer) As Boolean
  • Description=Check to see if the room is loaded. Normally not needed as Room.Initialize will load the room and exit if it already loaded. You may want this however for a specific script reason however to actually return true/false and not load the room still. (For example if we aren't initalized, we can assume no player has 'activated' the room yet, thus we can have a timer activate if the room is initalized.)
Values
  • rID=Room ID.
  • Returns=True if loaded, false otherwise or none existing.
  • Example=Room.Get.Loaded(25)


Room.Get.DevRoom(ByVal rID As Integer) As Boolean
  • Description=Is this room in development or not?
Values
  • rID=Room ID.
  • Returns=True if in dev mode, false otherwise.
  • Example=Room.Get.DevRoom(25)


Room.Get.Var(ByVal rID As Integer) As String
  • Description=Get the 'Var=' variable in a room. Which is typically used for temples, class rooms, etc.
Values
  • rID=Room ID.
  • Returns=The string in 'Var='.
  • Example=Room.Get.Var(25)


Room.Get.NPCStop(ByVal rID As Integer) As Integer
  • Description=Is this room an NPCSTOP room?
Values
  • rID=Room ID.
  • Returns=The NPCStop value.
  • Example=Room.Get.NPCStop(2)


Room.Get.DayNight(ByVal rID As Integer) As Boolean
  • Description=Does this room have a day/night cycle?
Values
  • rID=Room ID.
  • Returns=The day/night value.
  • Example=Room.Get.DayNight(2)


Room.Get.Darkness(ByVal rID As Integer) As Integer
  • Description=Is this room in darkness or have the minimap removed?
Values
  • rID=Room ID.
  • Returns=The darkness value.
  • Example=Room.Get.Darkness(2)


Room.Get.Kickout(ByVal rID As Integer) As Integer
  • Description=Get the kickout room number if it exists.
Values
  • rID=Room ID.
  • Returns=The kickout room number or -1 for no kickout.
  • Example=Room.Get.Kickout(2)


Room.Get.NoTrack(ByVal rID As Integer) As Boolean
  • Description=Get the notrack value.
Values
  • rID=Room ID.
  • Returns=The notrack value.
  • Example=Room.Get.NoTrack(2)


Room.Get.CycleTimer(ByVal rID As Integer) As Integer
  • Description=Gets the cycletimer value if it is active. Returns how many cycles are left before deactivating on its own.
Values
  • rID=Room ID.
  • Returns=The cycle timer value if it exists, -1 for inactive.
  • Example=Room.Get.CycleTimer(2)


Room.Get.MinuteTimer(ByVal rID As Integer) As Boolean
  • Description=Check if the minute timer is active.
Values
  • rID=Room ID.
  • Returns=True if active, false otherwise.
  • Example=Room.Get.MinuteTimer(2)


Room.Get.Name(ByVal rID As Integer) As String
  • Description=Returns the room title.
Values
  • rID=Room ID.
  • Returns=The room title.
  • Example=Room.Get.Name(2)


Room.Get.Area(ByVal rID As Integer) As String
  • Description=Returns the area name.
Values
  • rID=Room ID.
  • Returns=The room area name.
  • Example=Room.Get.Area(2)


Room.Get.Image(ByVal rID As Integer) As String
  • Description=Get the room image name.
Values
  • rID=Room ID.
  • Returns=The room image name.
  • Example=Room.Get.Image(2)


Room.Get.Status(ByVal rID As Integer) As Integer
  • Description=Get the room status type.
Values
  • rID=Room ID.
  • Returns=The room status type.
  • Example=Room.Get.Status(2)


Room.Get.RoomClass(ByVal rID As Integer) As Integer
  • Description=Get the room class type.
Values
  • rID=Room ID.
  • Returns=The room class type.
  • Example=Room.Get.RoomClass(2)


Room.Get.Description(ByVal rID As Integer) As String
  • Description=Get the short room/enter room description.
Values
  • rID=Room ID.
  • Returns=The short description.
  • Example=Room.Get.Description(2)


Room.Get.LongDescription(ByVal rID As Integer) As String
  • Description=Get the long room description.
Values
  • rID=2
  • Returns=The long description.
  • Example=Room.Get.LongDescription(2)


Room.Get.MovementDescription(ByVal rID As Integer) As String
  • Description=Get the movement description.
Values
  • rID=Room ID.
  • Returns=The movement description
  • Example=Room.Get.MovementDescription(2)


Room.Get.Type(ByVal rID As Integer) As String
  • Description=Get the minimap type.
Values
  • rID=Room ID.
  • Returns=The minimap type.
  • Example=Room.Get.Type(2)


Room.Get.AlwaysSickness(ByVal rID As Integer) As Boolean
  • Description=Get the alway sickness value of the room..
Values
  • rID=Room ID.
  • Returns=The room always sickness value.
  • Example=Room.Get.AlwaysSickness(2, "true")


Room.Get.NoXP(ByVal rID As Integer) As Boolean
  • Description=Get the no experience value of the room..
Values
  • rID=Room ID.
  • Returns=The room no experience value.
  • Example=Room.Get.NoXP(2)


Room.Get.Movement(ByVal rID As Integer, Direction As String) As Integer
  • Description=Get the room ID in a specific movement direction.
Values
  • rID=Room ID.
  • Direction=The direction to look for. This should be either 'north', 'south', 'east', 'west', 'up', or 'down'.
  • Returns=The room number in the specific direction. -1 if it does not exist.
  • Example=Room.Get.Movement(2, "north")


Room.Get.KeyMode(ByVal rID As Integer, Direction As String) As Integer
  • Description=Get the room keymode in a specific movement direction.
Values
  • rID=Room ID.
  • Direction=The direction to look for. This should be either 'north', 'south', 'east', 'west', 'up', or 'down'.
  • Returns=The key mode in the specific direction.
  • Example=Room.Get.KeyMode(2, "up")


Room.Get.KeyName(ByVal rID As Integer, Direction As String) As String
  • Description=Get the room keyname in a specific movement direction.
Values
  • rID=Room ID.
  • Direction=The direction to look for. This should be either 'north', 'south', 'east', 'west', 'up', or 'down'.
  • Returns=The key name in the specific direction.
  • Example=Room.Get.KeyName(2, "north")


Room.Get.KeyResponse(ByVal rID As Integer, Direction As String) As String
  • Description=Get the room key response, aka when you enter a room successfully in a specific movement direction. Does not require a key.
Values
  • rID=Room ID.
  • Direction=The direction to look for. This should be either 'north', 'south', 'east', 'west', 'up', or 'down'.
  • Returns=The response message apon entering a room in the specific direction.
  • Example=Room.Get.KeyResponse(2, "north")


Room.Get.KeyFailResponse(ByVal rID As Integer, Direction As String) As String
  • Description=Get the room key fail response when you cannot enter a room due to a key or mode in a specific movement direction.
Values
  • rID=Room ID.
  • Direction=The direction to look for. This should be either 'north', 'south', 'east', 'west', 'up', or 'down'.
  • Returns=The key fail response message apon entering a room in the specific direction.
  • Example=Room.Get.KeyFailResponse(2, "north")


Room.Get.KeyType(ByVal rID As Integer, Direction As String) As Integer
  • Description=Get the key type in a specific movement direction.
Values
  • rID=Room ID.
  • Direction=The direction to look for. This should be either 'north', 'south', 'east', 'west', 'up', or 'down'.
  • Returns=The key type in the specific direction.
  • Example=Room.Get.KeyType(2, "north")


Room.Get.NPCBlock(ByVal rID As Integer, Direction As String) As Boolean
  • Description=Get the NPC block in a specific movement direction.
Values
  • rID=Room ID.
  • Direction=The direction to look for. This should be either 'north', 'south', 'east', 'west', 'up', or 'down'.
  • Returns=The NPC block in the specific direction.
  • Example=Room.Get.NPCBlock(2, "south")


Room.Get.KeyPlayerLimit(ByVal rID As Integer, Direction As String) As Integer
  • Description=Get the player limit in a specific movement direction.
Values
  • rID=Room ID.
  • Direction=The direction to look for. This should be either 'north', 'south', 'east', 'west', 'up', or 'down'.
  • Returns=The player limit in the specific direction.
  • Example=Room.Get.KeyPlayerLimit(2, "north")


Room.Get.DropSearchItem(ByVal rID As Integer) As String
  • Description=Grab the items that drop on the ground.
Values
  • rID=Room ID.
  • Returns=All the items that drop, must be parsed.
  • Example=Room.Get.DropSearchItem(2)


Room.Get.Storage.String(ByVal rID As Integer, ByVal key As String) As String
  • Description=Get a saved data string in the room by key.
Values
  • rID=Room ID.
  • key=The key of the string value.
  • Returns=The string value of the key.
  • Example=Room.Get.Storage.String(2, "className")


Room.Get.Storage.Number(ByVal rID As Integer, ByVal key As String) As Double
  • Description=Get a saved data number in the room by key.
Values
  • rID=Room ID.
  • key=The key of the number value.
  • Returns=The number value of the key.
  • Example=Room.Get.Storage.Number(2, "npcsDied")


Room.Get.Storage.RNumber(ByVal rID As Integer, ByVal value As Integer) As Integer
  • Description=See if value exists in the array. 'RNumber' is only used for storing players in a room as it has functions to send messages using this.
Values
  • rID=Room ID.
  • value=Value to find
  • Returns=The position in the array it is found in, otherwise -1.
  • Example=Room.Get.Storage.RNumber(2, 5)


Room.Get.Storage.RNumberAll(ByVal rID As Integer) As Integer()
  • Description=Get all the number values in the array 'RNumber', as an array.
Values
  • rID=Room ID.
  • Returns=All values in the array.
  • Example=Room.Get.Storage.RNumberAll(2)


Room.Get.Storage.RNumberCount(ByVal rID As Integer) As Integer
  • Description=Get the total count of number values in the array 'RNumber'.
Values
  • rID=Room ID.
  • Returns=The total number of values in RNumber.
  • Example=Room.Get.Storage.RNumberCount( )


Room.Set.BypassImmunity(rid As Integer, value As Boolean)
  • Description=Set the room bypass immunity rule.
Values
  • rID=Room ID.
  • value=Does this room BypassImmunity? True or False.
  • Example=Room.Set.BypassImmunity(2, true)


Room.Set.RefreshLevel(rid As Integer, ramount As Integer)
  • Description=Set the refresh level. If the staff level is lower than this value, they cannot refresh the room.
Values
  • rID=Room ID.
  • ramount=The level to set the refresl level to.
  • Example=Room.Set.RefreshLevel(2, 3)


Room.Set.Track(rID As Integer, ID As Integer, Direction As String)
  • Description=Set a track in the room that can be followed using '/track'.
Values
  • rID=Room ID.
  • ID=The player index to be tracked.
  • Direction=The direction the player went. Can be north, south, etc.
  • Example=Room.Set.Track(2, 1, "north")


Room.Set.Var(ByVal rID As Integer, Optional ByVal updateValue As String = "")
  • Description=Set the Var value in the room.
Values
  • rID=Room ID.
  • updateValue=The value to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.Var(2, "Cleric")


Room.Set.NPCStop(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)
  • Description=Set the NPCStop value in the room.
Values
  • rID=Room ID.
  • updateValue=The value to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.NPCStop(2, 1)


Room.Set.DayNight(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)
  • Description=Set the daynight mode in the room.
Values
  • rID=Room ID.
  • updateValue=The value to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.DayNight(2, 0)


Room.Set.Darkness(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)
  • Description=Set the darkness mode in the room.
Values
  • rID=Room ID.
  • updateValue=The value to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.Darkness(2, 1)


Room.Set.Kickout(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)
  • Description=Set the kickout room.
Values
  • rID=Room ID.
  • updateValue=The value to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.Kickout(2, 500)


Room.Set.NoTrack(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)
  • Description=Set the notrack value in a room.
Values
  • rID=Room ID.
  • updateValue=The value to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.NoTrack(2, 500)


Room.Set.CycleTimer(ByVal rID As Integer, Optional ByVal updateValue As Integer = 0)
  • Description=Set the cycle timer. The cycle timer can be stopped manually by calling this function and setting updateValue to 0.
Values
  • rID=Room ID.
  • updateValue=The value to keep the timer running, which is in TICKS (5 seconds per tick!). Calls a script per tick. Ignore to reset value to default in room file.
  • Example=Room.Set.CycleTimer(2, 12)


Room.Set.MinuteTimer(ByVal rID As Integer, Optional ByVal updateValue As Boolean = False)
  • Description=Set the minute timer on or off.
Values
  • rID=Room ID.
  • updateValue=True will enable, false will disable. Calls a script like cycletimer does as well. Ignore to reset value to default in room file.
  • Example=Room.Set.MinuteTimer(2, true)


Room.Set.Name(ByVal rID As Integer, Optional ByVal updateValue As String = "")
  • Description=Set the room title name.
Values
  • rID=Room ID.
  • updateValue=The title to replace it too. Ignore to reset value to default in room file.
  • Example=Room.Set.Name(2, "Death Room")


Room.Set.Area(ByVal rID As Integer, Optional ByVal updateValue As String = "")
  • Description=Set the room area name.
Values
  • rID=Room ID.
  • updateValue=The room title to replace it too. Ignore to reset value to default in room file.
  • Example=Room.Set.Area(2, "Happy Land")


Room.Set.Image(ByVal rID As Integer, Optional ByVal updateValue As String = "")
  • Description=Set the room image.
Values
  • rID=Room ID.
  • updateValue=The room image to replace it too. Ignore to reset value to default in room file.
  • Example=Room.Set.Image(2, "00041")


Room.Set.Status(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)
  • Description=Set the room status type. This is typically what defines who can attack where.
Values
  • rID=Room ID.
  • updateValue=Status to change it too. Check the wiki for details on each status value. Ignore to reset value to default in room file.
  • Example=Room.Set.Status(2, 1)


Room.Set.RoomClass(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)
  • Description=Set the room class type. For example bank, vaults, trash room, etc.
Values
  • rID=Room ID.
  • updateValue=Class to change it too. Check the wiki for details on each class value. Ignore to reset value to default in room file.
  • Example=Room.Set.RoomClass(2, 4)


Room.Set.Description(ByVal rID As Integer, Optional ByVal updateValue As String = ")
  • Description=Set the room description. This is the default 'on move' description.
Values
  • rID=Room ID.
  • updateValue=The description to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.Description(2, "This is a short description.")


Room.Set.LongDescription(ByVal rID As Integer, Optional ByVal updateValue As String = ")
  • Description=Set the room long description. This is the long 'look' description.
Values
  • rID=Room ID.
  • updateValue=The long description to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.LongDescription(2, "This is a longer description.")


Room.Set.MovementDescription(ByVal rID As Integer, Optional ByVal updateValue As String = ")
  • Description=Set the room movement description. This is the movement description used in both the short and long description.
Values
  • rID=Room ID.
  • updateValue=The movement description to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.MovementDescription(2, "You can continue east or west.")


Room.Get.AlwaysSickness(ByVal rID As Integer, Value As Boolean)
  • Description=Get the alway sickness value of the room..
Values
  • rID=Room ID.
  • Value=The value of AlwaysSickness. Either true or false.
  • Example=Room.Set.AlwaysSickness(2, "true")


Room.Set.NoXP(ByVal rID As Integer, Value As Boolean)
  • Description=Set the no experience value of the room..
Values
  • rID=Room ID.
  • Value=The value of NoXP. Either true or false.
  • Example=Room.Set.NoXP(2, "true")


Room.Set.Type(ByVal rID As Integer, Optional ByVal updateValue As String = ")
  • Description=Set the room minimap icon type. This is used for the minimap type.
Values
  • rID=Room ID.
  • updateValue=The room minimap icon type to use. Ignore to reset value to default in room file.
  • Example=Room.Set.Type(1, "5")


Room.Set.Movement(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer = -1)
  • Description=Set the movement room in a specific direction.
Values
  • rID=Room ID.
  • Direction=The direction to modify. For example "north", "south", etc.
  • updateValue=The room to update it too. Ignore to reset value to default in room file.
  • Example=Room.Set.Movement(2, "north", 20)


Room.Set.KeyType(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer = -1)
  • Description=Set the key type in a specific direction.
Values
  • rID=Room ID.
  • Direction=The direction to modify. For example "north", "south", etc.
  • updateValue=The key type to use. Ignore to reset value to default in room file. You can find information on key types in the wiki.
  • Example=Room.Set.KeyType(2, "north", 5)


Room.Set.KeyMode(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer = -1)
  • Description=Set the key mode in a specific direction.
Values
  • rID=Room ID.
  • Direction=The direction to modify. For example "north", "south", etc.
  • updateValue=The key mode to use. Ignore to reset value to default in room file. You can find information on key modes in the wiki.
  • Example=Room.Set.KeyMode(2, "north", 3)


Room.Set.KeyName(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As String = ")
  • Description=Set the key name or value to use. For example if the key type is set to an item, this would be the item name. If it is set to gold, this could be the value of the gold.
Values
  • rID=Room ID.
  • Direction=The direction to modify. For example "north", "south", etc.
  • updateValue=The key name to use. Ignore to reset value to default in room file.
  • Example=Room.Set.KeyName(2, "north", "Room 121 Key")


Room.Set.KeyResponse(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As String = ")
  • Description=Set the key response message. This occurs regardless if there is a key lock or not and will act as a travel message.
Values
  • rID=Room ID.
  • Direction=The direction to modify. For example "north", "south", etc.
  • updateValue=The key response to use. Ignore to reset value to default in room file.
  • Example=Room.Set.KeyResponse(2, "north", "You open the door.")


Room.Set.KeyFailResponse(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As String = ")
  • Description=Set the key fail response message. This occurs when you fail to enter a room due to a key lock.
Values
  • rID=Room ID.
  • Direction=The direction to modify. For example "north", "south", etc.
  • updateValue=The key fail response message. Ignore to reset value to default in room file.
  • Example=Room.Set.KeyFailResponse(2, "north", "You don't seem to have the correct key for the lock...")


Room.Set.NPCBlock(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer = -1)
  • Description=Set the NPCBlock in a specific direction. This will halt NPCs from moving in the room, which could be player monsters, general npcs, or both.
Values
  • rID=Room ID.
  • Direction=The direction to modify. For example "north", "south", etc.
  • updateValue=The NPCBlock value to use. Ignore to reset value to default in room file.
  • Example=Room.Set.NPCBlock(2, "north", 1)


Room.Set.KeyPlayerLimit(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer= -1 ")
  • Description=Set the key fail response message. This occurs when you fail to enter a room due to a key lock.
Values
  • rID=Room ID.
  • Direction=The direction to modify. For example "north", "south", etc.
  • updateValue=The player limit. Ignore to reset value to default in room file.
  • Example=Room.Set.KeyPlayerLimit(2, "north", 4)


Room.Set.ItemLook(ByVal rID As Integer, revert As Integer, Optional Name As String = ", Optional Desc As String = ")
  • Description=
Values
  • rID=Room ID.
  • revert=Revert the item looks to default before adding the new look.
  • Name=The name of the look over command to add. Leave blank to not add an item look.
  • Desc=The description to use when 'name' is used as a command.
  • Example=Room.Set.ItemLook(2, 0, "sign", "This is a sign.")


Room.Set.SpecialMovement(ByVal rID As Integer, revert As Integer, Optional RoomID As Integer = 0, Optional keyMode As Integer = 0, Optional keyName As String = ", Optional keyType As Integer = 0, Optional keyResponse As String = "", Optional keyFailReponse As String = ", Optional npcMove As Boolean = False, Optional keySay As String = "", Optional keySayEnter As String = "", Optional keySayLeave As String = "", Optional keyPlayerLimit As Integer = 0)
  • Description=
Values
  • rID=Room ID.
  • revert=Revert the special movement to default before adding the new look.
  • RoomID=The room ID to move too when successful.
  • keyMode=The key mode to use.
  • keyName=The key name to use.
  • keyType=The key type to use.
  • keyResponse=The key response to use.
  • keyFailReponse=The key fail response to use.
  • npcMove=The NPCMove value to use.
  • keySay=The command to use for the movement. I.E. 'enter'.
  • keySayEnter=The message that people in the enter room will get. Adds the name automatically to the start.
  • keySayLeave=The message that people in the leave room will get. Adds the name automatically to the start.
  • keyPlayerLimit=The amount of players in a party allowed to move in this direction.
  • Example=Room.Set.SpecialMovement(2, 0, 200, 0, "", 0, "You walk in the room", "", 0, "enter", "entered the house!", "arrived from outside!", 2)


Room.Set.DropSearchItem(ByVal rID As Integer, updateValue As String)
  • Description=
Values
  • rID=Room ID.
  • updateValue=
  • Returns=
  • Example=Room.Set.DropSearchItem( )


Room.Set.Storage.String(ByVal rID As Integer, ByVal key As String, ByVal value As String)
  • Description=
Values
  • rID=Room ID.
  • key=
  • value=
  • Returns=
  • Example=Room.Set.Storage.String( )


Room.Set.Storage.Number(ByVal rID As Integer, ByVal key As String, ByVal value As Double)
  • Description=
Values
  • rID=Room ID.
  • key=
  • value=
  • Returns=
  • Example=Room.Set.Storage.Number( )


Room.Set.Storage.RNumber(ByVal rID As Integer, ByVal value As Integer, Optional ByVal value2 As Integer = -1)
  • Description=
Values
  • rID=Room ID.
  • value=
  • value2 -1=
  • Returns=
  • Example=Room.Set.Storage.RNumber( )


Room.Remove.Track(rID As Integer, ID As Integer) As Boolean
  • Description=
Values
  • rID=Room ID.
  • ID=
  • Returns=
  • Example=Room.Remove.Track( )


Room.Remove.ItemLook(ByVal rID As Integer, Name As String)
  • Description=
Values
  • rID=Room ID.
  • Name=
  • Returns=
  • Example=Room.Remove.ItemLook( )


Room.Remove.SpecialMovement(ByVal rID As Integer)
  • Description=
Values
  • rID=Room ID.
  • Returns=
  • Example=Room.Remove.SpecialMovement( )


Room.Remove.Storage.String(ByVal rID As Integer, ByVal key As String) As Boolean
  • Description=
Values
  • rID=Room ID.
  • key=
  • Returns=
  • Example=Room.Remove.Storage.String( )


Room.Remove.Storage.Number(ByVal rID As Integer, ByVal key As String) As Boolean
  • Description=
Values
  • rID=Room ID.
  • key=
  • Returns=
  • Example=Room.Remove.Storage.Number( )


Room.Remove.Storage.RNumber(ByVal rID As Integer, ByVal key As Integer) As Boolean
  • Description=
Values
  • rID=Room ID.
  • key=
  • Returns=
  • Example=Room.Remove.Storage.RNumber( )


Room.Clear.ItemLook(ByVal rID As Integer)
  • Description=
Values
  • rID=Room ID.
  • Returns=
  • Example=Room.Clear.ItemLook( )


Room.Clear.SpecialMovement(ByVal rID As Integer, revert As Integer)
  • Description=
Values
  • rID=Room ID.
  • revert=
  • Returns=
  • Example=Room.Clear.SpecialMovement( )


Room.Clear.Storage.RNumber(ByVal rID As Integer) As Boolean
  • Description=
Values
  • rID=Room ID.
  • Returns=
  • Example=Room.Clear.Storage.RNumber( )
Retrieved from "https://ember-online.com/wiki/index.php?title=Room&oldid=2074"