sheepishgoat
1 line
6.5 KiB
HTML
1 line
6.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/achievement_data - /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/achievement_data.html#var">Var Details</a> - <a href="datum/achievement_data.html#proc">Proc Details</a></header><main><h1>achievement_data <aside>/<a href="datum.html">datum</a>/<a href="datum/achievement_data.html">achievement_data</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L2"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 2"></a></h1><p>Datum that handles</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/achievement_data.html#var/data">data</a></th><td>Up to date list of all achievements and their info.</td></tr><tr><th><a href="datum/achievement_data.html#var/initialized">initialized</a></th><td>Have we done our set-up yet?</td></tr><tr><th><a href="datum/achievement_data.html#var/original_cached_data">original_cached_data</a></th><td>Original status of achievement.</td></tr><tr><th><a href="datum/achievement_data.html#var/owner_ckey">owner_ckey</a></th><td>Ckey of this achievement data's owner</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/achievement_data.html#proc/get_achievement_status">get_achievement_status</a></th><td>Getter for the status/score of an achievement</td></tr><tr><th><a href="datum/achievement_data.html#proc/get_changed_data">get_changed_data</a></th><td>Gets list of changed rows in MassInsert format</td></tr><tr><th><a href="datum/achievement_data.html#proc/get_data">get_data</a></th><td>Updates local cache with db data for the given achievement type if it wasn't loaded yet.</td></tr><tr><th><a href="datum/achievement_data.html#proc/reset">reset</a></th><td>Resets an achievement to default values.</td></tr><tr><th><a href="datum/achievement_data.html#proc/unlock">unlock</a></th><td>Unlocks an achievement of a specific type. achievement type is a typepath to the award, user is the mob getting the award, and value is an optional value to be used for defining a score to add to the leaderboard</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/data"><aside class="declaration">var </aside>data <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L6"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 6"></a></h3><p>Up to date list of all achievements and their info.</p><h3 id="var/initialized"><aside class="declaration">var </aside>initialized <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L10"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 10"></a></h3><p>Have we done our set-up yet?</p><h3 id="var/original_cached_data"><aside class="declaration">var </aside>original_cached_data <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L8"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 8"></a></h3><p>Original status of achievement.</p><h3 id="var/owner_ckey"><aside class="declaration">var </aside>owner_ckey <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L4"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 4"></a></h3><p>Ckey of this achievement data's owner</p><h2 id="proc">Proc Details</h2><h3 id="proc/get_achievement_status"><aside class="declaration">proc </aside>get_achievement_status<aside>(achievement_type) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L82"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 82"></a></aside></h3><p>Getter for the status/score of an achievement</p><h3 id="proc/get_changed_data"><aside class="declaration">proc </aside>get_changed_data<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L22"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 22"></a></aside></h3><p>Gets list of changed rows in MassInsert format</p><h3 id="proc/get_data"><aside class="declaration">proc </aside>get_data<aside>(achievement_type) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L57"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 57"></a></aside></h3><p>Updates local cache with db data for the given achievement type if it wasn't loaded yet.</p><h3 id="proc/reset"><aside class="declaration">proc </aside>reset<aside>(achievement_type) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L86"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 86"></a></aside></h3><p>Resets an achievement to default values.</p><h3 id="proc/unlock"><aside class="declaration">proc </aside>unlock<aside>(achievement_type, /<a href="mob.html">mob</a>/user, value) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/datums/achievements/_achievement_data.dm#L66"><img src="git.png" width="16" height="16" title="code/datums/achievements/_achievement_data.dm 66"></a></aside></h3><p>Unlocks an achievement of a specific type. achievement type is a typepath to the award, user is the mob getting the award, and value is an optional value to be used for defining a score to add to the leaderboard</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> |