mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-28 14:37:04 +01:00
14 lines
5.6 KiB
HTML
14 lines
5.6 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/rep_purchase - Space Station 13</title></head><body><header><a href="index.html">Space Station 13</a> - <a href="index.html#modules">Modules</a> - <a href="index.html#types">Types</a> — <a href="datum/rep_purchase.html#var">Var Details</a> - <a href="datum/rep_purchase.html#proc">Proc Details</a></header><main><h1>Rep Purchase <aside>/<a href="datum.html">datum</a>/<a href="datum/rep_purchase.html">rep_purchase</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm#L6"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm 6"></a></h1><p>Describes something that can be purchased with Contractor Rep.</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/rep_purchase.html#var/cost">cost</a></th><td>The price in Contractor Rep of the purchase.</td></tr><tr><th><a href="datum/rep_purchase.html#var/description">description</a></th><td>The description of the purchase.</td></tr><tr><th><a href="datum/rep_purchase.html#var/name">name</a></th><td>The display name of the purchase.</td></tr><tr><th><a href="datum/rep_purchase.html#var/stock">stock</a></th><td>How many times the purchase can be made.
|
|
-1 means infinite stock.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/rep_purchase.html#proc/buy">buy</a></th><td>Attempts to perform the purchase.</td></tr><tr><th><a href="datum/rep_purchase.html#proc/on_buy">on_buy</a></th><td>Called when the purchase was made successfully.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/cost"><aside class="declaration">var </aside>cost <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm#L12"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm 12"></a></h3><p>The price in Contractor Rep of the purchase.</p><h3 id="var/description"><aside class="declaration">var </aside>description <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm#L10"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm 10"></a></h3><p>The description of the purchase.</p><h3 id="var/name"><aside class="declaration">var </aside>name <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm#L8"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm 8"></a></h3><p>The display name of the purchase.</p><h3 id="var/stock"><aside class="declaration">var </aside>stock <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm#L15"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm 15"></a></h3><p>How many times the purchase can be made.
|
|
-1 means infinite stock.</p><h2 id="proc">Proc Details</h2><h3 id="proc/buy"><aside class="declaration">proc </aside>buy<aside>(/<a href="datum.html">datum</a>/<a href="datum/contractor_hub.html">contractor_hub</a>/hub, /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/<a href="mob/living/carbon/human.html">human</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm#L26"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm 26"></a></aside></h3><p>Attempts to perform the purchase.</p>
|
|
<p>Returns TRUE or FALSE depending on whether the purchase succeeded.</p>
|
|
<p>Arguments:</p>
|
|
<ul>
|
|
<li>hub - The contractor hub.</li>
|
|
<li>user - The user who is making the purchase.</li>
|
|
</ul><h3 id="proc/on_buy"><aside class="declaration">proc </aside>on_buy<aside>(/<a href="datum.html">datum</a>/<a href="datum/contractor_hub.html">contractor_hub</a>/hub, /<a href="mob.html">mob</a>/<a href="mob/living.html">living</a>/<a href="mob/living/carbon.html">carbon</a>/<a href="mob/living/carbon/human.html">human</a>/user) <a href="https://github.com/ParadiseSS13/Paradise/blob/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7/code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm#L50"><img src="git.png" width="16" height="16" title="code/modules/antagonists/traitor/contractor/datums/rep_purchases/rep_purchase_base.dm 50"></a></aside></h3><p>Called when the purchase was made successfully.</p>
|
|
<p>Arguments:</p>
|
|
<ul>
|
|
<li>hub - The contractor hub.</li>
|
|
<li>user - The user who made the purchase.</li>
|
|
</ul></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/c8dfcdac13f08c689c3a1cf77d6f1a90087d1dd7">c8dfcda</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html> |