Version 1 Scripts - Revision history

Jianmingyong at 18:42, 11 July 2014

2014-07-11T18:42:36Z

← Older revision		Revision as of 20:42, 11 July 2014
Line 1:		Line 1:
	{{InfoV2\|~~This script~~ are outdated. There is a newer version of this documentation. It is incomplete but some missing commands have been reinserted into the new page.<br /><br />If you want to take a look, visit: [[Version 2 Scripts New]].}}		{{InfoV2\|These scripts are outdated. There is a newer version of this documentation. It is incomplete but some missing commands have been reinserted into the new page.<br /><br />If you want to take a look, visit: [[Version 2 Scripts New]].}}

	These scripts follow the @Command:subcommand pattern with not all Commands needing sub commands.		These scripts follow the @Command:subcommand pattern with not all Commands needing sub commands.

Jianmingyong at 18:41, 11 July 2014

2014-07-11T18:41:54Z

← Older revision		Revision as of 20:41, 11 July 2014
Line 1:		Line 1:
			{{InfoV2\|This script are outdated. There is a newer version of this documentation. It is incomplete but some missing commands have been reinserted into the new page.<br /><br />If you want to take a look, visit: [[Version 2 Scripts New]].}}

	These scripts follow the @Command:subcommand pattern with not all Commands needing sub commands.		These scripts follow the @Command:subcommand pattern with not all Commands needing sub commands.

Blazer257 at 10:44, 11 November 2013

2013-11-11T10:44:08Z

← Older revision		Revision as of 12:44, 11 November 2013
Line 5:		Line 5:
	These scripts are still supported but are not used by the dev team when making new scripts.		These scripts are still supported but are not used by the dev team when making new scripts.

	Starting in 0.38.2 all old scripts still using V1 were converted to [[Version 2 Scripts]].		Starting in [[Version_history#0.38.2\|0.38.2]] all old scripts still using V1 were converted to [[Version 2 Scripts]].
	== Commands ==		== Commands ==
	Commands often have a subcommand. All combinations will be listed below.		Commands often have a subcommand. All combinations will be listed below.

Blazer257 at 10:43, 11 November 2013

2013-11-11T10:43:31Z

← Older revision		Revision as of 12:43, 11 November 2013
Line 4:		Line 4:

	These scripts are still supported but are not used by the dev team when making new scripts.		These scripts are still supported but are not used by the dev team when making new scripts.

			Starting in 0.38.2 all old scripts still using V1 were converted to [[Version 2 Scripts]].
	== Commands ==		== Commands ==
	Commands often have a subcommand. All combinations will be listed below.		Commands often have a subcommand. All combinations will be listed below.

Blazer257: /* Pokemon */

2013-09-02T20:12:56Z

Pokemon

← Older revision		Revision as of 22:12, 2 September 2013
Line 254:		Line 254:
	\|-		\|-
	\| @Pokemon:clear		\| @Pokemon:clear
	\| ~~hrm?~~		\| Removes all pokemon from your party.
	\| no value		\| no value
	\|-		\|-
Line 297:		Line 297:
	\|-		\|-
	\| colspan="3" \|		\| colspan="3" \|

	=== Register ===		=== Register ===
	\|-		\|-

Blazer257 at 20:20, 14 July 2013

2013-07-14T20:20:33Z

← Older revision		Revision as of 22:20, 14 July 2013
Line 1:		Line 1:
	These scripts follow the @Command:subcommand pattern with not all Commands needing sub commands.		These scripts follow the @Command:subcommand pattern with not all Commands needing sub commands.

	Version 1 is Case Sensitive.		Version 1 is Case Sensitive.

	These scripts are still supported but are not used by the dev team when making new scripts.		These scripts are still supported but are not used by the dev team when making new scripts.
	== Commands ==		== Commands ==

Blazer257 at 20:20, 14 July 2013

2013-07-14T20:20:21Z

← Older revision		Revision as of 22:20, 14 July 2013
Line 1:		Line 1:
			These scripts follow the @Command:subcommand pattern with not all Commands needing sub commands.
			Version 1 is Case Sensitive.
			These scripts are still supported but are not used by the dev team when making new scripts.
	== Commands ==		== Commands ==
	Commands often have a subcommand. All combinations will be listed below.		Commands often have a subcommand. All combinations will be listed below.

Blazer257 at 19:39, 14 July 2013

2013-07-14T19:39:05Z

← Older revision		Revision as of 21:39, 14 July 2013
Line 445:		Line 445:
	\| Checks the map weather against the given weather. This is not the random weather effect but rather permanent weather such as Route 33's eternal rain.		\| Checks the map weather against the given weather. This is not the random weather effect but rather permanent weather such as Route 33's eternal rain.
	\|}		\|}
			{{FilePaths}}

Blazer257 at 18:01, 14 July 2013

2013-07-14T18:01:59Z

Show changes

Blazer257: Created page with "== Commands == Commands often have a subcommand. All combinations will be listed below. * unless otherwise specified a bool can bee either 1(on) or 0(off). ..."

2013-07-14T17:54:11Z

Created page with "== Commands == Commands often have a subcommand. All combinations will be listed below. <nowiki>*</nowiki> unless otherwise specified a bool can bee either 1(on) or 0(off). ..."

New page

== Commands ==
Commands often have a subcommand. All combinations will be listed below.

<nowiki>*</nowiki> unless otherwise specified a bool can bee either 1(on) or 0(off).

<nowiki>** Unless otherwise specified X,Y,Z is a three dimensional position.</nowiki>
{|class="wikitable"
! Subcommand
! Job
! Inputs
|-
| @Achievement:{#}<nowiki>|</nowiki>text
| Activates an Achievement.
|
* # - Number of the Achievement.
* text - Not important. Must have the pipe character
|-
| @Action:ActivateThirdPerson
| Goto third person.
| No input.
|-
| @Action:ApricornKurt
| Opens up the Appricorn menu to have 'Kurt' make you an appricorn.
| No input.
|-
| @Action:DayCare(#1,#2)
|-
| @Action:DeactivateThirdPerson
| Goto first person
| No input.
|-
| @Action:getpokemon(see@Pokemon:add)
| same as @Pokemon:add
|
|-
| @Action:Network
| Opens the co-op menu.
| No input.
|-
| @Action:Opendonation
| Opens the list of Donars(needs updating).
| No input.
|-
| @Action:PlayCry(#)
| Plays the cry of the specified Pokemon
| # - National Dex Number.
|-
| @Action:RecievePokedex
| Gives you the Pokedex.
| No input.
|-
| @Action:RenamePokemon(#)
| Allows a player to rename a Pokemon.
| # - Party index Number
|-
| @Action:RenameRival
| Rename your rival.
| No input.
|-
| @Action:SetFont(text)
| Change the font
| text - Can be standard or Unown.
|-
| @Action:SetRenderDistance(#)
| Set the Renderdistance.
| # - 0-4, A render distance option.
|-
| @Action:Show0Pokemon(bool)
| Turns Following Pokemon on or off.
|-
| @Action:StorageSystem
| Activates the storage system.
| No input.
|-
| @Action:ToggleDarkness
| Turn darkness on or off.
| No input.
|-
| @Action:ToggleThirdPerson
| Change between third and first person.
| No input.
|-
| @Action:townmap,text
| Opens the town map.
| text - region name. Only Johto is currently available.
|-
| @Action:Trade(#)
|-
| @Action:wearskin(see @Player:wearskin)
| see @Player:wearskin.
| see @Player:wearskin.
|-
| @Battle:Wild(#1,#2)
| Start a wild pokemon battle
|
* #1 - National Dex Number.
* #2 - Level.
|-
| @Battle:Trainer(text)
| Battle a trainer
| text - Trainer file in /Scripts/Trainer/.
|-
| @Camera:pitch(#)
|-
| @Camera:position(X,Y,Z)
|-
| @Camera:reset
|-
| @Camera:set(X,Y,Z,#1,#2)
|
|
|-
| @Camera:x(#)
|-
| @Camera:y(#)
|-
| @Camera:yaw(#)
|-
| @Camera:z(#)
|-
| @GiveItem:#1,#2
| Gives the player an item
|
* #1 - Item ID number.
* #2 - Amount of items given
|-
| @Heal
| Heals all Pokemon
| No input.
|-
| @MessageBulb:#,X,Y,Z
|-
| @Move:#1,#2
| Move a certain number of spaces.
|
* #1 - NPC ID number. Can also be 'Player'.
* #2 - Number of spaces.
|-
| @Music:text
| Plays designated music.
| text - name of a file in /Content/Songs/.
|-
| @NPC:Position(#,X,Y,Z)
| Moves an NPC to a specific point.
| # - NPC ID.
|-
| @NPC:register(text)
|
|
|-
| @NPC:remove(#)
| Removes an NPC from the map.
| # - NPC ID.
|-
| @NPC:unregiser(text)
|
|
|-
| @NPC:wearskin(#,text)
| Change the skin used on an NPC. Doesn't change until it is out of view.
|
* # - NPC ID.
* text - skin name in /Content/Textures/NPC.
|-
| @Options:text,text,...
| Creates a menu with multiple options. Uses the :when construct(see below)
| text - The options. Can be as many as you want.
|-
| @Player:move(#)
| Move the player in a straight line
| # - Number of step.
|-
| @Player:turn(#)
| Turns the player to the left
| # - Amount of quarter turns.
|-
| @Player:turnto(#)
| Turns to a specific direction.
| # - 0-3, specifies the direction to turn to.
|-
| @Player:warp(X,Y,Z)
| Warp to a specified place.
| Position values.
|-
| @Player:warp(text,X,Y,Z,R)
| Warps to a different map.
|
* text - Map name.
* X,Y,Z,R - Position and Rotation.
|-
| @Player:wearskin(text)
| Change the player's skin.
| text - the name of a skin in /content/textures/NPC.
|-
| @Pokemon:add(#1,#2,text1,#3,text2,bool,text3)
| Adds a Pokemon to your party.
|
* #1 - Pokemon's National Dex number.
* #2 - Level.
* text1 - Catch Method. Optional.
* #3 - Catch Ball. Optional.
* bool - Is in an egg or not. Optional.
* text2 - Catch Trainer. Optional.
|-
| @Pokemon:Addattack(#1,#2)
| Adds an attack to a specific Pokemon.
|
* #1 - 0-5, Party index of a Pokemon.
* #2 - [[Moves|Move ID number.]]
|-
| @Pokemon:clear
| hrm?
| no value
|-
| @Pokemon:clearattacks(#)
| Removes all attacks from a specified pokemon.
| # - 0-5, Party index of a Pokemon.
|-
| @Pokemon:remove(#)
| Removes a Pokemon from the party.
| # - 0-5, Party index of a Pokemon.
|-
| @Pokemon:Removeattack(#1,#2)
| Removes an attack from a Pokemon.
|
* #1 - 0-5, Party index of a Pokemon.
* #2 - 0-3, Move location ID(its spot on the Pokemon).
|-
| @Pokemon:Setadditionalvalue(#,info)
| Puts info into the AdditionalValue part of a pokemon's save. Example use: designate which Unown.
|
* # - 0-5, Party index of a Pokemon.
* info - Stuff to be added to AdditionalValue.
|-
| @Pokemon:setNickName(#,text)
| Change a Pokemon's name.
|
* # - 0-5, Party index of a Pokemon.
* text - New Name.
|-
| @Pokemon:setshiny(#,bool)
| Make a Pokemon shiny or not.
|
* # - 0-5, Party index of a Pokemon.
* bool - Turns the shiny on or off.
|-
| @Pokemon:setStat(#1,text,#2)
| Set a Pokemon's stat to a specific value.
|
* #1 - 0-5, Pary index of a Pokemon.
* text - Name of the stat to adjust. Possible values: hp, chp, attack, defense, spattack, spdefense, speed.
* #2 - Stat value.
|-
| @Register:text
| Adds text to Register.dat.
| text - What to add.
|-
| @Script:text
| Activates a script file.
| text - Script in /Scripts/.
|-
| @Sound:text
| Plays designated sound.
| text - name of a file in /Content/Sounds/.
|-
| @Trainer:text
| Same as @Battle:Trainer.
| Same as @Battle:Trainer.
|-
| @Text:text
| Displays text '~' breaks it to a new line, and '*' resets the text box.
| text - the display text
|-
| @Unregister:text
| Removes text from Register.dat.
| text - What to remove.
|-
| @Wait:#
| Waits a certain amount of time.
| # - Amount of time to wait.
|-
| @Warp:#,X,Y,Z
| Warps a sprite to a new position. Will not appear until a movement script has been activated
| # - NPC ID number. Can also be 'Player'.
|}

== Constructs ==
Constructs are functions in scripts that are not doing something in the game but rather with the script itself.
Constructs start with a : at the beginning of the line and are case sensitive!
Here's the list of constructs:

{|class="wikitable"
! Construct
! Use
|-
| :end
| Ends the script.
|-
| :endif
| Ends an :if statement.
|-
| :endwhen
| Ends a when statement
|-
| :if
| See Below.
|-
| :then
| Follows an :if statement. Continues here if true.
|-
| :else
| Continues here when an :if statement if False.
|-
| :when
| Works as a switch for the @options command.
|}

=== :if statements ===
:if statements can be either 'if true' statements or 'if false' statements

'if true:'
<pre>:if:register(elm1)</pre>

'if false'
<pre>:if:not register(elm1)</pre>

:if statements can take a variety of conditions as the argument. Here is the full list.

{|class="wikitable"
! Argument
! Variable
! Description
|-
| :aurora
| no variable
| Checks for the 'Aurora' effect?
|-
| :day(#)
| # - A 'day' code. (0-6) 0 = Sunday and goes from there.
| Checks if the current weekday matches the code given.
|-
| :daytime(#)
| # - A time of day value. 0 = night, 1 = morning, 2 = Day, 3 = Evening.
| Checks the time of day against the given value.
|-
| :freeplaceinparty
| no variable
| Checks to see if your party is full.
|-
| :hasBadge(#)
| # - the number of a gym badge. Remember Brock = 1, Falkner = 9.
| Checks if you have the given badge.
|-
| :hasItem(#)
| # - [[Items|An Item's ID number.]]
| Checks if the given item is in your bag
|-
| :nopokemon
| No variable
| Checks to see if you have any Pokemon.
|-
| :position(#,X,Y,Z)
|
* # - The NPC ID of an NPC on the Map. Can also be 'Player' to check the player's position
* X,Y,Z - A three coordinate position.
| Checks if the given NPC(or the player) is in the given place
|-
| :random(#)
| # - The max value.
| Produces a Random integer?
|-
| :regionWeather(#)
| # - A weather ID. 0 = Clear, 1 = Rain, 2 = Snow, 3 = Bubbles
| Checks to see if the random weather is the same as the given weather.
|-
| :register(text)
| text - A register value in the register.dat file of the save folder.
| Checks to see if the 'text' is in the register.dat file. Considered true if found.
|-
| :weather(#)
| # - A weather ID. 0 = Clear, 1 = Rain, 2 = Snow, 3 = Bubbles
| Checks the map weather against the given weather. This is not the random weather effect but rather permanent weather such as Route 33's eternal rain.
|}