Version 2 Scripts - Revision history

JappaWakka: Updated some script documentation

2026-06-18T09:19:02Z

Updated some script documentation

JappaWakka at 16:32, 6 April 2026

2026-04-06T16:32:03Z

← Older revision		Revision as of 18:32, 6 April 2026
Line 88:		Line 88:
	When an example is given for a possible value for an argument (e.g. "argument"), don't include the quotation marks in your actual command.		When an example is given for a possible value for an argument (e.g. "argument"), don't include the quotation marks in your actual command.

	Unless otherwise specified a bool can be either 1 (true/on) or 0 (false/off).		Unless otherwise specified a bool can be either 1 (true/on) or 0 (false/off).<br/>
	Unless otherwise specified X,Y,Z is a three dimensional position.		Unless otherwise specified X,Y,Z is a three dimensional position.<br/>
	Unless otherwise specified TradeItem means an array defined as follows:		Unless otherwise specified TradeItem means an array defined as follows:
	<pre>		<pre>
Line 1,333:		Line 1,333:
	The table is split into sections by Construct.		The table is split into sections by Construct.

	* Unless otherwise specified X,Y,Z is a three dimensional position.		Unless otherwise specified X,Y,Z is a three dimensional position.<br/>
			Unless otherwise specified bool is either true or false.
	** Unless otherwise specified bool is either true or false.

	{\|class="wikitable"		{\|class="wikitable"

JappaWakka: Explained @Player.Warp a little better

2024-11-03T17:43:55Z

Explained @Player.Warp a little better

← Older revision		Revision as of 19:43, 3 November 2024
Line 889:		Line 889:
	\| int - The rotation to turn to.		\| int - The rotation to turn to.
	\|-		\|-
	\| .~~warp~~(~~str~~,X,Y,Z,~~int~~)		\| .Warp('''MapPath,X,Y,Z,Rotations''')
	\| Warps the player.		\| Warps the player to the given map or position. You can leave out either the MapPath argument (to warp the player to a new position on the same map) or the X,Y,Z arguments (to just warp to a different map).
	\| str~~(optional~~) - ~~Map~~ destination file.<br />		\| MapPath (str) - The path to the destination map file (including the extension) relative to "Data\Maps\". (Default = The current map)<br />
	X,Y,Z - The new position.<br />
	int - ~~Turns from start~~.		X,Y,Z (sng) - The new position. To get the relative coordinates of the player, enter a "~" (Default = The player's current position).<br />

			Rotations (int) - The amount of 90 degree rotations to turn the player when warping to the new map (Default = 0).<br />

	\|-		\|-
	\| .wearskin (str)		\| .wearskin (str)

JappaWakka: Fixed a command description

2024-06-27T17:01:42Z

Fixed a command description

← Older revision		Revision as of 19:01, 27 June 2024
Line 470:		Line 470:
	\| Sets the "EnvironmentType" Tag of the current map.		\| Sets the "EnvironmentType" Tag of the current map.
	\|		\|
	EnvironmentID (int) - The ~~time of day~~ to change to.		EnvironmentID (int) - The EnvironmentType to change to.
	* 0 = Outside		* 0 = Outside
	* 1 = Inside		* 1 = Inside

JappaWakka: Added some more information

2024-06-26T10:30:32Z

Added some more information

Show changes

JappaWakka: Fix some more wrong info

2024-05-09T16:15:18Z

Fix some more wrong info

JappaWakka: fix error

2024-05-09T15:35:58Z

fix error

← Older revision		Revision as of 17:35, 9 May 2024
Line 635:		Line 635:
	\| Creates a register in the [[Saves#NPC.dat\|NPC register file]] of the save in order to move or remove an NPC on the given map.<br />		\| Creates a register in the [[Saves#NPC.dat\|NPC register file]] of the save in order to move or remove an NPC on the given map.<br />
	Example 1: <nowiki>@NPC.Register(Map.dat\|0\|remove)</nowiki><br />		Example 1: <nowiki>@NPC.Register(Map.dat\|0\|remove)</nowiki><br />
	Example 2: <nowiki>@NPC.Register(Map.dat\|0\|~~move~~\|2,0,2)</nowiki>		Example 2: <nowiki>@NPC.Register(Map.dat\|0\|position\|2,0,2)</nowiki>
	\|		\|
	MapPath (str) - The path to the map (including the extension) relative to "Data\Maps\".<br />		MapPath (str) - The path to the map (including the extension) relative to "Data\Maps\".<br />

JappaWakka: Removed value construct as well

2024-04-02T09:59:26Z

Removed value construct as well

← Older revision		Revision as of 11:59, 2 April 2024
Line 2,010:		Line 2,010:
	\| Returns the current year.		\| Returns the current year.
	\|-		\|-
	~~\| colspan="3" \|~~

	~~=== Value ===~~
	\|-
	~~\| .get(str)~~
	~~\| str - The name of the stored value.~~
	~~\| Returns the value stored as str.~~
	\|}		\|}
	{{FilePaths}}		{{FilePaths}}

JappaWakka: removed @Value as it doesn't exist anymore

2024-04-02T09:58:24Z

removed @Value as it doesn't exist anymore

@@ Line 1,119: / Line 1,119: @@
 | Clears all titles that are currently being displayed.
 | None
 |}

JappaWakka: Mainly update @NPC

2024-04-01T13:25:37Z

Mainly update @NPC

Show changes

← Older revision		Revision as of 18:15, 9 May 2024
Line 641:		Line 641:
	ID (int) - The ID of the NPC to move or remove.<br />		ID (int) - The ID of the NPC to move or remove.<br />

	RemoveOrPosition (str) - Can be "~~move~~" or "remove".<br />		RemoveOrPosition (str) - Can be "position" or "remove".<br />

	X,Y,Z (sng) - If RemoveOrPosition is "~~move~~", this will be the new position for that NPC.<br />		X,Y,Z (sng) - If RemoveOrPosition is "position", this will be the new position for that NPC.<br />
	\|-		\|-
	\| <nowiki>.Unregister(MapPath\|ID\|RemoveOrPosition\|</nowiki>'''X''','''Y''','''Z''')		\| <nowiki>.Unregister(MapPath\|ID\|RemoveOrPosition\|</nowiki>'''X''','''Y''','''Z''')
	\| Removes a register in the [[Saves#NPC.dat\|NPC register file]] of the save that matches the given data.<br />		\| Removes a register in the [[Saves#NPC.dat\|NPC register file]] of the save that matches the given data.<br />
	Example 1: <nowiki>@NPC.Unregister(Map.dat\|0\|remove)</nowiki><br />		Example 1: <nowiki>@NPC.Unregister(Map.dat\|0\|remove)</nowiki><br />
	Example 2: <nowiki>@NPC.Unregister(Map.dat\|0\|~~move~~\|2,0,2)</nowiki>		Example 2: <nowiki>@NPC.Unregister(Map.dat\|0\|position\|2,0,2)</nowiki>
	\|		\|
	MapPath (str) - The path to the map (including the extension) relative to "Data\Maps\".<br />		MapPath (str) - The path to the map (including the extension) relative to "Data\Maps\".<br />
Line 654:		Line 654:
	ID (int) - The ID of the NPC.<br />		ID (int) - The ID of the NPC.<br />

	RemoveOrPosition (str) - Can be "~~move~~" or "remove".<br />		RemoveOrPosition (str) - Can be "position" or "remove".<br />

	X,Y,Z (sng) - The position of the NPC if RemoveOrPosition is "~~move~~".<br />		X,Y,Z (sng) - The position of the NPC if RemoveOrPosition is "position".<br />
	\|-		\|-
	\| .Remove(ID)		\| .Remove(ID)