IntrinsicData Reference: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
This page shows all properties of IntrinsicData that can be manipulated from Lua. | This page shows all properties of IntrinsicData that can be manipulated from Lua. | ||
== IntrinsicData.Name == | == IntrinsicData.Name == | ||
public [[LocalText Reference|LocalText]] Name; | |||
The ability's name. More often than not, you'll want to call [[#IntrinsicData:GetColoredName()|GetColoredName()]] instead. | |||
== IntrinsicData:ToString() == | |||
public override string ToString() | |||
Returns the name of the move in the currently set language. | |||
== IntrinsicData.Desc == | == IntrinsicData.Desc == | ||
public [[LocalText Reference|LocalText]] Desc; | |||
The description of | The ability's description text when viewed in the menu. The default (English) description of a move can be called with <code>ability.Desc.DefaultName</code>. | ||
== IntrinsicData.Released == | == IntrinsicData.Released == | ||
public bool Released; | |||
Internal flag to show whether an ability is completed and allowed to show up in the game. <code>true</code> if the move is completed, <code>false</code> otherwise. Abilities that are not released show up with an *asterisk next to their names when viewed in the [[Dev Mode]] editors. | |||
== IntrinsicData.Comment == | == IntrinsicData.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 ability if necessary. | |||
== IntrinsicData.IndexNum == | == IntrinsicData.IndexNum == | ||
public int IndexNum; | |||
Index number of the ability for sorting. Must be unique. For abilities from the original Pokémon games, generally correlates with the ability's [https://bulbapedia.bulbagarden.net/wiki/List_of_Abilities internal id number] in the main series games. | |||
== IntrinsicData:GetColoredName() == | |||
public string GetColoredName(); | |||
Returns the name of the ability along with the appropriate [[Text Guide#color | color text code]] for moves. | |||
== IntrinsicData:GenerateEntrySummary() == | |||
public [[EntrySummary Reference|EntrySummary]] GenerateEntrySummary() | |||
Returns an [[EntrySummary]] of the ability. | |||
[[Category:Data Class Documentation]] | [[Category:Data Class Documentation]] |
Latest revision as of 14:47, 10 May 2024
This page shows all properties of IntrinsicData that can be manipulated from Lua.
IntrinsicData.Name
public LocalText Name;
The ability's name. More often than not, you'll want to call GetColoredName() instead.
IntrinsicData:ToString()
public override string ToString()
Returns the name of the move in the currently set language.
IntrinsicData.Desc
public LocalText Desc;
The ability's description text when viewed in the menu. The default (English) description of a move can be called with ability.Desc.DefaultName
.
IntrinsicData.Released
public bool Released;
Internal flag to show whether an ability is completed and allowed to show up in the game. true
if the move is completed, false
otherwise. Abilities that are not released show up with an *asterisk next to their names when viewed in the Dev Mode editors.
IntrinsicData.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 ability if necessary.
IntrinsicData.IndexNum
public int IndexNum;
Index number of the ability for sorting. Must be unique. For abilities from the original Pokémon games, generally correlates with the ability's internal id number in the main series games.
IntrinsicData:GetColoredName()
public string GetColoredName();
Returns the name of the ability along with the appropriate color text code for moves.
IntrinsicData:GenerateEntrySummary()
public EntrySummary GenerateEntrySummary()
Returns an EntrySummary of the ability.