Tools - Revision history

NiteHawk at 19:46, 25 February 2021

2021-02-25T19:46:08Z

2021-02-09T09:08:41Z

2021-02-09T08:28:11Z

‎Tools

2020-05-25T22:08:25Z

2020-04-18T14:14:20Z

2020-04-10T12:26:45Z

2019-04-23T09:05:27Z

2019-04-23T08:56:22Z

2019-04-23T08:05:59Z

2018-10-05T14:19:46Z

@@ Line 44: / Line 44: @@
 *Returns=''The number of the day.''
 *Example=''Tools.NumberOfTheDay()''
@@ Line 150: / Line 158: @@
 *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.''
+:* type=''0 for npc file, 1 for room file, 2 for player file, 3 for global npc, 4 for global.''
 :* id=''ID of the NPC, room, or player.''
 :* name =''Name of the variable.''
@@ Line 160: / Line 168: @@
 *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.''
+:* type=''0 for npc file, 1 for room file, 2 for player file, 3 for global npc, 4 for global.''
 :* id=''ID of the NPC, room, or player.''
 :* name =''Name of the variable.''

@@ Line 95: / Line 95: @@
-=====Tools.GetMaxZones(Optional tType As Integer = 0) As Integer=====
+=====Tools.GetMaxZones() As Integer=====
-*Description=''Returns the max zones owned, either city or area based.''
+*Description=''Returns the max zones owned.''
 ;'''Values'''
-:* tType=''0 for zones, 1 for cities.''
+*Returns=''Returns the zones owned.''
-*Returns=''Returns the zone/cities owned.''
+*Example=''Tools.GetMaxZones()''
-*Example=''Tools.GetMaxZones(1)''

← Older revision		Revision as of 08:28, 9 February 2021
Line 21:		Line 21:
	*Returns=''The VIP mode.''		*Returns=''The VIP mode.''
	*Example=''Tools.BSVIPMode()''		*Example=''Tools.BSVIPMode()''
		+
		+
		+	=====Tools.SwearCheck(textValue as String) As Boolean=====
		+	*Description=''Check the value of the text to see if it matches any swear words.''
		+	;'''Values'''
		+	:* textValue=''The string to check''
		+	*Returns=''If the string contains swear words.''
		+	*Example=''Tools.SwearCheck("Hello folks!")''

← Older revision		Revision as of 22:08, 25 May 2020
Line 21:		Line 21:
	*Returns=''The VIP mode.''		*Returns=''The VIP mode.''
	*Example=''Tools.BSVIPMode()''		*Example=''Tools.BSVIPMode()''
		+
		+
		+	=====Tools.PoolOfGold(mode As Integer, Optional amount As Long = 0) As Long=====
		+	*Description=''Gets the pool of gold amount of the server.''
		+	;'''Values'''
		+	:* mode=''1 to change the pool of gold to the amount specified. 0 will return only the value of pool of gold.''
		+	:* amount=''The amount to change the pool of gold to.''
		+	*Returns=''The pool of gold amount.''
		+	*Example=''Tools.PoolOfGold(1, 10000)''

@@ Line 150: / Line 150: @@
 *Returns=''The value, blank for invalid and defaultValue if not found.''
 *Example=''Tools.SetStateVar(3, 22, "AlreadySpun", "1")''
 =====Tools.SyncAllData() As Boolean=====
 *Description=''Update everyones queued data to be current. Shouldn't be used in most cases.''
 *Example=''Tools.SyncAllData()''

← Older revision		Revision as of 12:26, 10 April 2020
Line 150:		Line 150:
	*Returns=''The value, blank for invalid and defaultValue if not found.''		*Returns=''The value, blank for invalid and defaultValue if not found.''
	*Example=''Tools.SetStateVar(3, 22, "AlreadySpun", "1")''		*Example=''Tools.SetStateVar(3, 22, "AlreadySpun", "1")''
		+
		+	=====Tools.SyncAllData() As Boolean=====
		+	*Description=''Update everyones queued data to be current. Shouldn't be used in most cases.''
		+	*Example=''Tools.SyncAllData()''

@@ Line 15: / Line 15: @@
 *Returns=''True if the telegram is successful.''
 *Example=''Tools.Telegram()''
 =====Tools.NumberOfTheDay() As Long=====

← Older revision		Revision as of 08:56, 23 April 2019
Line 1:		Line 1:
	====Tools====		====Tools====

		+
		+	=====Tools.Telegram(name As String, message As String, item As String, amount As Integer, sendOnlineMessage As String, Optional stringvar As String = "", Optional numvar As Double = -1, Optional LookOver As String = "") As Boolean=====
		+	*Description=''Send a telegram. Can also send an item.''
		+	;'''Values'''
		+	:* name=''Player to send the telegram too.''
		+	:* message=''The message to send in the telegram.''
		+	:* item=''The item to send, blank if no item is needed.''
		+	:* amount=''The amount of the item to send. 0 if not needed.''
		+	:* sendOnlineMessage=''The message to send the online player if they are online during the telegram send.''
		+	:* stringvar=''Stringvar to add on the item if needed.''
		+	:* numvar=''Numbervar to add on the item if needed.''
		+	:* LookOver=''Lookover message to add on the item if needed.''
		+	*Returns=''True if the telegram is successful.''
		+	*Example=''Tools.Telegram()''

	=====Tools.NumberOfTheDay() As Long=====		=====Tools.NumberOfTheDay() As Long=====

← Older revision		Revision as of 08:05, 23 April 2019
Line 1:		Line 1:
	====Tools====		====Tools====
		+
		+
		+	=====Tools.NumberOfTheDay() As Long=====
		+	*Description=''Gets the number of the day. Changes at reset.''
		+	*Returns=''The number of the day.''
		+	*Example=''Tools.NumberOfTheDay()''
		+
		+
		+	=====Tools.UpdateEventMOTD(value As String)=====
		+	*Description=''Update the event MOTD. Does not remove on reset.''
		+	;'''Values'''
		+	:* value=''The MOTD to add.''
		+	*Example=''Tools.UpdateEventMOTD("So many events happening around 8pm!")''
		+
		+
		+	=====Tools.GetEventMOTD() As String=====
		+	*Description=''Get the event MOTD.''
		+	*Returns=''The event MOTD.''
		+	*Example=''Tools.GetEventMOTD()''

@@ Line 10: / Line 10: @@
-=====Tools.SetPMIndex(ByVal name As String)=====
+=====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'''
@@ Line 17: / Line 17: @@
-=====Tools.Debug(ByVal message As String)=====
+=====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'''
@@ Line 25: / Line 25: @@
 =====Tools.UnixTimestamp() As Double=====
-*Description=''Returns the unix timestamp (based on total seconds). This should be used when handling time differences and time checks for scripts.''
+*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 server unix timestamp.''
+*Returns=''Current GMT unix timestamp.''
 *Example=''Tools.UnixTimestamp()''
@@ Line 74: / Line 89: @@
 *Returns=''The value, false for invalid and defaultValue if not found.''
 *Example=''Tools.GetBoolFromFile(0, "Goblin", "Special", "Despawn")''