Files

5 lines
7.9 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/structure/uplifted_primitive/nest - 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="obj/structure/uplifted_primitive/nest.html#var">Var Details</a> - <a href="obj/structure/uplifted_primitive/nest.html#proc">Proc Details</a></header><main><h1>nest <aside>/<a href="obj.html">obj</a>/<a href="obj/structure.html">structure</a>/<a href="obj/structure/uplifted_primitive/nest.html">uplifted_primitive/nest</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L22"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 22"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#var/available_food">available_food</a></th><td>The amount of food currently stored in the nest.</td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#var/available_scrap">available_scrap</a></th><td>The amount of scrap (recycled materials) currently stored in the nest.</td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#var/crafting_items">crafting_items</a></th><td>The mapping between the path of a crafting output and a list containing
its scrap and food costs, and an optional argument to be passed to new().</td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#var/nest_species">nest_species</a></th><td>The species of lesser human to spawn.</td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#var/on_demand_spawner">on_demand_spawner</a></th><td>The spawner used to let ghosts spawn without a roll. If null, the nest is not in on demand mode.</td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#var/sentient_probability">sentient_probability</a></th><td>The probability that the next spawned mob will be sentient.</td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#var/spawn_cooldown">spawn_cooldown</a></th><td>The cooldown between successfully spawning new mobs.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#proc/count_spawn_limit">count_spawn_limit</a></th><td>Returns the number of mobs currently contributing to the spawn limit.
Currently, any NPC human with the same species as the nest and a monkey ai controller within range is counted.</td></tr><tr><th><a href="obj/structure/uplifted_primitive/nest.html#proc/try_spawn_uplifted">try_spawn_uplifted</a></th><td>Returns TRUE if a new player mob was successfully spawned, otherwise FALSE.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/available_food"><aside class="declaration">var </aside>available_food <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L35"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 35"></a></h3><p>The amount of food currently stored in the nest.</p><h3 id="var/available_scrap"><aside class="declaration">var </aside>available_scrap <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L32"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 32"></a></h3><p>The amount of scrap (recycled materials) currently stored in the nest.</p><h3 id="var/crafting_items"><aside class="declaration">var </aside>crafting_items <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L48"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 48"></a></h3><p>The mapping between the path of a crafting output and a list containing
its scrap and food costs, and an optional argument to be passed to new().</p><h3 id="var/nest_species"><aside class="declaration">var </aside>nest_species <aside> /<a href="datum.html">datum</a>/<a href="datum/species.html">species</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L29"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 29"></a></h3><p>The species of lesser human to spawn.</p><h3 id="var/on_demand_spawner"><aside class="declaration">var </aside>on_demand_spawner <aside> /<a href="obj.html">obj</a>/<a href="obj/effect/mob_spawn.html">effect/mob_spawn</a>/uplifted_primitive</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L44"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 44"></a></h3><p>The spawner used to let ghosts spawn without a roll. If null, the nest is not in on demand mode.</p><h3 id="var/sentient_probability"><aside class="declaration">var </aside>sentient_probability <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L41"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 41"></a></h3><p>The probability that the next spawned mob will be sentient.</p><h3 id="var/spawn_cooldown"><aside class="declaration">var </aside>spawn_cooldown <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L38"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 38"></a></h3><p>The cooldown between successfully spawning new mobs.</p><h2 id="proc">Proc Details</h2><h3 id="proc/count_spawn_limit"><aside class="declaration">proc </aside>count_spawn_limit<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L167"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 167"></a></aside></h3><p>Returns the number of mobs currently contributing to the spawn limit.
Currently, any NPC human with the same species as the nest and a monkey ai controller within range is counted.</p><h3 id="proc/try_spawn_uplifted"><aside class="declaration">proc </aside>try_spawn_uplifted<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/776b9861f70566b1e6a0763a465ef22f7920a3d6/code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm#L140"><img src="git.png" width="16" height="16" title="code/game/gamemodes/miniantags/uplifted_primitive/uplifted_primitive_nest.dm 140"></a></aside></h3><p>Returns TRUE if a new player mob was successfully spawned, otherwise FALSE.</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/776b9861f70566b1e6a0763a465ef22f7920a3d6">776b986</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html>