Revision as of 14:19, 5 October 2018

Tools

Tools.FirstToUpper(value As String) As String

• Description=Uppercase the first character in a string.

Values

• value=The string to convert.

• Returns=The string with the first character uppercased.
• Example=Tools.FirstToUpper("banana!")

Tools.SetPMIndex(name As String)

• Description=Debugging function only. Will set the name of whom to output the errors too. Must be defined in each script.

Values

• name=The player name.

• Example=Tools.SetPMIndex("NiteHawk")

Tools.Debug(message As String)

• Description=Output a custom error to the player or the log file. This can output to the player defined above.

Values

• message=The message to output.

• Example=Tools.Debug("This is an error message to output!")

Tools.UnixTimestamp() As Double

• Description=Returns the unix timestamp (based on total seconds). This is based on GMT and should be used to prevent issues with daylight savings unless a server time is specifically needed. This should be used when handling time differences and time checks for scripts.

Values

• Returns=Current GMT unix timestamp.
• Example=Tools.UnixTimestamp()

Tools.ESTUnixTimestamp() As Double

• Description=Returns the unix timestamp (based on total seconds). This is based on the current server time. This should be used when handling time differences and time checks for scripts.

Values

• Returns=Current server unix timestamp.
• Example=Tools.ESTUnixTimestamp()

Tools.GetMaxZones(Optional tType As Integer = 0) As Integer

• Description=Returns the max zones owned, either city or area based.

Values

• tType=0 for zones, 1 for cities.

• Returns=Returns the zone/cities owned.
• Example=Tools.GetMaxZones(1)

Tools.Log(logNumber As Integer, logWrite As String, Optional logHeader As String = "")

• Description=Write data to a log. This will send data to be written to a specific log.

Values

• logNumber=The log ID to write too. 1 for the staff log, 2 for the PP log, and 3 for the error log. 4 for custom logs that are viewable by anyone.
• logWrite=The string to write to the log.
• logHeader=The header of the line. Must be used when staff log or custom log is defined.

• Example=Tools.Log(1, "Killed an NPC!", "NiteHawk")

Tools.GetStringFromFile(type As Integer, name As String, section As String, key As String, defaultValue As String) As String

• Description=Returns a string value in a file.

Values

• type=0 for npc file, 1 for room file, 2 for item file.
• name =Name of the file without extension to find.
• section=Section in the file.
• key=Key in the file.
• defaultValue=Default key to return if not existing.

• Returns=The value, blank for invalid and defaultValue if not found.
• Example=Tools.GetStringFromFile(0, "Goblin", "Vars", "Race")

Tools.GetNumberFromFile(type As Integer, name As String, section As String, key As String, defaultValue As Double) As String

• Description=Returns a number value in a file.

Values

• type=0 for npc file, 1 for room file, 2 for item file.
• name =Name of the file without extension to find.
• section=Section in the file.
• key=Key in the file.
• defaultValue=Default key to return if not existing.

• Returns=The value, 0 for invalid and defaultValue if not found.
• Example=Tools.GetNumberFromFile(0, "Goblin", "Values", "MoneyMinimum")

Tools.GetBoolFromFile(type As Integer, name As String, section As String, key As String, defaultValue As Boolean) As String

• Description=Returns a boolean value in a file.

Values

• type=0 for npc file, 1 for room file, 2 for item file.
• name =Name of the file without extension to find.
• section=Section in the file.
• key=Key in the file.
• defaultValue=Default key to return if not existing.

• Returns=The value, false for invalid and defaultValue if not found.
• Example=Tools.GetBoolFromFile(0, "Goblin", "Special", "Despawn")

Tools.GetStateVar(type As Integer, pid As Integer, name As String) As Object

• Description=Get a variable from another lua state (script). This can be used find a local variable to another script instance.

Values

• type=0 for npc file, 1 for room file, 3 for player file.
• id=ID of the NPC, room, or player.
• name =Name of the variable.

• Returns=The value of the variable found, otherwise blank.
• Example=Tools.GetStateVar(3, 22, "AlreadySpun")

Tools.SetStateVar(type As Integer, id As Integer, name As String, var As Object)

• Description=Set a variable to another lua state (script). This can be used to pass a local variable to another script instance. These are temporary unless you do something with them.

Values

• type=0 for npc file, 1 for room file, 3 for player file.
• id=ID of the NPC, room, or player.
• name =Name of the variable.
• var=The value of the variable.

• Returns=The value, blank for invalid and defaultValue if not found.
• Example=Tools.SetStateVar(3, 22, "AlreadySpun", "1")