This shows you the differences between two versions of the page.
Next revision | Previous revisionNext revisionBoth sides next revision | ||
stats_editor [2022/05/15 13:56] – created justin | stats_editor [2024/04/07 11:30] – justin | ||
---|---|---|---|
Line 3: | Line 3: | ||
=====Overview===== | =====Overview===== | ||
- | The **Stats Editor** allows you to set up ... | + | The **Stats Editor** allows you to set up various stat-related aspects for your game. This includes [[character]] stats, experience leveling data, equipment slot configurations, |
+ | |||
+ | =====Character Stats===== | ||
+ | The **Character Stats** section allows you to modify certain aspects of the stats for your game's [[character|characters]]. This includes defining maximum values for the built-in stats and creating custom stats. To add a custom stat, click the green " | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Refer to the table below for a list of built-in stats that can be retrieved or modified for a [[character]]. | ||
+ | ^Stat Name^Description^ID^ | ||
+ | |HP|Health/ | ||
+ | |Max HP|Maximum health/HP of the [[character]].|" | ||
+ | |MP|Magic/ | ||
+ | |Max MP|Maximum magic/MP of the [[character]].|" | ||
+ | |XP|Total experience points earned by the [[character]].|" | ||
+ | |Level|Current experience level of the [[character]].|" | ||
+ | |Currency|Amount of currency held by the [[character]].|" | ||
+ | |Attack|Attack value of the [[character]].|" | ||
+ | |Defense|Defense value of the [[character]].|" | ||
+ | |Movement Range|Movement range (in [[tile|tiles]]) of the [[character]]. This stat is used in [[combat_editor|tactical turn-based combat]].|" | ||
+ | |Movement Speed|Movement speed (in [[voxel|voxels]] per second) of the [[character]].|" | ||
+ | |||
+ | A character' | ||
+ | |||
+ | **Examples: | ||
+ | |||
+ | Restore the player' | ||
+ | <code bauxite> | ||
+ | player.stat[" | ||
+ | </ | ||
+ | <code bauxite> | ||
+ | set_stat(" | ||
+ | </ | ||
+ | |||
+ | Increase the player' | ||
+ | <code bauxite> | ||
+ | player.stat[" | ||
+ | </ | ||
+ | <code bauxite> | ||
+ | increase_stat(" | ||
+ | </ | ||
=====Leveling===== | =====Leveling===== | ||
- | ^Stat Name^Description^Script ID^ | + | The **Leveling** section allows you to set up leveling information for your [[character|characters]]. This includes a table of levels and the experience points required for each level. You can configure specific stat increases for each level, including any custom stats you've defined in the **Character Stats** section. When a [[character]] reaches a particular level, those stat increases will be automatically applied. |
- | |Health/ | + | |
+ | {{: | ||
+ | |||
+ | To add a new level to the table, click the green "plus" | ||
+ | |||
+ | <WRAP center round info 100%> | ||
+ | Note that each level can have more than one custom stat increase. To set the increase for each stat, select it from the " | ||
+ | </ | ||
=====Equipment===== | =====Equipment===== | ||
+ | The **Equipment** section allows you to view and edit equipment slot configurations for the [[character|characters]] in your game. The default built-in slot configuration can be viewed but not edited. To add a new slot configuration, | ||
+ | |||
+ | {{: | ||
+ | |||
+ | When a custom configuration is selected in the "Slot Configurations" | ||
+ | |||
+ | ^Setting^Description^ | ||
+ | |Item Tags Allowed|Determines which [[item]] tags are allowed for this slot. In order for an [[item]] to be equipped into this slot, it must have at least one of these tags defined for it in the [[Item Editor]]. Multiple tags can be specified by separating them with commas.| | ||
+ | |Weapon|Determines if this slot is for weapons (for future functionality).| | ||
+ | |||
+ | <WRAP center round info 100%> | ||
+ | You can override the default equipment slot configuration for a specific [[character]] via the " | ||
+ | </ | ||
+ | |||
+ | =====Skills===== | ||
+ | The **Skills** section allows you to create special abilities for the player [[character|characters]] in your game to use. To add a [[skill]], click the green “plus” button. A [[skill]] can be removed by clicking the red “X” button. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | See below for a description of each [[skill]] setting. | ||
+ | ^Setting^Description^ | ||
+ | |ID|Unique ID for the [[skill]]. This ID is used with the [[Give Skill]], [[Remove Skill]], and [[Use Skill]] scripting functions.| | ||
+ | |Name|Name of the [[skill]]. The name is displayed on the skill' | ||
+ | |Image|Image for the [[skill]]. The image is displayed in [[skill_slot|skill slots]] with that [[skill]] assigned.| | ||
+ | |Description|Description of the [[skill]]. The description is displayed on the skill' | ||
+ | |Category|Category of the [[skill]] (for future functionality).| | ||
+ | |Active/ | ||
+ | |Usable in Combat|Determines whether or not the [[skill]] can be used during turn-based battles.| | ||
+ | |Stat Required|Determines which stat must be consumed in order to use the [[skill]] (defaults to none).| | ||
+ | |Target|Currently supported targets: **Self**, **Party**, **Party Member**, **Enemy**, and **All Enemies**.| | ||
+ | |Cooldown (Real-Time)|Determines the cooldown for the [[skill]] when used in real-time mode. For real-time mode, the cooldown is measured in seconds.| | ||
+ | |Cooldown (Turn-Based)|Determines the cooldown for the [[skill]] when used in turn-based battles. For turn-based battles, the cooldown is measured in turns.| | ||
+ | |Cooldown (Roguelike)|Determines the cooldown for the [[skill]] when used in roguelike mode. In roguelike mode, the cooldown is measured in actions.| | ||
+ | |Effects|List of effects that will occur (as ordered) when the [[skill]] is used. An effect can either be a built-in one (added via the green " | ||
+ | |Effect Details|Section for any settings specific to the currently selected [[skill]] effect.| | ||
+ | |||
+ | Refer to the table below for a description of each effect that can be added to a [[skill]]. | ||
+ | ^Skill Effect^Description^ | ||
+ | |Healing (HP Restoration)|Heals the target(s) for a fixed amount or a percentage of their HP.| | ||
+ | |Damage (HP Loss)|Damages the target(s) for a fixed amount or a percentage of their HP.| | ||
+ | |Temporary Stat Buff|Increases a specific stat for the target(s) for a limited duration of time.| | ||
+ | |Temporary Stat Debuff|Decreases a specific stat for the target(s) for a limited duration of time.| | ||
+ | |Apply Status Effect|Applies a [[status effect]] to the target(s) for a limited duration of time.| | ||
+ | |Remove Status Effect|Removes a [[status effect]] from the target(s).| | ||
+ | |Clear Status Effects|Clears all [[status_effect|status effects]] from the target(s).| | ||
+ | |Summon Character|Summons a [[character]] to join the player' | ||
+ | |Play Sound|Plays a [[sound|sound effect]].| | ||
+ | |||
+ | =====Status Effects===== | ||
+ | The **Status Effects** section allows you to create statuses that can be applied to [[character|characters]] for a duration of time or permanently, | ||
+ | |||
+ | {{: | ||
+ | |||
+ | See below for a description of each [[status effect]] setting. | ||
+ | ^Setting^Description^ | ||
+ | |ID|Unique ID for the [[status effect]]. This ID is used with the [[Apply Status Effect]], [[Remove Status Effect]], and [[Clear Status Effects]] scripting functions.| | ||
+ | |Name|Name of the [[status effect]]. Currently this is only used by the editor for display purposes.| | ||
+ | |Image|Image for the [[status effect]]. Currently this is only used by the editor for display purposes.| | ||
+ | |Description|Description of the [[status effect]]. Currently this is only used by the editor for display purposes.| | ||
+ | |Effect Type|Determines how the [[status effect]] affects its target. Currently supported types: **Stat Buff**, **Stat Debuff**, **Healing Over Time**, **Damage Over Time**, and **Stun**.| | ||
+ | |Affected Stat|Determines which [[character]] stat is affected by the [[status effect]]. Only applicable to the **Stat Buff** and **Stat Debuff** effect types.| | ||
+ | |Amount|Determines the amount by which the [[character|character' | ||
+ | |Tick on Apply|Determines if the [[status effect]] immediately triggers when first applied to a [[character]] (e.g. a bleeding effect that deals damage right away) or if it waits until the first configured interval of time has passed (see interval settings below).| | ||
+ | |Interval (Real-Time)|Determines the frequency of the effect while in real-time mode (e.g. a **Healing Over Time** effect with an interval of 2 means the healing will occur every two seconds). Only applicable to the **Healing Over Time** and **Damage Over Time** effect types.| | ||
+ | |Interval (Turn-Based)|Determines the frequency of the effect while in a turn-based battle (e.g. a **Healing Over Time** effect with an interval of 2 means the healing will occur every two turns). Only applicable to the **Healing Over Time** and **Damage Over Time** effect types.| | ||
+ | |Interval (Roguelike)|Determines the frequency of the effect while in roguelike mode (e.g. a **Healing Over Time** effect with an interval of 2 means the healing will occur every two actions). Only applicable to the **Healing Over Time** and **Damage Over Time** effect types.| | ||
+ | |Visual Effect|Particle effect that will be attached to [[character|characters]] who have this [[status effect]] applied. By default, it will be attached to the [[attach_points|attach point]] with an ID of " | ||
+ | |Attach Point|Determines which [[attach_points|attach point]] to use if a visual effect is assigned to this [[status effect]] (see setting above). Defaults to " | ||
+ | |||
+ | =====Currency===== | ||
+ | The **Currency** section allows you to edit the name and image for the built-in base currency, and even create custom currencies for your game. To add a custom currency, click the green " | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Refer to the table below for a description of each currency setting. | ||
+ | |||
+ | ^Setting^Description^ | ||
+ | |Currency Name|Name of the currency. Changing this for the base currency will affect what is displayed on the built-in [[inventory]] [[widget]].| | ||
+ | |Associated Stat|Stat to which the currency is tied (i.e. the stat that will store how much of the currency a [[character]] has).| | ||
+ | |Image|Image to use for the currency. Changing this for the base currency will affect what is displayed on the built-in [[inventory]] [[widget]].| | ||
+ | <WRAP center round tip 100%> | ||
+ | If you wanted your game to have a " | ||
+ | </ | ||
~~NOTOC~~ | ~~NOTOC~~ |