sheepishgoat
1 line
5.4 KiB
HTML
1 line
5.4 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/item/gang_induction_package - /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="obj/item/gang_induction_package.html#var">Var Details</a> - <a href="obj/item/gang_induction_package.html#proc">Proc Details</a></header><main><h1>gang_induction_package <aside>/<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/<a href="obj/item/gang_induction_package.html">gang_induction_package</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/gang/induction_package.dm#L1"><img src="git.png" width="16" height="16" title="code/modules/antagonists/gang/induction_package.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/item/gang_induction_package.html#var/gang_to_use">gang_to_use</a></th><td>The typepath of the gang antagonist datum that the person who uses the package should have added to them -- remember that the distinction between e.g. Ballas and Grove Street is on the antag datum level, not the team datum level.</td></tr><tr><th><a href="obj/item/gang_induction_package.html#var/handler">handler</a></th><td>References the active families gamemode handler (if one exists), for adding new family members to.</td></tr><tr><th><a href="obj/item/gang_induction_package.html#var/team_to_use">team_to_use</a></th><td>The team datum that the person who uses this package should be added to.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/item/gang_induction_package.html#proc/add_to_gang">add_to_gang</a></th><td>Adds the user to the family that this package corresponds to, dispenses the free_clothes of that family, and adds them to the handler if it exists.</td></tr><tr><th><a href="obj/item/gang_induction_package.html#proc/attempt_join_gang">attempt_join_gang</a></th><td>Checks if the user is trying to use the package of the family they are in, and if not, adds them to the family, with some differing processing depending on whether the user is already a family member.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/gang_to_use"><aside class="declaration">var </aside>gang_to_use <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/gang/induction_package.dm#L8"><img src="git.png" width="16" height="16" title="code/modules/antagonists/gang/induction_package.dm 8"></a></h3><p>The typepath of the gang antagonist datum that the person who uses the package should have added to them -- remember that the distinction between e.g. Ballas and Grove Street is on the antag datum level, not the team datum level.</p><h3 id="var/handler"><aside class="declaration">var </aside>handler <aside>– /<a href="datum.html">datum</a>/<a href="datum/gang_handler.html">gang_handler</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/gang/induction_package.dm#L6"><img src="git.png" width="16" height="16" title="code/modules/antagonists/gang/induction_package.dm 6"></a></h3><p>References the active families gamemode handler (if one exists), for adding new family members to.</p><h3 id="var/team_to_use"><aside class="declaration">var </aside>team_to_use <aside>– /<a href="datum.html">datum</a>/<a href="datum/team/gang.html">team/gang</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/gang/induction_package.dm#L13"><img src="git.png" width="16" height="16" title="code/modules/antagonists/gang/induction_package.dm 13"></a></h3><p>The team datum that the person who uses this package should be added to.</p><h2 id="proc">Proc Details</h2><h3 id="proc/add_to_gang"><aside class="declaration">proc </aside>add_to_gang<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/user, original_name) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/gang/induction_package.dm#L34"><img src="git.png" width="16" height="16" title="code/modules/antagonists/gang/induction_package.dm 34"></a></aside></h3><p>Adds the user to the family that this package corresponds to, dispenses the free_clothes of that family, and adds them to the handler if it exists.</p><h3 id="proc/attempt_join_gang"><aside class="declaration">proc </aside>attempt_join_gang<aside>(/<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/user) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/antagonists/gang/induction_package.dm#L54"><img src="git.png" width="16" height="16" title="code/modules/antagonists/gang/induction_package.dm 54"></a></aside></h3><p>Checks if the user is trying to use the package of the family they are in, and if not, adds them to the family, with some differing processing depending on whether the user is already a family member.</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> |