SkillData Reference: Difference between revisions
(Created page with "This page shows all properties of SkillData that can be manipulated from Lua. == SkillData.Name == The name of the data == SkillData.Desc == The description of the data == SkillData.Released == Is it released and allowed to show up in the game? == SkillData.Comment == Comments visible to only developers == SkillData.IndexNum == Index number of the skill for sorting. Must be unique == SkillData.BaseCharges == The number of times the skill can be us...") |
mNo edit summary |
||
(3 intermediate revisions by the same user not shown) | |||
Line 3: | Line 3: | ||
== SkillData.Name == | == SkillData.Name == | ||
public [[LocalText Reference|LocalText]] Name; | |||
The name of | The move's name. The default (English) name of a move can be called with <code>skill.Name.DefaultName</code>. | ||
== SkillData.Desc == | == SkillData.Desc == | ||
public [[LocalText Reference|LocalText]] Desc; | |||
The description of | The move's description text when viewed in the menu. The default (English) description of a move can be called with <code>skill.Desc.DefaultName</code>. | ||
== SkillData.Released == | == SkillData.Released == | ||
public bool Released; | |||
Internal flag to show whether a move is completed and allowed to show up in the game. <code>true</code> if the move is completed, <code>false</code> otherwise. Moves that are not released show up with an *asterisk next to their names when viewed in the [[Dev Mode]] editors. | |||
== SkillData.Comment == | == SkillData.Comment == | ||
public string Comment; | |||
An internal piece of text only visible using the [[Dev Mode]] editors, or by calling this property. Usually used to take notes on the move if necessary. | |||
== SkillData.IndexNum == | == SkillData.IndexNum == | ||
public int IndexNum; | |||
Index number of the | Index number of the move for sorting. Must be unique. For moves from the original Pokémon games, generally correlates with the move's [https://bulbapedia.bulbagarden.net/wiki/List_of_moves internal id number] in the main series games. | ||
== SkillData.BaseCharges == | == SkillData.BaseCharges == | ||
public int BaseCharges; | |||
The | The move's default max [[PP]]. | ||
== SkillData.Strikes == | == SkillData.Strikes == | ||
[Dev.NumberRange(0, 1, Int32.MaxValue)] | |||
public int Strikes; | |||
How many times the | How many times the move attacks. Set greater than 1 for multi-strike moves like [[Fury Swipes]]. | ||
== SkillData.HitboxAction == | == SkillData.HitboxAction == | ||
public [[CombatAction Reference|CombatAction]] HitboxAction; | |||
Data on the hitbox of the | Data on the hitbox of the move. Controls range and targeting — how far the move travels; whether it's a dash, shot, etc.; and whether it hits allies, enemies, or both. | ||
== SkillData.Explosion == | == SkillData.Explosion == | ||
public [[ExplosionData Reference|ExplosionData]] Explosion; | |||
Optional | Optional. Data to specify a splash effect on the tiles/Pokémon hit. | ||
== SkillData.Data == | == SkillData.Data == | ||
public [[BattleData Reference|BattleData]] Data; | |||
Events that occur with this move, i.e. attack effects. Pretty much all of the combat logic of the moves beyond its range and number of hits will be found here. | |||
[[Category: | |||
== SkillData.GetColoredName() == | |||
public string GetColoredName(); | |||
Returns the name of the skill along with the appropriate [[Text Guide#color | color text code]] for moves. | |||
== SkillData.GetIconName() == | |||
public string GetColoredName(); | |||
Returns the name of the skill along with the appropriate [[Text Guide#color | color text codes]] for moves and with the type icon prepended. This is what's usually used to display the name of the move in menus. | |||
[[Category:Data Class Documentation]] |
Revision as of 20:14, 9 May 2024
This page shows all properties of SkillData that can be manipulated from Lua.
SkillData.Name
public LocalText Name;
The move's name. The default (English) name of a move can be called with skill.Name.DefaultName
.
SkillData.Desc
public LocalText Desc;
The move's description text when viewed in the menu. The default (English) description of a move can be called with skill.Desc.DefaultName
.
SkillData.Released
public bool Released;
Internal flag to show whether a move is completed and allowed to show up in the game. true
if the move is completed, false
otherwise. Moves that are not released show up with an *asterisk next to their names when viewed in the Dev Mode editors.
SkillData.Comment
public string Comment;
An internal piece of text only visible using the Dev Mode editors, or by calling this property. Usually used to take notes on the move if necessary.
SkillData.IndexNum
public int IndexNum;
Index number of the move for sorting. Must be unique. For moves from the original Pokémon games, generally correlates with the move's internal id number in the main series games.
SkillData.BaseCharges
public int BaseCharges;
The move's default max PP.
SkillData.Strikes
[Dev.NumberRange(0, 1, Int32.MaxValue)] public int Strikes;
How many times the move attacks. Set greater than 1 for multi-strike moves like Fury Swipes.
SkillData.HitboxAction
public CombatAction HitboxAction;
Data on the hitbox of the move. Controls range and targeting — how far the move travels; whether it's a dash, shot, etc.; and whether it hits allies, enemies, or both.
SkillData.Explosion
public ExplosionData Explosion;
Optional. Data to specify a splash effect on the tiles/Pokémon hit.
SkillData.Data
public BattleData Data;
Events that occur with this move, i.e. attack effects. Pretty much all of the combat logic of the moves beyond its range and number of hits will be found here.
SkillData.GetColoredName()
public string GetColoredName();
Returns the name of the skill along with the appropriate color text code for moves.
SkillData.GetIconName()
public string GetColoredName();
Returns the name of the skill along with the appropriate color text codes for moves and with the type icon prepended. This is what's usually used to display the name of the move in menus.