3 lines
10 KiB
HTML
3 lines
10 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/skill - /tg/ Station 13</title></head><body><header><a href="index.html">/tg/ Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/skill.html#var">Var Details</a> - <a href="datum/skill.html#proc">Proc Details</a></header><main><h1>skill <aside>/<a href="datum.html">datum</a>/<a href="datum/skill.html">skill</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L17"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 17"></a></h1><p>Skill datums</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/skill.html#var/abstract_type">abstract_type</a></th><td>Abstract type</td></tr><tr><th><a href="datum/skill.html#var/base_multiplier">base_multiplier</a></th><td>Base multiplier used in skill competency operations.</td></tr><tr><th><a href="datum/skill.html#var/competency_multiplier">competency_multiplier</a></th><td>Value added to the base multiplier depending on overall competency compared to maximum value/level.</td></tr><tr><th><a href="datum/skill.html#var/competency_thresholds">competency_thresholds</a></th><td>skill threshold used in generic skill competency operations.</td></tr><tr><th><a href="datum/skill.html#var/desc">desc</a></th><td>Our description</td></tr><tr><th><a href="datum/skill.html#var/item_skill_gain_multi">item_skill_gain_multi</a></th><td>Experience gain multiplier gained from using items.</td></tr><tr><th><a href="datum/skill.html#var/max_levels">max_levels</a></th><td>List of max levels. Only used in level skills, but present here for helper macros.</td></tr><tr><th><a href="datum/skill.html#var/name">name</a></th><td>Our name</td></tr><tr><th><a href="datum/skill.html#var/name_color">name_color</a></th><td>Color of the name as shown in the html readout</td></tr><tr><th><a href="datum/skill.html#var/progression_type">progression_type</a></th><td>Our progression type. These are mostly used to skip typechecks overhead, don't go around messing with these.</td></tr><tr><th><a href="datum/skill.html#var/skill_gain_quantisation">skill_gain_quantisation</a></th><td>Skill gain quantisation</td></tr><tr><th><a href="datum/skill.html#var/skill_traits">skill_traits</a></th><td>A list of ways this skill can affect or be affected through actions and skill modifiers.</td></tr><tr><th><a href="datum/skill.html#var/ui_category">ui_category</a></th><td>Index of this skill in the UI</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/skill.html#proc/get_skill_data">get_skill_data</a></th><td>Get a list of data used in the skill panel menu.</td></tr><tr><th><a href="datum/skill.html#proc/is_value_greater">is_value_greater</a></th><td>Checks if a value is greater</td></tr><tr><th><a href="datum/skill.html#proc/sanitize_value">sanitize_value</a></th><td>Ensures what someone's setting as a value for this skill is valid.</td></tr><tr><th><a href="datum/skill.html#proc/set_skill_value">set_skill_value</a></th><td>Sets the new value of this skill in the holder skills list.
|
||
As well as possible feedback messages or secondary effects on value change, that's on you.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/abstract_type"><aside class="declaration">var </aside>abstract_type <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L27"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 27"></a></h3><p>Abstract type</p><h3 id="var/base_multiplier"><aside class="declaration">var </aside>base_multiplier <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L33"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 33"></a></h3><p>Base multiplier used in skill competency operations.</p><h3 id="var/competency_multiplier"><aside class="declaration">var </aside>competency_multiplier <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L35"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 35"></a></h3><p>Value added to the base multiplier depending on overall competency compared to maximum value/level.</p><h3 id="var/competency_thresholds"><aside class="declaration">var </aside>competency_thresholds <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L31"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 31"></a></h3><p>skill threshold used in generic skill competency operations.</p><h3 id="var/desc"><aside class="declaration">var </aside>desc <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L21"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 21"></a></h3><p>Our description</p><h3 id="var/item_skill_gain_multi"><aside class="declaration">var </aside>item_skill_gain_multi <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L37"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 37"></a></h3><p>Experience gain multiplier gained from using items.</p><h3 id="var/max_levels"><aside class="declaration">var </aside>max_levels <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L29"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 29"></a></h3><p>List of max levels. Only used in level skills, but present here for helper macros.</p><h3 id="var/name"><aside class="declaration">var </aside>name <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L19"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 19"></a></h3><p>Our name</p><h3 id="var/name_color"><aside class="declaration">var </aside>name_color <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L23"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 23"></a></h3><p>Color of the name as shown in the html readout</p><h3 id="var/progression_type"><aside class="declaration">var </aside>progression_type <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L25"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 25"></a></h3><p>Our progression type. These are mostly used to skip typechecks overhead, don't go around messing with these.</p><h3 id="var/skill_gain_quantisation"><aside class="declaration">var </aside>skill_gain_quantisation <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L39"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 39"></a></h3><p>Skill gain quantisation</p><h3 id="var/skill_traits"><aside class="declaration">var </aside>skill_traits <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L41"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 41"></a></h3><p>A list of ways this skill can affect or be affected through actions and skill modifiers.</p><h3 id="var/ui_category"><aside class="declaration">var </aside>ui_category <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L43"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 43"></a></h3><p>Index of this skill in the UI</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_skill_data"><aside class="declaration">proc </aside>get_skill_data<aside>(/<a href="datum.html">datum</a>/<a href="datum/skill_holder.html">skill_holder</a>/H) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L69"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 69"></a></aside></h3><p>Get a list of data used in the skill panel menu.</p><h3 id="proc/is_value_greater"><aside class="declaration">proc </aside>is_value_greater<aside>(existing, new_value) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L61"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 61"></a></aside></h3><p>Checks if a value is greater</p><h3 id="proc/sanitize_value"><aside class="declaration">proc </aside>sanitize_value<aside>(new_value) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L48"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 48"></a></aside></h3><p>Ensures what someone's setting as a value for this skill is valid.</p><h3 id="proc/set_skill_value"><aside class="declaration">proc </aside>set_skill_value<aside>(/<a href="datum.html">datum</a>/<a href="datum/skill_holder.html">skill_holder</a>/H, value, /<a href="mob.html">mob</a>/owner) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/skills/_skill.dm#L55"><img src="git.png" width="16" height="16" title="code/datums/skills/_skill.dm 55"></a></aside></h3><p>Sets the new value of this skill in the holder skills list.
|
||
As well as possible feedback messages or secondary effects on value change, that's on you.</p></main><footer>tgstation.dme <a href="https://github.com/evilew/GS13-Citadel/tree/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e">e8e0068</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.9.0</a></footer></body></html> |