|
|
| Line 1: |
Line 1: |
| − | {{SCPUI_table}}
| |
| − | {{Tables}}
| |
| − | Achievements.tbl is used by the [[SCPUI]] script system to define the achievements available for a particular mod.
| |
| | | | |
| − | Achievements.tbl, by design, is NOT modular and cannot be extended.
| |
| − |
| |
| − | ==Achievements.tbl==
| |
| − | *Defines what achievements are available and how they are unlocked
| |
| − | *Begins with #ACHIEVEMENTS and ends with #End
| |
| − |
| |
| − | ==#ACHIEVEMENTS==
| |
| − | *The list of achievements
| |
| − | *Can have multiple Achievements starting with $Name
| |
| − |
| |
| − | ===$Name:===
| |
| − | *The name of the achievement as shown to the player.
| |
| − | *Cannot exceed 32 characters.
| |
| − | *Must be unique.
| |
| − | *Syntax: '''''string'''''
| |
| − |
| |
| − | ====+Description:====
| |
| − | *A string describing the achievement.
| |
| − | *Cannot exceed 50 characters.
| |
| − | *Syntax: '''''string'''''
| |
| − |
| |
| − | ====+Criteria:====
| |
| − | *Begins parsing the Criteria section
| |
| − | *Contains no value
| |
| − |
| |
| − | =====+Type:=====
| |
| − | *The criteria type. Must be one of "Custom", "Number of Kills", or "Weapons Fired"
| |
| − | *Syntax: '''''string'''''
| |
| − |
| |
| − | =====+Target:=====
| |
| − | *The target of the achievement criteria.
| |
| − | *If the type is Number of Kills then this should be a ship class. If the type is Weapons Fired this should be a weapon class. For other criteria types this field is discarded.
| |
| − | *This value is optional. If not provided then all ships or weapons count towards the achievement.
| |
| − | *Syntax: '''''string'''''
| |
| − |
| |
| − | =====+Threshold:=====
| |
| − | *The threshold of the criteria. IE: The number of whatever the player must reach to unlock the achievement.
| |
| − | *For singular event custom achievements a value of 1 should be used.
| |
| − | *This value is optional. If not provided, a default width of 1 will be used.
| |
| − | *Syntax: '''''integer'''''
| |
| − |
| |
| − | ====+Hidden:====
| |
| − | *Specifies if the achievement should be hidden until unlocked
| |
| − | *This value is optional. If not provided, a default height of false will be used.
| |
| − | *Syntax: '''''boolean'''''
| |
| − |
| |
| − | ====+Color:====
| |
| − | *The color of the text for the achievement in the UI.
| |
| − | *Use R,G,B,A format. A is optional and defaults to 255.
| |
| − | *This value is optional. If not provided, the color will be the UI default.
| |
| − | *Syntax: '''''integer, integer, integer, integer'''''
| |
| − |
| |
| − | ====+Bar Color:====
| |
| − | *The color of the progress bar for the achievement in the UI.
| |
| − | *Use R,G,B,A format. A is optional and defaults to 255.
| |
| − | *This value is optional. If not provided, the color will be the UI default.
| |
| − | *Syntax: '''''integer, integer, integer, integer'''''
| |
| − |
| |
| − |
| |
| − | ===Example===
| |
| − | <pre>
| |
| − | #ACHIEVEMENTS
| |
| − |
| |
| − | $Name: Achievement name (required)
| |
| − | +Description: Description text (required)
| |
| − | +Criteria:
| |
| − | +Type: Number of Kills, Weapons Fired, Custom (required)
| |
| − | +Target: Ship class or weapon Class (optional)
| |
| − | +Threshold: Number greater than 0 (optional)
| |
| − | +Hidden: boolean (optional, default: false)
| |
| − | +Color: 128, 128, 128, 255
| |
| − | +Bar Color: 255, 0, 0, 255
| |
| − |
| |
| − | #END
| |
| − | </pre>
| |
| − | [[Category:Tables]]
| |
| − | [[Category:SCPUI]]
| |
