Version 2 Scripts New - Revision history

JappaWakka: A little bit of polishing and correcting

2021-01-22T18:30:09Z

A little bit of polishing and correcting

← Older revision		Revision as of 20:30, 22 January 2021
Line 2:		Line 2:
	Version 2 scripts were started in version 0.32 and will cease support in alpha version (v1.xx). Any script in Version 2 must have "version=2" as the first line of the script.		Version 2 scripts were started in version 0.32 and will cease support in alpha version (v1.xx). Any script in Version 2 must have "version=2" as the first line of the script.

	Commands are procedures that ~~tells~~ the game what to do.<br />		Commands are procedures that are used to tell the game what to do.<br />
	Constructs are functions that returns a value in the game.		Constructs are functions that returns a value in the game.

	Commands are written as @~~command~~.~~subcommand~~.<br />		Commands are written as @Command.SubCommand.<br />
	Constructs are written as <~~construct~~.~~subconstruct~~>.		Constructs are written as <Construct.SubConstruct>.

			Commands and constructs are not case sensitive.

	== A General Note to all GameMode Scripters ( Must Read ) ==		== A General Note to all GameMode Scripters ( Must Read ) ==
Line 16:		Line 17:
	== Code Conventions ==		== Code Conventions ==
	=== Header ===		=== Header ===
	Header is used to define the ~~script~~ engine you want to use for the entire ~~action~~ script.		The Header is used to define the ActionScript engine you want to use for the entire script.
	For each ~~actionscript~~ file, the header must contain "version=2".		For each script file, the header must contain "version=2".

	=== Statement ===		=== Statement ===
	Statement is used to make comparisons between constructs and parameters or to make conditions for the script to run.		A Statement is used to make comparisons between constructs and parameters or to make conditions for the script to run.

	There are a few ~~statement~~ available in the game.		There are a few Statements available in the game.

	* :if:		* :if:
Line 37:		Line 38:
	* :return:		* :return:

	For more infomation about ~~statement~~ and ~~its~~ usage, proceed [[Version_2_Scripts_New#Statement_2\|here]].		For more infomation about Statements and their usage, proceed to [[Version_2_Scripts_New#Statement_2\|here]].

	=== Command Declaration ===		=== Command Declaration ===
	Command is used to instruct the game with a set of procedures to run. They do not return any value.		A Command is used to instruct the game with a set of procedures to run. They do not return any value.

	You can define ~~command by~~: @Class.Subclass		You can define a Command with: @Class.Subclass

	=== Construct Declaration ===		=== Construct Declaration ===
	Construct is used to instruct the game to return a value. They can be used with ~~commands~~ and ~~statement~~.		A Construct is used to instruct the game to return a value. They can be used with Commands and Statements.

	You can define construct by: <Class.Subclass>		You can define construct with: <Class.Subclass>

	=== Temporary Global Variable ===		=== Temporary Global Variable ===
	Global ~~Variable~~ are used when you want to use a variable on ~~the other~~ script without having to redefine again.		Global Variables are used when you want to use a variable on another script without having to redefine it again.

	Assignments:<br />		Assignments:<br />
	@Storage.set(str,Name,~~Message~~)		@Storage.set(str,Name,Text)
	@Storage.set(int,Name,~~Value~~)		@Storage.set(int,Name,Number)
	@Storage.set(sng,Name,~~Value~~)		@Storage.set(sng,Name,Number)
	@Storage.set(dbl,Name,~~Value~~)		@Storage.set(dbl,Name,Number)
	@Storage.set(bool,Name,Boolean)		@Storage.set(bool,Name,Boolean)

Line 88:		Line 89:

	By Default, the Argument Types are:		By Default, the Argument Types are:
	*Str ( ~~Str~~ are ~~define~~ as letters or symbols )		*Str ( Strings are defined as letters or symbols )
	*Int ( Int are ~~define~~ as [http://en.wikipedia.org/wiki/Integer Integer numbers] )		*Int ( Int ''(Integer)'' are defined as [http://en.wikipedia.org/wiki/Integer Integer numbers] )
	*Sng ( Sng are ~~define~~ as [http://en.wikipedia.org/wiki/Real_number Real numbers] )		*Sng ( Sng ''(Single)'' are defined as [http://en.wikipedia.org/wiki/Real_number Real numbers] )
	*ItemCollection ( ItemCollection are ~~define~~ as {itemID\|amount\|price} )		*ItemCollection ( ItemCollection are defined as {itemID\|amount\|price} )
	*Bool ( Bool are ~~define as words such~~ as True, False )		*Bool ( Bool ''(Boolean)'' are defined either as True & False or 1 & 0 )
	*IntArr ( IntArr are ~~define~~ as an array of [http://en.wikipedia.org/wiki/Integer Integer numbers] )		*IntArr ( IntArr are defined as an array of [http://en.wikipedia.org/wiki/Integer Integer numbers], usually with commas inbetween )
	*StrArr ( StrArr are ~~define~~ as an array of letters or symbols )		*StrArr ( StrArr are defined as an array of letters or symbols, usually with commas inbetween )
	*SngArr ( SngArr are ~~define~~ as an array of [http://en.wikipedia.org/wiki/Real_number Real numbers] )		*SngArr ( SngArr are defined as an array of [http://en.wikipedia.org/wiki/Real_number Real numbers] )
	*BoolArr ( BoolArr are ~~define~~ as an array of words such as True, False )		*BoolArr ( BoolArr are defined as an array of words such as True, False )
	*PokemonData ( PokemonData are ~~define~~ as [[Pokemon_Code\|Pokemon Code]] )		*PokemonData ( PokemonData are defined as [[Pokemon_Code\|Pokemon Code]] )
	*Arr ( Arr are ~~define~~ as an array of something. )		*Arr ( Arr are defined as an array of something. )


	For any '''Optional Argument''', it will be underlined and in red color for example "<span style="text-decoration: underline; color:red;">Str1,Str2,Str3,...</span>"<br />		For any '''Optional Argument''', it will be underlined and have a red color, for example "<span style="text-decoration: underline; color:red;">Str1,Str2,Str3,...</span>"<br />
	For any '''Array Argument''', it will be surrounded by a grouped square bracket for example "<nowiki>[Str1,Int2,Int3,Int4,Int5],Int6...</nowiki>"<br />		For any '''Array Argument''', it will be surrounded by a grouped square bracket, for example "<nowiki>[Str1,Int2,Int3,Int4,Int5],Int6...</nowiki>"<br />


	== Commands ==		== Commands ==
	Commands are scripts that tells the game what to do. It comes with @ and usually ~~used~~ with ~~statement.~~		Commands are scripts that tells the game what to do. A Command comes with a @ and usually with some arguments '''('''between Parantheses like these''')'''

	The table below is split into sections by Command.<br />		The table below is split into sections by Command.<br />
	You may use the sort feature to make it list ~~according to~~ alphanumeric order.		You may use the sort feature to make it list contents in alphanumeric order.

	<!--		<!--

Jianmingyong: /* @Pokemon */

2016-11-11T19:51:53Z

@Pokemon

← Older revision		Revision as of 21:51, 11 November 2016
Line 711:		Line 711:

	{{ScriptCommandV2\|Pokemon\|add\| Type = Command		{{ScriptCommandV2\|Pokemon\|add\| Type = Command
	\| Argument1 = {{ScriptArgumentV2\|pokemonData\|PokemonData\|1\|False\|\|}}		\| Argument1 = {{ScriptArgumentV2\|insertIndex\|Int\|1\|True\|Pokemon Count\|}},{{ScriptArgumentV2\|pokemonData\|PokemonData\|1\|False\|\|}}
	\| Description1 = Adds the Pokémon to the player's party.		\| Description1 = Adds the Pokémon to the player's party.
	\| Input1 = {{ScriptArgumentV2\|pokemonData\|PokemonData\|1\|True\|\|Input}}		\| Input1 = {{ScriptArgumentV2\|insertIndex\|Int\|1\|True\|Pokemon Count\|Input}}<br />{{ScriptArgumentV2\|pokemonData\|PokemonData\|1\|True\|\|Input}}
	\| Argument2 = {{ScriptArgumentV2\|pokemonID\|Int\|1\|False\|\|}},{{ScriptArgumentV2\|level\|Int\|2\|False\|\|}},{{ScriptArgumentV2\|method\|Str\|1\|True\|random reason\|}},{{ScriptArgumentV2\|ballID\|Int\|3\|True\|5\|}},{{ScriptArgumentV2\|location\|Str\|2\|True\|Current location\|}},{{ScriptArgumentV2\|isEgg\|Bool\|1\|True\|False\|}},{{ScriptArgumentV2\|trainerName\|Str\|3\|True\|Current TrainerName\|}}		\| Argument2 = {{ScriptArgumentV2\|pokemonID\|Int\|1\|False\|\|}},{{ScriptArgumentV2\|level\|Int\|2\|False\|\|}},{{ScriptArgumentV2\|method\|Str\|1\|True\|random reason\|}},{{ScriptArgumentV2\|ballID\|Int\|3\|True\|5\|}},{{ScriptArgumentV2\|location\|Str\|2\|True\|Current location\|}},{{ScriptArgumentV2\|isEgg\|Bool\|1\|True\|False\|}},{{ScriptArgumentV2\|trainerName\|Str\|3\|True\|Current TrainerName\|}}
	\| Description2 = Adds the Pokémon with the given arguments to the player's party.		\| Description2 = Adds the Pokémon with the given arguments to the player's party.
Line 780:		Line 780:
	{{ScriptCommandV2\|pokemon\|clone\|\|\|\|False}}		{{ScriptCommandV2\|pokemon\|clone\|\|\|\|False}}
	}}		}}


	=== @Radio ===		=== @Radio ===

Jianmingyong: /* @Camera */

2016-11-11T19:45:52Z

@Camera

← Older revision		Revision as of 21:45, 11 November 2016
Line 237:		Line 237:

	{{ScriptCommandV2\|Camera\|fix\| Type = Command		{{ScriptCommandV2\|Camera\|fix\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|}}
	\| Description1 = Fixes the camera to the current position.		\| Description1 = Fixes the camera to the current position.
			\| Input1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|Input}}
	}}		}}

	{{ScriptCommandV2\|Camera\|defix\| Type = Command		{{ScriptCommandV2\|Camera\|defix\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|}}
	\| Description1 = Defixes the camera so that it clips behind the player again.		\| Description1 = Defixes the camera so that it clips behind the player again.
			\| Input1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|Input}}
	}}		}}

	{{ScriptCommandV2\|Camera\|togglefix\| Type = Command		{{ScriptCommandV2\|Camera\|togglefix\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|}}
	\| Description1 = Sets the fix state of the camera to the opposite of the current state.		\| Description1 = Sets the fix state of the camera to the opposite of the current state.
			\| Input1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|Input}}
	}}		}}

			{{ScriptCommandV2\|Camera\|update\| Type = Command
			\| Description1 = Update the camera.
			}}

			{{ScriptCommandV2\|Camera\|setfocus\| Type = Command

			}}

			{{ScriptCommandV2\|Camera\|setfocustype\| Type = Command

			}}

			{{ScriptCommandV2\|Camera\|setfocusid\| Type = Command

			}}

			{{ScriptCommandV2\|Camera\|resetfocus\| Type = Command

			}}

			{{ScriptCommandV2\|Camera\|settoplayerfacing\| Type = Command

			}}
	}}		}}

Jianmingyong: /* @Camera */

2016-11-11T19:41:34Z

@Camera

← Older revision		Revision as of 21:41, 11 November 2016
Line 207:		Line 207:

	{{ScriptCommandV2\|Camera\|togglethirdperson\| Type = Command		{{ScriptCommandV2\|Camera\|togglethirdperson\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|}}
	\| Description1 = Toggles the third person camera.		\| Description1 = Toggles the third person camera.
			\| Input1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|Input}}
	}}		}}

	{{ScriptCommandV2\|Camera\|activatethirdperson\| Type = Command		{{ScriptCommandV2\|Camera\|activatethirdperson\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|}}
	\| Description1 = Activates the third person camera.		\| Description1 = Activates the third person camera.
			\| Input1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|Input}}
			}}

			{{ScriptCommandV2\|Camera\|deactivethirdperson\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|}}
			\| Description1 = Deactivates the third person camera.
			\| Input1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|Input}}
	}}		}}

	{{ScriptCommandV2\|Camera\|deactivatethirdperson\| Type = Command		{{ScriptCommandV2\|Camera\|deactivatethirdperson\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|}}
	\| Description1 = Deactivates the third person camera.		\| Description1 = Deactivates the third person camera.
			\| Input1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|Input}}
			}}

			{{ScriptCommandV2\|Camera\|setthirdperson\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|thirdPerson\|Bool\|1\|False\|\|}},{{ScriptArgumentV2\|doCameraUpdate\|Bool\|2\|True\|True\|}}
			\| Description1 = Set the camera to third person camera.
			\| Input1 = {{ScriptArgumentV2\|thirdPerson\|Bool\|1\|False\|\|Input}}<br />{{ScriptArgumentV2\|doCameraUpdate\|Bool\|2\|True\|True\|Input}}
	}}		}}

Line 231:		Line 249:

	}}		}}


	=== @Chat ===		=== @Chat ===

Jianmingyong at 19:31, 11 November 2016

2016-11-11T19:31:24Z

← Older revision		Revision as of 21:31, 11 November 2016
Line 165:		Line 165:

	{{ScriptCommandV2\|Camera\|reset\| Type = Command		{{ScriptCommandV2\|Camera\|reset\| Type = Command
			\| Argument1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|}}
	\| Description1 = Resets the camera to the default setting.		\| Description1 = Resets the camera to the default setting.
			\| Input1 = {{ScriptArgumentV2\|doCameraUpdate\|Bool\|1\|True\|True\|Input}}
	}}		}}

Jianmingyong at 19:24, 11 November 2016

2016-11-11T19:24:20Z

← Older revision		Revision as of 21:24, 11 November 2016
Line 129:		Line 129:

	{{ScriptCommandV2\|Battle\|trainer\| Type = Command		{{ScriptCommandV2\|Battle\|trainer\| Type = Command
	\| Argument1 = {{ScriptArgumentV2\|trainerFile\|Str\|1\|False\|\|}}		\| Argument1 = {{ScriptArgumentV2\|trainerFile\|Str\|1\|False\|\|}},{{ScriptArgumentV2\|additionalTrainerData\|Str\|2\|True\|\|}}
	\| Description1 = Start a battle with a trainer.		\| Description1 = Start a battle with a trainer.
	\| Input1 = {{ScriptArgumentV2\|trainerFile\|Str\|1\|False\|\|Input}}		\| Input1 = {{ScriptArgumentV2\|trainerFile\|Str\|1\|False\|\|Input}}<br />{{ScriptArgumentV2\|additionalTrainerData\|Str\|2\|True\|\|Input}}
	}}		}}

Jianmingyong at 19:16, 11 November 2016

2016-11-11T19:16:38Z

← Older revision		Revision as of 21:16, 11 November 2016
Line 1:		Line 1:
	~~{{InfoV2\|This is the last compatible script version for version 0.53 to 0.53.3~~
	~~Alpha version require [[Construct_Scripts\|version 3 (construct)]] for it to work.}}~~

	== Introduction ==		== Introduction ==
	Version 2 scripts were started in version 0.32 and will cease support in alpha version (v1.xx). Any script in Version 2 must have "version=2" as the first line of the script.		Version 2 scripts were started in version 0.32 and will cease support in alpha version (v1.xx). Any script in Version 2 must have "version=2" as the first line of the script.

Jianmingyong: /* Public Shared Variable (Global Variable) */

2016-09-16T20:33:04Z

Public Shared Variable (Global Variable)

← Older revision		Revision as of 22:33, 16 September 2016
Line 52:		Line 52:
	You can define construct by: <Class.Subclass>		You can define construct by: <Class.Subclass>

	=== ~~Public Shared Variable (~~Global Variable) ===		=== Temporary Global Variable ===
	Global Variable are used when you want to use a variable on the other script without having to redefine again.		Global Variable are used when you want to use a variable on the other script without having to redefine again.

Line 86:		Line 86:
	@Text.show(<Storage.get(str,Name)>)		@Text.show(<Storage.get(str,Name)>)
	@Text.show(<Storage.get(int,Name)>)		@Text.show(<Storage.get(int,Name)>)


	== Version 2 Class ==		== Version 2 Class ==

Jianmingyong: /* A General Note to all GameMode Scripters ( Must Read ) */

2016-09-16T20:31:15Z

A General Note to all GameMode Scripters ( Must Read )

← Older revision		Revision as of 22:31, 16 September 2016
Line 13:		Line 13:

	== A General Note to all GameMode Scripters ( Must Read ) ==		== A General Note to all GameMode Scripters ( Must Read ) ==
	# This page is currently updated as of v0.53.1 Script Library.		# This page is currently updated as of v0.53.3 Script Library.
	# This page contains information that is similar to what you can see when typing @help(command).		# This page contains information that is similar to what you can see when typing @help(command).
	# The line number shown in the crash logs starts counting at the first non-empty line of a valid command or statement. However, any line after :while: statement are continuously counted until the end loop. If there are two repeating cycle within the while loop, the number of lines doubles.		# The line number shown in the crash logs starts counting at the first non-empty line of a valid command or statement. However, any line after :while: statement are continuously counted until the end loop. If there are two repeating cycle within the while loop, the number of lines doubles.


	== Code Conventions ==		== Code Conventions ==

Jianmingyong at 20:27, 16 September 2016

2016-09-16T20:27:27Z

← Older revision		Revision as of 22:27, 16 September 2016
Line 1:		Line 1:
	{{InfoV2\|This is the last compatible script version for version 0.53 to 0.xx		{{InfoV2\|This is the last compatible script version for version 0.53 to 0.53.3
	Alpha version require [[Construct_Scripts\|version 3 (construct)]] for it to work.}}		Alpha version require [[Construct_Scripts\|version 3 (construct)]] for it to work.}}