sheepishgoat
1 line
4.8 KiB
HTML
1 line
4.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/award - /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/award.html#var">Var Details</a> - <a href="datum/award.html#proc">Proc Details</a></header><main><h1>award <aside>/<a href="datum.html">datum</a>/<a href="datum/award.html">award</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_awards.dm#L1"><img src="git.png" width="16" height="16" title="code/datums/achievements/_awards.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/award.html#var/database_id">database_id</a></th><td>What ID do we use in db, limited to 32 characters</td></tr><tr><th><a href="datum/award.html#var/icon">icon</a></th><td>Found in ui_icons/achievements</td></tr><tr><th><a href="datum/award.html#var/name">name</a></th><td>Name of the achievement, If null it won't show up in the achievement browser. (Handy for inheritance trees)</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/award.html#proc/get_changed_rows">get_changed_rows</a></th><td>This saves the changed data to the hub.</td></tr><tr><th><a href="datum/award.html#proc/get_raw_value">get_raw_value</a></th><td>Get raw numerical achievement value from the database</td></tr><tr><th><a href="datum/award.html#proc/load">load</a></th><td>This proc loads the achievement data from the hub.</td></tr><tr><th><a href="datum/award.html#proc/on_unlock">on_unlock</a></th><td>Can be overriden for achievement specific events</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/database_id"><aside class="declaration">var </aside>database_id <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_awards.dm#L10"><img src="git.png" width="16" height="16" title="code/datums/achievements/_awards.dm 10"></a></h3><p>What ID do we use in db, limited to 32 characters</p><h3 id="var/icon"><aside class="declaration">var </aside>icon <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_awards.dm#L6"><img src="git.png" width="16" height="16" title="code/datums/achievements/_awards.dm 6"></a></h3><p>Found in ui_icons/achievements</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/achievements/_awards.dm#L3"><img src="git.png" width="16" height="16" title="code/datums/achievements/_awards.dm 3"></a></h3><p>Name of the achievement, If null it won't show up in the achievement browser. (Handy for inheritance trees)</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_changed_rows"><aside class="declaration">proc </aside>get_changed_rows<aside>(key, value) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_awards.dm#L27"><img src="git.png" width="16" height="16" title="code/datums/achievements/_awards.dm 27"></a></aside></h3><p>This saves the changed data to the hub.</p><h3 id="proc/get_raw_value"><aside class="declaration">proc </aside>get_raw_value<aside>(key) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_awards.dm#L46"><img src="git.png" width="16" height="16" title="code/datums/achievements/_awards.dm 46"></a></aside></h3><p>Get raw numerical achievement value from the database</p><h3 id="proc/load"><aside class="declaration">proc </aside>load<aside>(key) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_awards.dm#L18"><img src="git.png" width="16" height="16" title="code/datums/achievements/_awards.dm 18"></a></aside></h3><p>This proc loads the achievement data from the hub.</p><h3 id="proc/on_unlock"><aside class="declaration">proc </aside>on_unlock<aside>(/<a href="mob.html">mob</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_awards.dm#L65"><img src="git.png" width="16" height="16" title="code/datums/achievements/_awards.dm 65"></a></aside></h3><p>Can be overriden for achievement specific events</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> |