Difference between revisions of "Version 1 Scripts"
Jump to navigation
Jump to search
(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). ...") |
|||
| Line 9: | Line 9: | ||
! Job | ! Job | ||
! Inputs | ! Inputs | ||
|- | |||
| colspan="3" | | |||
=== Achievments === | |||
|- | |- | ||
| @Achievement:{#}<nowiki>|</nowiki>text | | @Achievement:{#}<nowiki>|</nowiki>text | ||
| Line 15: | Line 18: | ||
* # - Number of the Achievement. | * # - Number of the Achievement. | ||
* text - Not important. Must have the pipe character | * text - Not important. Must have the pipe character | ||
|- | |||
| colspan="3" | | |||
=== Action === | |||
|- | |- | ||
| @Action:ActivateThirdPerson | | @Action:ActivateThirdPerson | ||
| Line 90: | Line 96: | ||
| see @Player:wearskin. | | see @Player:wearskin. | ||
| see @Player:wearskin. | | see @Player:wearskin. | ||
|- | |||
| colspan="3" | | |||
=== Battle === | |||
|- | |- | ||
| @Battle:Wild(#1,#2) | | @Battle:Wild(#1,#2) | ||
| Line 100: | Line 109: | ||
| Battle a trainer | | Battle a trainer | ||
| text - Trainer file in /Scripts/Trainer/. | | text - Trainer file in /Scripts/Trainer/. | ||
|- | |||
| colspan="3" | | |||
=== Camera === | |||
|- | |- | ||
| @Camera:pitch(#) | | @Camera:pitch(#) | ||
| Line 118: | Line 130: | ||
|- | |- | ||
| @Camera:z(#) | | @Camera:z(#) | ||
|- | |||
| colspan="3" | | |||
=== GiveItem === | |||
|- | |- | ||
| @GiveItem:#1,#2 | | @GiveItem:#1,#2 | ||
| Line 124: | Line 139: | ||
* #1 - Item ID number. | * #1 - Item ID number. | ||
* #2 - Amount of items given | * #2 - Amount of items given | ||
|- | |||
| colspan="3" | | |||
=== Heal === | |||
|- | |- | ||
| @Heal | | @Heal | ||
| Heals all Pokemon | | Heals all Pokemon | ||
| No input. | | No input. | ||
|- | |||
| colspan="3" | | |||
=== MessageBulb === | |||
|- | |- | ||
| @MessageBulb:#,X,Y,Z | | @MessageBulb:#,X,Y,Z | ||
|- | |||
| colspan="3" | | |||
=== Move === | |||
|- | |- | ||
| @Move:#1,#2 | | @Move:#1,#2 | ||
| Line 136: | Line 160: | ||
* #1 - NPC ID number. Can also be 'Player'. | * #1 - NPC ID number. Can also be 'Player'. | ||
* #2 - Number of spaces. | * #2 - Number of spaces. | ||
|- | |||
| colspan="3" | | |||
=== Music === | |||
|- | |- | ||
| @Music:text | | @Music:text | ||
| Plays designated music. | | Plays designated music. | ||
| text - name of a file in /Content/Songs/. | | text - name of a file in /Content/Songs/. | ||
|- | |||
| colspan="3" | | |||
=== NPC === | |||
|- | |- | ||
| @NPC:Position(#,X,Y,Z) | | @NPC:Position(#,X,Y,Z) | ||
| Line 162: | Line 192: | ||
* # - NPC ID. | * # - NPC ID. | ||
* text - skin name in /Content/Textures/NPC. | * text - skin name in /Content/Textures/NPC. | ||
|- | |||
| colspan="3" | | |||
=== Options === | |||
|- | |- | ||
| @Options:text,text,... | | @Options:text,text,... | ||
| Creates a menu with multiple options. Uses the :when construct(see below) | | Creates a menu with multiple options. Uses the :when construct(see below) | ||
| text - The options. Can be as many as you want. | | text - The options. Can be as many as you want. | ||
|- | |||
| colspan="3" | | |||
=== Player === | |||
|- | |- | ||
| @Player:move(#) | | @Player:move(#) | ||
| Line 192: | Line 228: | ||
| Change the player's skin. | | Change the player's skin. | ||
| text - the name of a skin in /content/textures/NPC. | | text - the name of a skin in /content/textures/NPC. | ||
|- | |||
| colspan="3" | | |||
=== Pokemon === | |||
|- | |- | ||
| @Pokemon:add(#1,#2,text1,#3,text2,bool,text3) | | @Pokemon:add(#1,#2,text1,#3,text2,bool,text3) | ||
| Line 251: | Line 290: | ||
* text - Name of the stat to adjust. Possible values: hp, chp, attack, defense, spattack, spdefense, speed. | * text - Name of the stat to adjust. Possible values: hp, chp, attack, defense, spattack, spdefense, speed. | ||
* #2 - Stat value. | * #2 - Stat value. | ||
|- | |||
| colspan="3" | | |||
=== Register === | |||
|- | |- | ||
| @Register:text | | @Register:text | ||
| Adds text to Register.dat. | | Adds text to Register.dat. | ||
| text - What to add. | | text - What to add. | ||
|- | |||
| colspan="3" | | |||
=== Script === | |||
|- | |- | ||
| @Script:text | | @Script:text | ||
| Activates a script file. | | Activates a script file. | ||
| text - Script in /Scripts/. | | text - Script in /Scripts/. | ||
|- | |||
| colspan="3" | | |||
=== Sound === | |||
|- | |- | ||
| @Sound:text | | @Sound:text | ||
| Plays designated sound. | | Plays designated sound. | ||
| text - name of a file in /Content/Sounds/. | | text - name of a file in /Content/Sounds/. | ||
|- | |||
| colspan="3" | | |||
=== Trainer === | |||
|- | |- | ||
| @Trainer:text | | @Trainer:text | ||
| Same as @Battle:Trainer. | | Same as @Battle:Trainer. | ||
| Same as @Battle:Trainer. | | Same as @Battle:Trainer. | ||
|- | |||
| colspan="3" | | |||
=== Text === | |||
|- | |- | ||
| @Text:text | | @Text:text | ||
| Displays text '~' breaks it to a new line, and '*' resets the text box. | | Displays text '~' breaks it to a new line, and '*' resets the text box. | ||
| text - the display text | | text - the display text | ||
|- | |||
| colspan="3" | | |||
=== Unregister === | |||
|- | |- | ||
| @Unregister:text | | @Unregister:text | ||
| Removes text from Register.dat. | | Removes text from Register.dat. | ||
| text - What to remove. | | text - What to remove. | ||
|- | |||
| colspan="3" | | |||
=== Wait === | |||
|- | |- | ||
| @Wait:# | | @Wait:# | ||
| Waits a certain amount of time. | | Waits a certain amount of time. | ||
| # - Amount of time to wait. | | # - Amount of time to wait. | ||
|- | |||
| colspan="3" | | |||
=== Warp === | |||
|- | |- | ||
| @Warp:#,X,Y,Z | | @Warp:#,X,Y,Z | ||
Revision as of 20:01, 14 July 2013
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).
** Unless otherwise specified X,Y,Z is a three dimensional position.
| Subcommand | Job | Inputs |
|---|---|---|
Achievments | ||
| @Achievement:{#}|text | Activates an Achievement. |
|
Action | ||
| @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 | ||
| @Battle:Wild(#1,#2) | Start a wild pokemon battle |
|
| @Battle:Trainer(text) | Battle a trainer | text - Trainer file in /Scripts/Trainer/. |
Camera | ||
| @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 | ||
| @GiveItem:#1,#2 | Gives the player an item |
|
Heal | ||
| @Heal | Heals all Pokemon | No input. |
MessageBulb | ||
| @MessageBulb:#,X,Y,Z | ||
Move | ||
| @Move:#1,#2 | Move a certain number of spaces. |
|
Music | ||
| @Music:text | Plays designated music. | text - name of a file in /Content/Songs/. |
NPC | ||
| @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. |
|
Options | ||
| @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 | ||
| @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. |
|
| @Player:wearskin(text) | Change the player's skin. | text - the name of a skin in /content/textures/NPC. |
Pokemon | ||
| @Pokemon:add(#1,#2,text1,#3,text2,bool,text3) | Adds a Pokemon to your party. |
|
| @Pokemon:Addattack(#1,#2) | Adds an attack to a specific Pokemon. |
|
| @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. |
|
| @Pokemon:Setadditionalvalue(#,info) | Puts info into the AdditionalValue part of a pokemon's save. Example use: designate which Unown. |
|
| @Pokemon:setNickName(#,text) | Change a Pokemon's name. |
|
| @Pokemon:setshiny(#,bool) | Make a Pokemon shiny or not. |
|
| @Pokemon:setStat(#1,text,#2) | Set a Pokemon's stat to a specific value. |
|
Register | ||
| @Register:text | Adds text to Register.dat. | text - What to add. |
Script | ||
| @Script:text | Activates a script file. | text - Script in /Scripts/. |
Sound | ||
| @Sound:text | Plays designated sound. | text - name of a file in /Content/Sounds/. |
Trainer | ||
| @Trainer:text | Same as @Battle:Trainer. | Same as @Battle:Trainer. |
Text | ||
| @Text:text | Displays text '~' breaks it to a new line, and '*' resets the text box. | text - the display text |
Unregister | ||
| @Unregister:text | Removes text from Register.dat. | text - What to remove. |
Wait | ||
| @Wait:# | Waits a certain amount of time. | # - Amount of time to wait. |
Warp | ||
| @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:
| 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:'
:if:register(elm1)
'if false'
:if:not register(elm1)
- if statements can take a variety of conditions as the argument. Here is the full list.
| 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(#) | # - 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) |
|
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. |