Difference between revisions of "Room"

Latest revision as of 23:27, 18 June 2021

Values
roomID=The room number.

pID=The ID of the entity.

pIDIsPlayer =Is the pID a player.

defenderID=The defenderID of the defender.

defenderIsPlayer=Is the defenderID a player.

Attacked=The attack value. Same value used in functions such as a return from an physical attack/etc.

Example=Room.ProcessStaminaLoss(22, 1, true, 2, true, 1)

Room.HidePenalty(pid As Integer, pidIsPlayer As Boolean, ignorePCount As Boolean, Optional roomID As Integer = -1) As Double

Description=Returns the hide penalty based on how many players are in the room. ignoring player count will generate a higher value.

Values
pid=ID calling this.

pidIsPlayer=Is the ID a player or NPC?

ignorePCount=Ignore player count variable. This variable is server side and will reduce the amount of penalty if added by a specific amount.

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 hide delay in seconds.
Example=Room.HidePenalty(21, false, false)

Room.Player.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, useHidden As Boolean, Optional ByVal exact As Boolean = True, 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.

exact =Use exact or find partial matches. Default is true.

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 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 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.Player.AreaCount(areaName As String, startID As Integer, endID As Integer, Optional hiddenstaffers As Boolean = False) As Integer

Description=Count the players in an area based on a start and end ID!

Values
areaName =The folder/area name.

startID=The start room number.

endID =The end room number.

hiddenstaffers =If staffers should be counted as well.

Returns=The player count.

Example=Room.Player.AreaCount("Seamoor City", 1, 10)

Room.Player.AreaList(areaName As String, startID As Integer, endID As Integer, Optional hiddenstaffers As Boolean = False) As Integer()

Description=Grab the IDs of the players in an area based on a start and end ID!

Values
areaName =The folder/area name.

startID=The start room number.

endID =The end room number.

hiddenstaffers =If staffers should be counted as well.

Returns=The player IDs in an array.

Example=Room.Player.AreaList("Seamoor City", 1, 10)

Room.NPC.Find(pid As Integer, pidIsPlayer As Boolean, data As String, useHidden As Boolean, Optional ByVal exact As Boolean = True, Optional 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.

exact =Use exact or find partial matches. Default is true.

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 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 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, data As String, Optional 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 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 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, itemName As String, Optional roomID As Integer = -1, Optional byPassScriptSetup As Boolean = False, Optional StringVar As String = "", Optional NumberVar As Integer = -1, Optional LookOver As String = "", Optional DropToName As String = "")

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.

StringVar=StringVar to attach to the item.

NumberVar=NumberVar to attach to the item.

Lookover=Lookover description to attach to the item.

DropToName=Lock the dropped item to the player for 30 seconds.

Example=Room.Item.Add(21, false, "ration")

Room.Item.Clear(roomID As Integer, data As String) As Boolean

Description=Try to remove an item in the room.

Values
roomID=The room ID.

itemName=Item to remove. You can include a number here too if needed for amount. However the number MUST match one of the room drops.

Returns=True if removed, false otherwise.
Example=Room.Item.Clear(21, "ration 3")

Room.Item.ClearAll(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer

Description=Remove 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=The amount of items removed.
Example=Room.Item.ClearAll(21)

Room.NPC.Spawn(NPCName As String, 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.NPC.ClearAll(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer

Description=Remove 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=The amount of NPCs removed.
Example=Room.NPC.ClearAll(21)

Room.Get.ScriptExists(roomID as Integer) as Boolean

Description=Gets if the LUA script exists for this room. The room DOES NOT HAVE TO BE LOADED before this function is used in case you wish to not load a room if a script exists/etc.

Values
roomID=The room id.

Returns=If the room has a script - true/false.
Example=Room.Get.ScriptExists(1)

Room.Get.InstanceComplete(instanceID as String) as Boolean

Description=Gets the instance completion flag.

Values
instanceName=The instance name.

Returns=The instance completion true/false.
Example=Room.Get.InstanceComplete("Test Instance#51213123")

Room.Get.Folder(rID As Integer) As String

Description=Get the room folder of the room ID.

Values
rID=The room ID.

Returns=Returns the folder name.
Example=Room.Get.Folder(152)

Room.Get.File(rID As Integer) As String

Description=Get the room file name of the room ID.

Values
rID=The room ID.

Returns=Returns the file name.
Example=Room.Get.File(152)

Room.Get.CaptureGold(rID As Integer) As Long

Description=Gets how much gold the current zone has made.

Values
rID=The room ID.

Returns=The gold made in the zone.
Example=Room.Get.CaptureGold(152)

Room.Get.Owner(rID As Integer) As String

Description=Gets the owner of the room.

Values
rID=The room ID.

Returns=Owner of the room
Example=Room.Get.Owner(152)

Room.Get.MinimapVersion(rID As Integer) As Integer

Description=Get the minimap version ID. This ID is used mostly for client side purposes to reset maps.

Values
rID=The room ID.

Returns=Returns the minimap version ID.
Example=Room.Get.MinimapVersion(152)

Room.Get.NoPenalty(rID As Integer) As Boolean

Description=Does the room bypass the under 25 kill penalty?

Values
rID=The room ID.

Returns=True or False of the NoPenalty value.
Example=Room.Get.NoPenalty(1)

Room.Get.BypassLevel(rID As Integer) As Boolean

Description=Does the room bypass pk level requirements?

Values
rID=The room ID.

Returns=True or False of the BypassLevel value.
Example=Room.Get.BypassLevel(1)

Room.Get.NoDrop(rID As Integer) As Integer

Description=Is the room an no drop?

Values
rID=The room ID.

Returns=The value of the NoDrop value.
Example=Room.Get.NoDrop(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(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.Var(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("Bark")

Room.Get.Var2(rID As Integer) As String

Description=Get the 'Var2=' variable in a room. Which is typically used for temples, class rooms, etc.

Values
rID=Room ID.

Returns=The string in 'Var2='.
Example=Room.Get.Var2("25")

Room.Get.NPCStop(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(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(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(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(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(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(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(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(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.Zone(rID As Integer) As String

Description=Returns the zone name.

Values
rID=Room ID.

Returns=The room zone name.
Example=Room.Get.Zone(2)

Room.Get.CaptureZone(rID As Integer) As String

Description=Returns the zone owner if any.

Values
rID=Room ID.

Returns=The room zone owner.
Example=Room.Get.CaptureZone(2)

Room.Get.CaptureZoneCount(rID As Integer) As Integer

Description=Returns the zone count.

Values
rID=Room ID.

Returns=The room zone owner.
Example=Room.Get.CaptureZoneCount(2)

Room.Get.CaptureZoneImmunity(rID As Integer, faction as String) As Double

Description=Returns the immunity of a faction in a zone.

Values
rID=Room ID.

faction=Faction name.

Returns=The room zone owner.
Example=Room.Get.CaptureZone(2, "Blackspawn")

Room.Get.Image(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(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(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(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(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(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(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(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(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.PickupLockTime(rID As Integer) As Boolean

Description=Get the pickup lock time of the room..

Values
rID=Room ID.

Returns=The room pickup lock time.
Example=Room.Get.PickupLockTime(2)

Room.Get.Movement(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(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(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(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(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(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(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(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(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(rID As Integer, 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(rID As Integer, 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(rID As Integer, 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(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(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(2)

Room.Set.InstanceCompleted(instanceID As String, instanceCompleted As Boolean)

Description=Set the instance to completed.

Values
instanceID=The instance ID.

instanceCompleted=The value of instance completion.

Example=Room.Set.InstanceCompleted("Test Instance#2941891", true)

Room.Set.CaptureGold(rID As Integer, goldAmount As Long)

Description=Sets how much gold the current zone has made.

Values
rID=The room ID.

goldAmount=The amount of gold made that the area will be set to. This will NOT give gold, only for statistics if you do add gold via script.

Example=Room.Set.CaptureGold(152, 20000)

Room.Set.Owner(rID As Integer, Owner As String, Permanent As Boolean)

Description=Sets the owner of the room. Can be permanent which reloads on reboots instead of clearing.

Values
rID=The room ID.

Owner=The owner name/guild name.

Permanent=Will this be saved on resets?.

Example=Room.Set.Owner(152, "Staff", true)

Room.Set.MinimapVersion(rID As Integer, version as Integer)

Description=Sets the minimap version ID. By changing this, it will reset a players minimap of that area.

Values
rID=The room ID.

rID=The new version ID.

Example=Room.Set.MinimapVersion(152, 3)

Room.Set.NoPenalty(rid As Integer, value As Boolean)

Description=Set the room no penalty rule.

Values
rID=Room ID.

value=Does this room NoPenalty? True or False.

Example=Room.Set.NoPenalty(2, true)

Room.Set.BypassLevel(rid As Integer, value As Boolean)

Description=Set the room bypass level rule.

Values
rID=Room ID.

value=Does this room BypassLevel? True or False.

Example=Room.Set.BypassLevel(2, true)

Room.Set.NoDrop(rid As Integer, value As integer)

Description=Set the room event area rule.

Values
rID=Room ID.

value=Does this room NoDrop? 1 for no drop. 2 for disintegrate on drop.

Example=Room.Set.NoDrop(2, 1)

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(rID As Integer, Optional 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.Var2(rID As Integer, Optional updateValue As String = "")

Description=Set the Var2 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.Var2(2, "Cleric")

Room.Set.NPCStop(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional updateValue As String = "")

Description=Set the room area name.

Values
rID=Room ID.

updateValue=The room area to replace it too. Ignore to reset value to default in room file.

Example=Room.Set.Area(2, "Happy Land")

Room.Set.CaptureZone(rID As Integer, guildName As String)

Description=Set the room zone owner.

Values
rID=Room ID.

guildName=Update the zone to be owned by this faction name.

Example=Room.Set.CaptureZoneImmunity(2, "Staff")

Room.Set.CaptureZoneImmunity(rid As Integer, alliName As String, immunityName As String, immunityAmount As Double, immunityAmount2 As Double, Optional forceImmunity As Boolean = False) As Boolean

Description=Set the room zone owner and immunties.

Values
rID=Room ID.

alliName=Alliance that captures the zone.

immunityName=Attacker alliance.

immunityAmount=Immunity time in seconds.

immunityAmount2=Immunity time for other factions.

forceImmunity=Force the immunity if the time is lower.

Example=Room.Set.CaptureZoneImmunity(2, "Blackspawn", "Church of Alderra", 500, 3600, 1200)

Room.Set.Zone(rID As Integer, Optional updateValue As String = "")

Description=Set the room zone name.

Values
rID=Room ID.

updateValue=The room zone to replace it too. Ignore to reset value to default in room file.

Example=Room.Set.Zone(2, "Zone2")

Room.Set.Image(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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(rID As Integer, Optional 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.Set.AlwaysSickness(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.PickupLockTime(rID As Integer, Optional Value As Double = 0)

Description=Set the pickup lock time amount..

Values
rID=Room ID.

Value=The pickup lock time amount

Example=Room.Set.PickupLockTime(2, 20)

Room.Set.NoXP(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(rID As Integer, Optional 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(rID As Integer, Direction As String, Optional 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(rID As Integer, Direction As String, Optional 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(rID As Integer, Direction As String, Optional 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(rID As Integer, Direction As String, Optional 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(rID As Integer, Direction As String, Optional 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(rID As Integer, Direction As String, Optional 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(rID As Integer, Direction As String, Optional 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(rID As Integer, Direction As String, Optional 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(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(rID As Integer, revert As Integer, Optional direction 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.

direction=Room ID to move to.

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(rID As Integer, updateValue As String)

Description=

Values
rID=Room ID.

updateValue=

Returns=
Example=Room.Set.DropSearchItem( )

Room.Set.Storage.String(rID As Integer, key As String, value As String, perma As Boolean)

Description=

Values
rID=Room ID.

key=

value=

perma=

Returns=
Example=Room.Set.Storage.String( )

Room.Set.Storage.Number(rID As Integer, key As String, value As Double, perma As Boolean)

Description=

Values
rID=Room ID.

key=

value=

perma=

Returns=
Example=Room.Set.Storage.Number( )

Room.Set.Storage.RNumber(rID As Integer, value As Integer, Optional 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(rID As Integer, Name As String)

Description=

Values
rID=Room ID.

Name=

Returns=
Example=Room.Remove.ItemLook( )

Room.Remove.SpecialMovement(rID As Integer, rToRemove as String)

Description=

Values
rID=Room ID.

rToRemove =The room connection to remove.

Returns=
Example=Room.Remove.SpecialMovement( )

Room.Remove.CaptureZone(rID As Integer)

Description=

Values
rID=Room ID.

Returns=
Example=Room.Remove.CaptureZone( )

Room.Remove.Storage.String(rID As Integer, key As String) As Boolean

Description=

Values
rID=Room ID.

key=

Returns=
Example=Room.Remove.Storage.String( )

Room.Remove.Storage.Number(rID As Integer, key As String) As Boolean

Description=

Values
rID=Room ID.

key=

Returns=
Example=Room.Remove.Storage.Number( )

Room.Remove.Storage.RNumber(rID As Integer, key As Integer) As Boolean

Description=

Values
rID=Room ID.

key=

Returns=
Example=Room.Remove.Storage.RNumber( )

Room.Clear.ItemLook(rID As Integer)

Description=

Values
rID=Room ID.

Returns=
Example=Room.Clear.ItemLook( )

Room.Clear.SpecialMovement(rID As Integer, revert As Integer)

Description=

Values
rID=Room ID.

revert=

Returns=
Example=Room.Clear.SpecialMovement( )

Room.Clear.Storage.RNumber(rID As Integer) As Boolean

Description=

Values
rID=Room ID.

Returns=
Example=Room.Clear.Storage.RNumber( )

@@ Line 1: / Line 1: @@
 ====Rooms====
+=====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.ID(roomFolder As String, roomID As integer) As Integer=====
+*Description=''Get the current ID of the room. This is needed as rooms are dynamically loaded and will NOT be the same when the server resets!''
+;'''Values'''
+:* roomFolder =''The room folder/area name.''
+:* roomID=''The room number.''
+:*Returns=''The ID of the room.''
+*Example=''Room.ID("Seamoor City", 1)''
+=====Room.GetRoomIDs(area As String) As List (Of String)=====
+*Description=''Grabs all the room files in an area folder.''
+;'''Values'''
+:* area=''The area folder.''
+:*Returns=''The IDs of the area in a list array.''
+*Example=''Room.GetRoomIDs("Seamoor City")''
+=====Room.GetRoomIDCount(area As String) As Integer=====
+*Description=''Grabs the count of the room files in an area folder.''
+;'''Values'''
+:* area=''The area folder.''
+:*Returns=''The amount of IDs in the area.''
+*Example=''Room.GetRoomIDCount("Seamoor City")''
+=====Room.ReloadAllID(roomFolder As String)=====
+*Description=''Reload an room folder to initialize more IDs (as IDs are pre-generated at startup. This is normally useful for dynamic rooms.''
+;'''Values'''
+:* roomFolder =''The room folder/area name.''
+*Example=''Room.ReloadAllID("Seamoor City")''
+=====Room.ReloadID(roomFolder as String, roomID As Integer)=====
+*Description=''General IDs for specific rooms. This is if you know what room IDs are added and should be called instead of Room.ReloadAllID which can use up more cycles checking for redundant/already ID loaded rooms.''
+;'''Values'''
+:* roomFolder =''The room folder/area name.''
+:* roomID=''The room number.''
+*Example=''Room.ReloadID("Seamoor City", 105)''
+=====Room.ProcessStaminaLoss(roomID As Integer, pID As Integer, pIDIsPlayer As Boolean, defenderID As Integer, defenderIsPlayer As Boolean, attacked As Integer)=====
+*Description=''Process the stamina loss function. This is currently only used for certain things like ensuring pets attack and stop if you go AFK. You need to specify the attacker (pID) and defender (defenderID).''
+;'''Values'''
+:* roomID=''The room number.''
+:* pID=''The ID of the entity.''
+:* pIDIsPlayer =''Is the pID a player.''
+:* defenderID=''The defenderID of the defender.''
+:* defenderIsPlayer=''Is the defenderID a player.''
+:* Attacked=''The attack value. Same value used in functions such as a return from an physical attack/etc.''
+*Example=''Room.ProcessStaminaLoss(22, 1, true, 2, true, 1)''
+=====Room.HidePenalty(pid As Integer, pidIsPlayer As Boolean, ignorePCount As Boolean, Optional roomID As Integer = -1) As Double=====
+*Description=''Returns the hide penalty based on how many players are in the room. ignoring player count will generate a higher value.''
+;'''Values'''
+:* pid=''ID calling this.''
+:* pidIsPlayer=''Is the ID a player or NPC?''
+:* ignorePCount=''Ignore player count variable. This variable is server side and will reduce the amount of penalty if added by a specific amount.''
+:* 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 hide delay in seconds.''
+*Example=''Room.HidePenalty(21, false, false)''
-=====Room.Player.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, useHidden As Boolean, Optional ByVal roomID As Integer = -1) As Integer=====
+=====Room.Player.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, useHidden As Boolean, Optional ByVal exact As Boolean = True, Optional ByVal roomID As Integer = -1) As Integer=====
 *Description=''Try to find a player in in the specific room.''
 ;'''Values'''
@@ Line 9: / Line 78: @@
 :* data=''Player to find.''
 :* useHidden=''Ignore hidden players or use them in the search.''
+:* exact =''Use exact or find partial matches. Default is true.''
 :* 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.''
@@ Line 14: / Line 84: @@
-=====Room.Player.List(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer()=====
+=====Room.Player.List(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer()=====
 *Description=''List all players in the room.''
 ;'''Values'''
@@ Line 24: / Line 94: @@
-=====Room.Player.Count(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer=====
+=====Room.Player.Count(pid As Integer, pidIsPlayer As Boolean, Optional 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'''
@@ Line 34: / Line 104: @@
-=====Room.NPC.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, useHidden As Boolean, Optional ByVal roomID As Integer = -1) As Integer=====
+=====Room.Player.AreaCount(areaName As String, startID As Integer, endID As Integer, Optional hiddenstaffers As Boolean = False) As Integer=====
+*Description=''Count the players in an area based on a start and end ID!''
+;'''Values'''
+:* areaName =''The folder/area name.''
+:* startID=''The start room number.''
+:* endID =''The end room number.''
+:* hiddenstaffers =''If staffers should be counted as well.''
+:*Returns=''The player count.''
+*Example=''Room.Player.AreaCount("Seamoor City", 1, 10)''
+=====Room.Player.AreaList(areaName As String, startID As Integer, endID As Integer, Optional hiddenstaffers As Boolean = False) As Integer()=====
+*Description=''Grab the IDs of the players in an area based on a start and end ID!''
+;'''Values'''
+:* areaName =''The folder/area name.''
+:* startID=''The start room number.''
+:* endID =''The end room number.''
+:* hiddenstaffers =''If staffers should be counted as well.''
+:*Returns=''The player IDs in an array.''
+*Example=''Room.Player.AreaList("Seamoor City", 1, 10)''
+=====Room.NPC.Find(pid As Integer, pidIsPlayer As Boolean, data As String, useHidden As Boolean, Optional ByVal exact As Boolean = True, Optional roomID As Integer = -1) As Integer=====
 *Description=''Try to find a npc in in the specific room.''
 ;'''Values'''
@@ Line 41: / Line 133: @@
 :* data=''NPC to find.''
 :* useHidden=''Ignore hidden NPCs or use them in the search.''
+:* exact =''Use exact or find partial matches. Default is true.''
 :* 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.''
@@ Line 46: / Line 139: @@
-=====Room.NPC.List(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer()=====
+=====Room.NPC.List(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer()=====
 *Description=''List all NPCs in the room.''
 ;'''Values'''
@@ Line 56: / Line 149: @@
-=====Room.NPC.Count(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer=====
+=====Room.NPC.Count(pid As Integer, pidIsPlayer As Boolean, Optional 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'''
@@ Line 66: / Line 159: @@
-=====Room.Item.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, Optional ByVal roomID As Integer = -1) As Boolean=====
+=====Room.Item.Find(pid As Integer, pidIsPlayer As Boolean, data As String, Optional roomID As Integer = -1) As Boolean=====
 *Description=''Try to find an item in the room.''
 ;'''Values'''
@@ Line 77: / Line 170: @@
-=====Room.Item.List(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer()=====
+=====Room.Item.List(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer()=====
 *Description=''List all items in the room.''
 ;'''Values'''
@@ Line 87: / Line 180: @@
-=====Room.Item.Count(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer=====
+=====Room.Item.Count(pid As Integer, pidIsPlayer As Boolean, Optional 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'''
@@ Line 97: / Line 190: @@
-=====Room.Item.Add(pid As Integer, pidIsPlayer As Boolean, itemName As String, Optional ByVal roomID As Integer = -1, Optional byPassScriptSetup As Boolean = False, Optional ByVal StringVar As String = "", Optional ByVal NumberVar As Integer = -1, Optional LookOver As String = "")=====
+=====Room.Item.Add(pid As Integer, pidIsPlayer As Boolean, itemName As String, Optional roomID As Integer = -1, Optional byPassScriptSetup As Boolean = False, Optional StringVar As String = "", Optional NumberVar As Integer = -1, Optional LookOver As String = "", Optional DropToName As String = "")=====
 *Description=''Try to find an item in the room.''
 ;'''Values'''
@@ Line 107: / Line 200: @@
 :* NumberVar=''NumberVar to attach to the item.''
 :* Lookover=''Lookover description to attach to the item.''
+:* DropToName=''Lock the dropped item to the player for 30 seconds.''
 *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=====
+=====Room.Item.Clear(roomID As Integer, data As String) As Boolean=====
+*Description=''Try to remove an item in the room.''
+;'''Values'''
+:* roomID=''The room ID.''
+:* itemName=''Item to remove. You can include a number here too if needed for amount. However the number MUST match one of the room drops.''
+*Returns=''True if removed, false otherwise.''
+*Example=''Room.Item.Clear(21, "ration 3")''
+=====Room.Item.ClearAll(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer=====
+*Description=''Remove 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=''The amount of items removed.''
+*Example=''Room.Item.ClearAll(21)''
+=====Room.NPC.Spawn(NPCName As String, 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'''
@@ Line 123: / Line 236: @@
-=====Room.Initialize(rid As Integer)=====
+=====Room.NPC.ClearAll(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) 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.''
+*Description=''Remove all items in the room.''
 ;'''Values'''
-:* rid=''The room ID to load''
+:* pid=''ID calling this.''
-*Example=''Room.Initialize(25)''
+:* 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=''The amount of NPCs removed.''
+*Example=''Room.NPC.ClearAll(21)''
+=====Room.Get.ScriptExists(roomID as Integer) as Boolean=====
+*Description=''Gets if the LUA script exists for this room. The room DOES NOT HAVE TO BE LOADED before this function is used in case you wish to not load a room if a script exists/etc.''
+;'''Values'''
+:* roomID=''The room id.''
+*Returns=''If the room has a script - true/false.''
+*Example=''Room.Get.ScriptExists(1)''
+=====Room.Get.InstanceComplete(instanceID as String) as Boolean=====
+*Description=''Gets the instance completion flag.''
+;'''Values'''
+:* instanceName=''The instance name.''
+*Returns=''The instance completion true/false.''
+*Example=''Room.Get.InstanceComplete("Test Instance#51213123")''
-=====Room.Get.BypassImmunity(rID As Integer) As Boolean=====
+=====Room.Get.Folder(rID As Integer) As String=====
-*Description=''Does the room bypass immunity?''
+*Description=''Get the room folder of the room ID.''
 ;'''Values'''
 :* rID=''The room ID.''
-*Returns=''True or False of the BypassImmunity value.''
+*Returns=''Returns the folder name.''
-*Example=''Room.Get.BypassImmunity(1)''
+*Example=''Room.Get.Folder(152)''
+=====Room.Get.File(rID As Integer) As String=====
+*Description=''Get the room file name of the room ID.''
+;'''Values'''
+:* rID=''The room ID.''
+*Returns=''Returns the file name.''
+*Example=''Room.Get.File(152)''
+=====Room.Get.CaptureGold(rID As Integer) As Long=====
+*Description=''Gets how much gold the current zone has made.''
+;'''Values'''
+:* rID=''The room ID.''
+*Returns=''The gold made in the zone.''
+*Example=''Room.Get.CaptureGold(152)''
+=====Room.Get.Owner(rID As Integer) As String=====
+*Description=''Gets the owner of the room.''
+;'''Values'''
+:* rID=''The room ID.''
+*Returns=''Owner of the room''
+*Example=''Room.Get.Owner(152)''
+=====Room.Get.MinimapVersion(rID As Integer) As Integer=====
+*Description=''Get the minimap version ID. This ID is used mostly for client side purposes to reset maps.''
+;'''Values'''
+:* rID=''The room ID.''
+*Returns=''Returns the minimap version ID.''
+*Example=''Room.Get.MinimapVersion(152)''
+=====Room.Get.NoPenalty(rID As Integer) As Boolean=====
+*Description=''Does the room bypass the under 25 kill penalty?''
+;'''Values'''
+:* rID=''The room ID.''
+*Returns=''True or False of the NoPenalty value.''
+*Example=''Room.Get.NoPenalty(1)''
+=====Room.Get.BypassLevel(rID As Integer) As Boolean=====
+*Description=''Does the room bypass pk level requirements?''
+;'''Values'''
+:* rID=''The room ID.''
+*Returns=''True or False of the BypassLevel value.''
+*Example=''Room.Get.BypassLevel(1)''
+=====Room.Get.NoDrop(rID As Integer) As Integer=====
+*Description=''Is the room an no drop?''
+;'''Values'''
+:* rID=''The room ID.''
+*Returns=''The value of the NoDrop value.''
+*Example=''Room.Get.NoDrop(1)''
 =====Room.Get.Tracks(pID As Integer, mode As Integer, Optional name As String = ") As String=====
@@ Line 148: / Line 335: @@
-=====Room.Get.Loaded(ByVal rID As Integer) As Boolean=====
+=====Room.Get.Loaded(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'''
@@ Line 156: / Line 343: @@
-=====Room.Get.Var(ByVal rID As Integer) As String=====
+=====Room.Get.Var(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)''
+*Example=''Room.Get.Var("Bark")''
+=====Room.Get.Var2(rID As Integer) As String=====
+*Description=''Get the 'Var2=' variable in a room. Which is typically used for temples, class rooms, etc.''
+;'''Values'''
+:* rID=''Room ID.''
+*Returns=''The string in 'Var2='.''
+*Example=''Room.Get.Var2("25")''
-=====Room.Get.NPCStop(ByVal rID As Integer) As Integer=====
+=====Room.Get.NPCStop(rID As Integer) As Integer=====
 *Description=''Is this room an NPCSTOP room?''
 ;'''Values'''
@@ Line 172: / Line 367: @@
-=====Room.Get.DayNight(ByVal rID As Integer) As Boolean=====
+=====Room.Get.DayNight(rID As Integer) As Boolean=====
 *Description=''Does this room have a day/night cycle?''
 ;'''Values'''
@@ Line 180: / Line 375: @@
-=====Room.Get.Darkness(ByVal rID As Integer) As Integer=====
+=====Room.Get.Darkness(rID As Integer) As Integer=====
 *Description=''Is this room in darkness or have the minimap removed?''
 ;'''Values'''
@@ Line 188: / Line 383: @@
-=====Room.Get.Kickout(ByVal rID As Integer) As Integer=====
+=====Room.Get.Kickout(rID As Integer) As Integer=====
 *Description=''Get the kickout room number if it exists.''
 ;'''Values'''
@@ Line 196: / Line 391: @@
-=====Room.Get.NoTrack(ByVal rID As Integer) As Boolean=====
+=====Room.Get.NoTrack(rID As Integer) As Boolean=====
 *Description=''Get the notrack value.''
 ;'''Values'''
@@ Line 204: / Line 399: @@
-=====Room.Get.CycleTimer(ByVal rID As Integer) As Integer=====
+=====Room.Get.CycleTimer(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'''
@@ Line 212: / Line 407: @@
-=====Room.Get.MinuteTimer(ByVal rID As Integer) As Boolean=====
+=====Room.Get.MinuteTimer(rID As Integer) As Boolean=====
 *Description=''Check if the minute timer is active.''
 ;'''Values'''
@@ Line 220: / Line 415: @@
-=====Room.Get.Name(ByVal rID As Integer) As String=====
+=====Room.Get.Name(rID As Integer) As String=====
 *Description=''Returns the room title.''
 ;'''Values'''
@@ Line 228: / Line 423: @@
-=====Room.Get.Area(ByVal rID As Integer) As String=====
+=====Room.Get.Area(rID As Integer) As String=====
 *Description=''Returns the area name.''
 ;'''Values'''
@@ Line 236: / Line 431: @@
-=====Room.Get.Zone(ByVal rID As Integer) As String=====
+=====Room.Get.Zone(rID As Integer) As String=====
 *Description=''Returns the zone name.''
 ;'''Values'''
@@ Line 244: / Line 439: @@
-=====Room.Get.CaptureZone(ByVal rID As Integer) As String=====
+=====Room.Get.CaptureZone(rID As Integer) As String=====
 *Description=''Returns the zone owner if any.''
 ;'''Values'''
@@ Line 252: / Line 447: @@
-=====Room.Get.Image(ByVal rID As Integer) As String=====
+=====Room.Get.CaptureZoneCount(rID As Integer) As Integer=====
+*Description=''Returns the zone count.''
+;'''Values'''
+:* rID=''Room ID.''
+*Returns=''The room zone owner.''
+*Example=''Room.Get.CaptureZoneCount(2)''
+=====Room.Get.CaptureZoneImmunity(rID As Integer, faction as String) As Double=====
+*Description=''Returns the immunity of a faction in a zone.''
+;'''Values'''
+:* rID=''Room ID.''
+:* faction=''Faction name.''
+*Returns=''The room zone owner.''
+*Example=''Room.Get.CaptureZone(2, "Blackspawn")''
+=====Room.Get.Image(rID As Integer) As String=====
 *Description=''Get the room image name.''
 ;'''Values'''
@@ Line 260: / Line 473: @@
-=====Room.Get.Status(ByVal rID As Integer) As Integer=====
+=====Room.Get.Status(rID As Integer) As Integer=====
 *Description=''Get the room status type.''
 ;'''Values'''
@@ Line 268: / Line 481: @@
-=====Room.Get.RoomClass(ByVal rID As Integer) As Integer=====
+=====Room.Get.RoomClass(rID As Integer) As Integer=====
 *Description=''Get the room class type.''
 ;'''Values'''
@@ Line 276: / Line 489: @@
-=====Room.Get.Description(ByVal rID As Integer) As String=====
+=====Room.Get.Description(rID As Integer) As String=====
 *Description=''Get the short room/enter room description.''
 ;'''Values'''
@@ Line 284: / Line 497: @@
-=====Room.Get.LongDescription(ByVal rID As Integer) As String=====
+=====Room.Get.LongDescription(rID As Integer) As String=====
 *Description=''Get the long room description.''
 ;'''Values'''
@@ Line 292: / Line 505: @@
-=====Room.Get.MovementDescription(ByVal rID As Integer) As String=====
+=====Room.Get.MovementDescription(rID As Integer) As String=====
 *Description=''Get the movement description.''
 ;'''Values'''
@@ Line 300: / Line 513: @@
-=====Room.Get.Type(ByVal rID As Integer) As String=====
+=====Room.Get.Type(rID As Integer) As String=====
 *Description=''Get the minimap type.''
 ;'''Values'''
@@ Line 308: / Line 521: @@
-=====Room.Get.AlwaysSickness(ByVal rID As Integer) As Boolean=====
+=====Room.Get.AlwaysSickness(rID As Integer) As Boolean=====
 *Description=''Get the alway sickness value of the room..''
 ;'''Values'''
@@ Line 316: / Line 529: @@
-=====Room.Get.NoXP(ByVal rID As Integer) As Boolean=====
+=====Room.Get.NoXP(rID As Integer) As Boolean=====
 *Description=''Get the no experience value of the room..''
 ;'''Values'''
@@ Line 324: / Line 537: @@
-=====Room.Get.Movement(ByVal rID As Integer, Direction As String) As Integer=====
+=====Room.Get.PickupLockTime(rID As Integer) As Boolean=====
+*Description=''Get the pickup lock time of the room..''
+;'''Values'''
+:* rID=''Room ID.''
+*Returns=''The room pickup lock time.''
+*Example=''Room.Get.PickupLockTime(2)''
+=====Room.Get.Movement(rID As Integer, Direction As String) As Integer=====
 *Description=''Get the room ID in a specific movement direction.''
 ;'''Values'''
@@ Line 333: / Line 554: @@
-=====Room.Get.KeyMode(ByVal rID As Integer, Direction As String) As Integer=====
+=====Room.Get.KeyMode(rID As Integer, Direction As String) As Integer=====
 *Description=''Get the room keymode in a specific movement direction.''
 ;'''Values'''
@@ Line 342: / Line 563: @@
-=====Room.Get.KeyName(ByVal rID As Integer, Direction As String) As String=====
+=====Room.Get.KeyName(rID As Integer, Direction As String) As String=====
 *Description=''Get the room keyname in a specific movement direction.''
 ;'''Values'''
@@ Line 351: / Line 572: @@
-=====Room.Get.KeyResponse(ByVal rID As Integer, Direction As String) As String=====
+=====Room.Get.KeyResponse(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'''
@@ Line 360: / Line 581: @@
-=====Room.Get.KeyFailResponse(ByVal rID As Integer, Direction As String) As String=====
+=====Room.Get.KeyFailResponse(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'''
@@ Line 369: / Line 590: @@
-=====Room.Get.KeyType(ByVal rID As Integer, Direction As String) As Integer=====
+=====Room.Get.KeyType(rID As Integer, Direction As String) As Integer=====
 *Description=''Get the key type in a specific movement direction.''
 ;'''Values'''
@@ Line 378: / Line 599: @@
-=====Room.Get.NPCBlock(ByVal rID As Integer, Direction As String) As Boolean=====
+=====Room.Get.NPCBlock(rID As Integer, Direction As String) As Boolean=====
 *Description=''Get the NPC block in a specific movement direction.''
 ;'''Values'''
@@ Line 387: / Line 608: @@
-=====Room.Get.KeyPlayerLimit(ByVal rID As Integer, Direction As String) As Integer=====
+=====Room.Get.KeyPlayerLimit(rID As Integer, Direction As String) As Integer=====
 *Description=''Get the player limit in a specific movement direction.''
 ;'''Values'''
@@ Line 396: / Line 617: @@
-=====Room.Get.DropSearchItem(ByVal rID As Integer) As String=====
+=====Room.Get.DropSearchItem(rID As Integer) As String=====
 *Description=''Grab the items that drop on the ground.''
 ;'''Values'''
@@ Line 404: / Line 625: @@
-=====Room.Get.Storage.String(ByVal rID As Integer, ByVal key As String) As String=====
+=====Room.Get.Storage.String(rID As Integer, key As String) As String=====
 *Description=''Get a saved data string in the room by key.''
 ;'''Values'''
@@ Line 413: / Line 634: @@
-=====Room.Get.Storage.Number(ByVal rID As Integer, ByVal key As String) As Double=====
+=====Room.Get.Storage.Number(rID As Integer, key As String) As Double=====
 *Description=''Get a saved data number in the room by key.''
 ;'''Values'''
@@ Line 422: / Line 643: @@
-=====Room.Get.Storage.RNumber(ByVal rID As Integer, ByVal value As Integer) As Integer=====
+=====Room.Get.Storage.RNumber(rID As Integer, 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'''
@@ Line 431: / Line 652: @@
-=====Room.Get.Storage.RNumberAll(ByVal rID As Integer) As Integer()=====
+=====Room.Get.Storage.RNumberAll(rID As Integer) As Integer()=====
 *Description=''Get all the number values in the array 'RNumber', as an array.''
 ;'''Values'''
@@ Line 439: / Line 660: @@
-=====Room.Get.Storage.RNumberCount(ByVal rID As Integer) As Integer=====
+=====Room.Get.Storage.RNumberCount(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(   )''
+*Example=''Room.Get.Storage.RNumberCount(2)''
-=====Room.Set.BypassImmunity(rid As Integer, value As Boolean)=====
+=====Room.Set.InstanceCompleted(instanceID As String, instanceCompleted As Boolean)=====
-*Description=''Set the room bypass immunity rule.''
+*Description=''Set the instance to completed.''
+;'''Values'''
+:* instanceID=''The instance ID.''
+:* instanceCompleted=''The value of instance completion.''
+*Example=''Room.Set.InstanceCompleted("Test Instance#2941891", true)''
+=====Room.Set.CaptureGold(rID As Integer, goldAmount As Long)=====
+*Description=''Sets how much gold the current zone has made.''
+;'''Values'''
+:* rID=''The room ID.''
+:* goldAmount=''The amount of gold made that the area will be set to. This will NOT give gold, only for statistics if you do add gold via script.''
+*Example=''Room.Set.CaptureGold(152, 20000)''
+=====Room.Set.Owner(rID As Integer, Owner As String, Permanent As Boolean)=====
+*Description=''Sets the owner of the room. Can be permanent which reloads on reboots instead of clearing.''
+;'''Values'''
+:* rID=''The room ID.''
+:* Owner=''The owner name/guild name.''
+:* Permanent=''Will this be saved on resets?.''
+*Example=''Room.Set.Owner(152, "Staff", true)''
+=====Room.Set.MinimapVersion(rID As Integer, version as Integer)=====
+*Description=''Sets the minimap version ID. By changing this, it will reset a players minimap of that area.''
+;'''Values'''
+:* rID=''The room ID.''
+:* rID=''The new version ID.''
+*Example=''Room.Set.MinimapVersion(152, 3)''
+=====Room.Set.NoPenalty(rid As Integer, value As Boolean)=====
+*Description=''Set the room no penalty rule.''
 ;'''Values'''
 :* rID=''Room ID.''
-:* value=''Does this room BypassImmunity? True or False.''
+:* value=''Does this room NoPenalty? True or False.''
-*Example=''Room.Set.BypassImmunity(2, true)''
+*Example=''Room.Set.NoPenalty(2, true)''
+=====Room.Set.BypassLevel(rid As Integer, value As Boolean)=====
+*Description=''Set the room bypass level rule.''
+;'''Values'''
+:* rID=''Room ID.''
+:* value=''Does this room BypassLevel? True or False.''
+*Example=''Room.Set.BypassLevel(2, true)''
+=====Room.Set.NoDrop(rid As Integer, value As integer)=====
+*Description=''Set the room event area rule.''
+;'''Values'''
+:* rID=''Room ID.''
+:* value=''Does this room NoDrop? 1 for no drop. 2 for disintegrate on drop.''
+*Example=''Room.Set.NoDrop(2, 1)''
 =====Room.Set.RefreshLevel(rid As Integer, ramount As Integer)=====
@@ Line 472: / Line 741: @@
-=====Room.Set.Var(ByVal rID As Integer, Optional ByVal updateValue As String = "")=====
+=====Room.Set.Var(rID As Integer, Optional updateValue As String = "")=====
 *Description=''Set the Var value in the room.''
 ;'''Values'''
@@ Line 480: / Line 749: @@
-=====Room.Set.NPCStop(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.Var2(rID As Integer, Optional updateValue As String = "")=====
+*Description=''Set the Var2 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.Var2(2, "Cleric")''
+=====Room.Set.NPCStop(rID As Integer, Optional updateValue As Integer = -1)=====
 *Description=''Set the NPCStop value in the room.''
 ;'''Values'''
@@ Line 488: / Line 765: @@
-=====Room.Set.DayNight(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.DayNight(rID As Integer, Optional updateValue As Integer = -1)=====
 *Description=''Set the daynight mode in the room.''
 ;'''Values'''
@@ Line 496: / Line 773: @@
-=====Room.Set.Darkness(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.Darkness(rID As Integer, Optional updateValue As Integer = -1)=====
 *Description=''Set the darkness mode in the room.''
 ;'''Values'''
@@ Line 504: / Line 781: @@
-=====Room.Set.Kickout(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.Kickout(rID As Integer, Optional updateValue As Integer = -1)=====
 *Description=''Set the kickout room.''
 ;'''Values'''
@@ Line 512: / Line 789: @@
-=====Room.Set.NoTrack(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.NoTrack(rID As Integer, Optional updateValue As Integer = -1)=====
 *Description=''Set the notrack value in a room.''
 ;'''Values'''
@@ Line 520: / Line 797: @@
-=====Room.Set.CycleTimer(ByVal rID As Integer, Optional ByVal updateValue As Integer = 0)=====
+=====Room.Set.CycleTimer(rID As Integer, Optional 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'''
@@ Line 528: / Line 805: @@
-=====Room.Set.MinuteTimer(ByVal rID As Integer, Optional ByVal updateValue As Boolean = False)=====
+=====Room.Set.MinuteTimer(rID As Integer, Optional updateValue As Boolean = False)=====
 *Description=''Set the minute timer on or off.''
 ;'''Values'''
@@ Line 536: / Line 813: @@
-=====Room.Set.Name(ByVal rID As Integer, Optional ByVal updateValue As String = "")=====
+=====Room.Set.Name(rID As Integer, Optional updateValue As String = "")=====
 *Description=''Set the room title name.''
 ;'''Values'''
@@ Line 544: / Line 821: @@
-=====Room.Set.Area(ByVal rID As Integer, Optional ByVal updateValue As String = "")=====
+=====Room.Set.Area(rID As Integer, Optional updateValue As String = "")=====
 *Description=''Set the room area name.''
 ;'''Values'''
@@ Line 552: / Line 829: @@
-=====Room.Set.CaptureZone(ByVal rID As Integer, guildName As String)=====
+=====Room.Set.CaptureZone(rID As Integer, guildName As String)=====
 *Description=''Set the room zone owner.''
 ;'''Values'''
 :* rID=''Room ID.''
-:* guildName=''Update the zone to be owned by this guild name.''
+:* guildName=''Update the zone to be owned by this faction name.''
-*Example=''Room.Set.Zone(2, "Staff")''
+*Example=''Room.Set.CaptureZoneImmunity(2, "Staff")''
-=====Room.Set.Zone(ByVal rID As Integer, Optional ByVal updateValue As String = "")=====
+=====Room.Set.CaptureZoneImmunity(rid As Integer, alliName As String, immunityName As String, immunityAmount As Double, immunityAmount2 As Double, Optional forceImmunity As Boolean = False) As Boolean=====
+*Description=''Set the room zone owner and immunties.''
+;'''Values'''
+:* rID=''Room ID.''
+:* alliName=''Alliance that captures the zone.''
+:* immunityName=''Attacker alliance.''
+:* immunityAmount=''Immunity time in seconds.''
+:* immunityAmount2=''Immunity time for other factions.''
+:* forceImmunity=''Force the immunity if the time is lower.''
+*Example=''Room.Set.CaptureZoneImmunity(2, "Blackspawn", "Church of Alderra", 500, 3600, 1200)''
+=====Room.Set.Zone(rID As Integer, Optional updateValue As String = "")=====
 *Description=''Set the room zone name.''
 ;'''Values'''
@@ Line 567: / Line 856: @@
 *Example=''Room.Set.Zone(2, "Zone2")''
-=====Room.Set.Image(ByVal rID As Integer, Optional ByVal updateValue As String = "")=====
+=====Room.Set.Image(rID As Integer, Optional updateValue As String = "")=====
 *Description=''Set the room image.''
 ;'''Values'''
@@ Line 575: / Line 865: @@
-=====Room.Set.Status(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.Status(rID As Integer, Optional updateValue As Integer = -1)=====
 *Description=''Set the room status type. This is typically what defines who can attack where.''
 ;'''Values'''
@@ Line 583: / Line 873: @@
-=====Room.Set.RoomClass(ByVal rID As Integer, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.RoomClass(rID As Integer, Optional updateValue As Integer = -1)=====
 *Description=''Set the room class type. For example bank, vaults, trash room, etc.''
 ;'''Values'''
@@ Line 591: / Line 881: @@
-=====Room.Set.Description(ByVal rID As Integer, Optional ByVal updateValue As String = ")=====
+=====Room.Set.Description(rID As Integer, Optional updateValue As String = ")=====
 *Description=''Set the room description. This is the default 'on move' description.''
 ;'''Values'''
@@ Line 599: / Line 889: @@
-=====Room.Set.LongDescription(ByVal rID As Integer, Optional ByVal updateValue As String = ")=====
+=====Room.Set.LongDescription(rID As Integer, Optional updateValue As String = ")=====
 *Description=''Set the room long description. This is the long 'look' description.''
 ;'''Values'''
@@ Line 607: / Line 897: @@
-=====Room.Set.MovementDescription(ByVal rID As Integer, Optional ByVal updateValue As String = ")=====
+=====Room.Set.MovementDescription(rID As Integer, Optional updateValue As String = ")=====
 *Description=''Set the room movement description. This is the movement description used in both the short and long description.''
 ;'''Values'''
@@ Line 615: / Line 905: @@
-=====Room.Get.AlwaysSickness(ByVal rID As Integer, Value As Boolean)=====
+=====Room.Set.AlwaysSickness(rID As Integer, Value As Boolean)=====
 *Description=''Get the alway sickness value of the room..''
 ;'''Values'''
@@ Line 623: / Line 913: @@
-=====Room.Set.NoXP(ByVal rID As Integer, Value As Boolean)=====
+=====Room.Set.PickupLockTime(rID As Integer, Optional Value As Double = 0)=====
+*Description=''Set the pickup lock time amount..''
+;'''Values'''
+:* rID=''Room ID.''
+:* Value=''The pickup lock time amount''
+*Example=''Room.Set.PickupLockTime(2, 20)''
+=====Room.Set.NoXP(rID As Integer, Value As Boolean)=====
 *Description=''Set the no experience value of the room..''
 ;'''Values'''
@@ Line 631: / Line 929: @@
-=====Room.Set.Type(ByVal rID As Integer, Optional ByVal updateValue As String = ")=====
+=====Room.Set.Type(rID As Integer, Optional updateValue As String = ")=====
 *Description=''Set the room minimap icon type. This is used for the minimap type.''
 ;'''Values'''
@@ Line 639: / Line 937: @@
-=====Room.Set.Movement(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.Movement(rID As Integer, Direction As String, Optional updateValue As Integer = -1)=====
 *Description=''Set the movement room in a specific direction.''
 ;'''Values'''
@@ Line 648: / Line 946: @@
-=====Room.Set.KeyType(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.KeyType(rID As Integer, Direction As String, Optional updateValue As Integer = -1)=====
 *Description=''Set the key type in a specific direction.''
 ;'''Values'''
@@ Line 657: / Line 955: @@
-=====Room.Set.KeyMode(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.KeyMode(rID As Integer, Direction As String, Optional updateValue As Integer = -1)=====
 *Description=''Set the key mode in a specific direction.''
 ;'''Values'''
@@ Line 666: / Line 964: @@
-=====Room.Set.KeyName(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As String = ")=====
+=====Room.Set.KeyName(rID As Integer, Direction As String, Optional 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'''
@@ Line 675: / Line 973: @@
-=====Room.Set.KeyResponse(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As String = ")=====
+=====Room.Set.KeyResponse(rID As Integer, Direction As String, Optional 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'''
@@ Line 684: / Line 982: @@
-=====Room.Set.KeyFailResponse(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As String = ")=====
+=====Room.Set.KeyFailResponse(rID As Integer, Direction As String, Optional 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'''
@@ Line 693: / Line 991: @@
-=====Room.Set.NPCBlock(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer = -1)=====
+=====Room.Set.NPCBlock(rID As Integer, Direction As String, Optional 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'''
@@ Line 702: / Line 1,000: @@
-=====Room.Set.KeyPlayerLimit(ByVal rID As Integer, Direction As String, Optional ByVal updateValue As Integer= -1 ")=====
+=====Room.Set.KeyPlayerLimit(rID As Integer, Direction As String, Optional 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'''
@@ Line 711: / Line 1,009: @@
-=====Room.Set.ItemLook(ByVal rID As Integer, revert As Integer, Optional Name As String = ", Optional Desc As String = ")=====
+=====Room.Set.ItemLook(rID As Integer, revert As Integer, Optional Name As String = ", Optional Desc As String = ")=====
 *Description=''   ''
 ;'''Values'''
@@ Line 721: / Line 1,019: @@
-=====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)=====
+=====Room.Set.SpecialMovement(rID As Integer, revert As Integer, Optional direction 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.''
+:* direction=''Room ID to move to.''
 :* keyMode=''The key mode to use.''
 :* keyName=''The key name to use.''
@@ Line 739: / Line 1,037: @@
 *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(rID As Integer, updateValue As String)=====
-=====Room.Set.DropSearchItem(ByVal rID As Integer, updateValue As String)=====
 *Description=''   ''
 ;'''Values'''
@@ Line 749: / Line 1,046: @@
-=====Room.Set.Storage.String(ByVal rID As Integer, ByVal key As String, ByVal value As String)=====
+=====Room.Set.Storage.String(rID As Integer, key As String, value As String, perma As Boolean)=====
 *Description=''   ''
 ;'''Values'''
@@ Line 755: / Line 1,052: @@
 :* key=''   ''
 :* value=''   ''
+:* perma=''   ''
 *Returns=''   ''
 *Example=''Room.Set.Storage.String(   )''
-=====Room.Set.Storage.Number(ByVal rID As Integer, ByVal key As String, ByVal value As Double)=====
+=====Room.Set.Storage.Number(rID As Integer, key As String, value As Double, perma As Boolean)=====
 *Description=''   ''
 ;'''Values'''
@@ Line 765: / Line 1,063: @@
 :* key=''   ''
 :* value=''   ''
+:* perma=''   ''
 *Returns=''   ''
 *Example=''Room.Set.Storage.Number(   )''
-=====Room.Set.Storage.RNumber(ByVal rID As Integer, ByVal value As Integer, Optional ByVal value2 As Integer = -1)=====
+=====Room.Set.Storage.RNumber(rID As Integer, value As Integer, Optional value2 As Integer = -1)=====
 *Description=''   ''
 ;'''Values'''
@@ Line 788: / Line 1,087: @@
-=====Room.Remove.ItemLook(ByVal rID As Integer, Name As String)=====
+=====Room.Remove.ItemLook(rID As Integer, Name As String)=====
 *Description=''   ''
 ;'''Values'''
@@ Line 797: / Line 1,096: @@
-=====Room.Remove.SpecialMovement(ByVal rID As Integer)=====
+=====Room.Remove.SpecialMovement(rID As Integer, rToRemove as String)=====
 *Description=''   ''
 ;'''Values'''
 :* rID=''Room ID.''
+:* rToRemove =''The room connection to remove.''
 *Returns=''   ''
 *Example=''Room.Remove.SpecialMovement(   )''
-=====Room.Remove.CaptureZone(ByVal rID As Integer)=====
+=====Room.Remove.CaptureZone(rID As Integer)=====
 *Description=''   ''
 ;'''Values'''
@@ Line 813: / Line 1,113: @@
-=====Room.Remove.Storage.String(ByVal rID As Integer, ByVal key As String) As Boolean=====
+=====Room.Remove.Storage.String(rID As Integer, key As String) As Boolean=====
 *Description=''   ''
 ;'''Values'''
@@ Line 822: / Line 1,122: @@
-=====Room.Remove.Storage.Number(ByVal rID As Integer, ByVal key As String) As Boolean=====
+=====Room.Remove.Storage.Number(rID As Integer, key As String) As Boolean=====
 *Description=''   ''
 ;'''Values'''
@@ Line 831: / Line 1,131: @@
-=====Room.Remove.Storage.RNumber(ByVal rID As Integer, ByVal key As Integer) As Boolean=====
+=====Room.Remove.Storage.RNumber(rID As Integer, key As Integer) As Boolean=====
 *Description=''   ''
 ;'''Values'''
@@ Line 840: / Line 1,140: @@
-=====Room.Clear.ItemLook(ByVal rID As Integer)=====
+=====Room.Clear.ItemLook(rID As Integer)=====
 *Description=''   ''
 ;'''Values'''
@@ Line 848: / Line 1,148: @@
-=====Room.Clear.SpecialMovement(ByVal rID As Integer, revert As Integer)=====
+=====Room.Clear.SpecialMovement(rID As Integer, revert As Integer)=====
 *Description=''   ''
 ;'''Values'''
@@ Line 857: / Line 1,157: @@
-=====Room.Clear.Storage.RNumber(ByVal rID As Integer) As Boolean=====
+=====Room.Clear.Storage.RNumber(rID As Integer) As Boolean=====
 *Description=''   ''
 ;'''Values'''

Difference between revisions of "Room"

Latest revision as of 23:27, 18 June 2021

Contents

Rooms

Room.Initialize(rid As Integer)

Room.ID(roomFolder As String, roomID As integer) As Integer

Room.GetRoomIDs(area As String) As List (Of String)

Room.GetRoomIDCount(area As String) As Integer

Room.ReloadAllID(roomFolder As String)

Room.ReloadID(roomFolder as String, roomID As Integer)

Room.ProcessStaminaLoss(roomID As Integer, pID As Integer, pIDIsPlayer As Boolean, defenderID As Integer, defenderIsPlayer As Boolean, attacked As Integer)

Room.HidePenalty(pid As Integer, pidIsPlayer As Boolean, ignorePCount As Boolean, Optional roomID As Integer = -1) As Double

Room.Player.Find(pid As Integer, pidIsPlayer As Boolean, ByVal data As String, useHidden As Boolean, Optional ByVal exact As Boolean = True, Optional ByVal roomID As Integer = -1) As Integer

Room.Player.List(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer()

Room.Player.Count(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer

Room.Player.AreaCount(areaName As String, startID As Integer, endID As Integer, Optional hiddenstaffers As Boolean = False) As Integer

Room.Player.AreaList(areaName As String, startID As Integer, endID As Integer, Optional hiddenstaffers As Boolean = False) As Integer()

Room.NPC.Find(pid As Integer, pidIsPlayer As Boolean, data As String, useHidden As Boolean, Optional ByVal exact As Boolean = True, Optional roomID As Integer = -1) As Integer

Room.NPC.List(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer()

Room.NPC.Count(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer

Room.Item.Find(pid As Integer, pidIsPlayer As Boolean, data As String, Optional roomID As Integer = -1) As Boolean

Room.Item.List(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer()

Room.Item.Count(pid As Integer, pidIsPlayer As Boolean, Optional roomID As Integer = -1) As Integer

Room.Item.Add(pid As Integer, pidIsPlayer As Boolean, itemName As String, Optional roomID As Integer = -1, Optional byPassScriptSetup As Boolean = False, Optional StringVar As String = "", Optional NumberVar As Integer = -1, Optional LookOver As String = "", Optional DropToName As String = "")

Room.Item.Clear(roomID As Integer, data As String) As Boolean

Room.Item.ClearAll(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer

Room.NPC.Spawn(NPCName As String, 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

Room.NPC.ClearAll(pid As Integer, pidIsPlayer As Boolean, Optional ByVal roomID As Integer = -1) As Integer

Room.Get.ScriptExists(roomID as Integer) as Boolean

Room.Get.InstanceComplete(instanceID as String) as Boolean

Room.Get.Folder(rID As Integer) As String

Room.Get.File(rID As Integer) As String

Room.Get.CaptureGold(rID As Integer) As Long

Room.Get.Owner(rID As Integer) As String

Room.Get.MinimapVersion(rID As Integer) As Integer

Room.Get.NoPenalty(rID As Integer) As Boolean

Room.Get.BypassLevel(rID As Integer) As Boolean

Room.Get.NoDrop(rID As Integer) As Integer

Room.Get.Tracks(pID As Integer, mode As Integer, Optional name As String = ") As String

Room.Get.Loaded(rID As Integer) As Boolean

Room.Get.Var(rID As Integer) As String

Room.Get.Var2(rID As Integer) As String

Room.Get.NPCStop(rID As Integer) As Integer

Room.Get.DayNight(rID As Integer) As Boolean

Room.Get.Darkness(rID As Integer) As Integer

Room.Get.Kickout(rID As Integer) As Integer

Room.Get.NoTrack(rID As Integer) As Boolean

Room.Get.CycleTimer(rID As Integer) As Integer

Room.Get.MinuteTimer(rID As Integer) As Boolean

Room.Get.Name(rID As Integer) As String

Room.Get.Area(rID As Integer) As String

Room.Get.Zone(rID As Integer) As String

Room.Get.CaptureZone(rID As Integer) As String

Room.Get.CaptureZoneCount(rID As Integer) As Integer

Room.Get.CaptureZoneImmunity(rID As Integer, faction as String) As Double

Room.Get.Image(rID As Integer) As String

Room.Get.Status(rID As Integer) As Integer

Room.Get.RoomClass(rID As Integer) As Integer

Room.Get.Description(rID As Integer) As String

Room.Get.LongDescription(rID As Integer) As String

Room.Get.MovementDescription(rID As Integer) As String

Room.Get.Type(rID As Integer) As String

Room.Get.AlwaysSickness(rID As Integer) As Boolean

Room.Get.NoXP(rID As Integer) As Boolean

Room.Get.PickupLockTime(rID As Integer) As Boolean

Room.Get.Movement(rID As Integer, Direction As String) As Integer

Room.Get.KeyMode(rID As Integer, Direction As String) As Integer

Room.Get.KeyName(rID As Integer, Direction As String) As String

Room.Get.KeyResponse(rID As Integer, Direction As String) As String

Room.Get.KeyFailResponse(rID As Integer, Direction As String) As String

Room.Get.KeyType(rID As Integer, Direction As String) As Integer

Room.Get.NPCBlock(rID As Integer, Direction As String) As Boolean

Room.Get.KeyPlayerLimit(rID As Integer, Direction As String) As Integer

Room.Get.DropSearchItem(rID As Integer) As String

Room.Get.Storage.String(rID As Integer, key As String) As String

Room.Get.Storage.Number(rID As Integer, key As String) As Double

Room.Get.Storage.RNumber(rID As Integer, value As Integer) As Integer

Room.Get.Storage.RNumberAll(rID As Integer) As Integer()

Room.Get.Storage.RNumberCount(rID As Integer) As Integer

Room.Set.InstanceCompleted(instanceID As String, instanceCompleted As Boolean)