mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-30 15:37:36 +01:00
5 lines
4.9 KiB
HTML
5 lines
4.9 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/datum/ore - 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/ore.html#var">Var Details</a> - <a href="datum/ore.html#proc">Proc Details</a></header><main><h1>ore <aside>/<a href="datum.html">datum</a>/<a href="datum/ore.html">ore</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/datums/ores.dm#L1"><img src="git.png" width="16" height="16" title="code/datums/ores.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/ore.html#var/drop_max">drop_max</a></th><td>The upper bound for the amount of randomized ore dropped.</td></tr><tr><th><a href="datum/ore.html#var/drop_min">drop_min</a></th><td>The lower bound for the amount of randomized ore dropped.</td></tr><tr><th><a href="datum/ore.html#var/drop_type">drop_type</a></th><td>The type of ore that is dropped. Expected to be a subtype of <a href="obj/item/stack.html" title="/obj/item/stack">/obj/item/stack/ore</a>.</td></tr><tr><th><a href="datum/ore.html#var/scan_icon_state">scan_icon_state</a></th><td>The icon state of the ore used for mining scanner overlays.</td></tr><tr><th><a href="datum/ore.html#var/spread_chance">spread_chance</a></th><td>The probability that the ore will spread to nearby <a href="turf/simulated/mineral.html" title="/turf/simulated/mineral">/turf/simulated/mineral</a>s when placed.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/ore.html#proc/on_mine">on_mine</a></th><td>Called when the containing turf is "mined", such as with a pickaxe or other
|
|
digging implement.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/drop_max"><aside class="declaration">var </aside>drop_max <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/datums/ores.dm#L7"><img src="git.png" width="16" height="16" title="code/datums/ores.dm 7"></a></h3><p>The upper bound for the amount of randomized ore dropped.</p><h3 id="var/drop_min"><aside class="declaration">var </aside>drop_min <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/datums/ores.dm#L5"><img src="git.png" width="16" height="16" title="code/datums/ores.dm 5"></a></h3><p>The lower bound for the amount of randomized ore dropped.</p><h3 id="var/drop_type"><aside class="declaration">var </aside>drop_type <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/datums/ores.dm#L3"><img src="git.png" width="16" height="16" title="code/datums/ores.dm 3"></a></h3><p>The type of ore that is dropped. Expected to be a subtype of <a href="obj/item/stack.html" title="/obj/item/stack">/obj/item/stack/ore</a>.</p><h3 id="var/scan_icon_state"><aside class="declaration">var </aside>scan_icon_state <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/datums/ores.dm#L11"><img src="git.png" width="16" height="16" title="code/datums/ores.dm 11"></a></h3><p>The icon state of the ore used for mining scanner overlays.</p><h3 id="var/spread_chance"><aside class="declaration">var </aside>spread_chance <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/datums/ores.dm#L9"><img src="git.png" width="16" height="16" title="code/datums/ores.dm 9"></a></h3><p>The probability that the ore will spread to nearby <a href="turf/simulated/mineral.html" title="/turf/simulated/mineral">/turf/simulated/mineral</a>s when placed.</p><h2 id="proc">Proc Details</h2><h3 id="proc/on_mine"><aside class="declaration">proc </aside>on_mine<aside>(/<a href="turf.html">turf</a>/source, /<a href="mob.html">mob</a>/user, triggered_by_explosion, productivity_mod) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/datums/ores.dm#L20"><img src="git.png" width="16" height="16" title="code/datums/ores.dm 20"></a></aside></h3><p>Called when the containing turf is "mined", such as with a pickaxe or other
|
|
digging implement.</p>
|
|
<p>Returns <a href="code/__DEFINES/turfs.html#define/MINERAL_ALLOW_DIG" title="MINERAL_ALLOW_DIG">MINERAL_ALLOW_DIG</a> if the containing turf should be changed to its
|
|
"dug" state, <a href="code/__DEFINES/turfs.html#define/MINERAL_PREVENT_DIG" title="MINERAL_PREVENT_DIG">MINERAL_PREVENT_DIG</a> if it should remain as is.</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/edee60476d21ee840643bd1abe7f6003a8c65773">edee604</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html> |