Files
2025-02-05 06:19:18 +00:00

1 line
4.6 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/effect/mapping_helpers/custom_icon - /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/effect/mapping_helpers/custom_icon.html#var">Var Details</a></header><main><h1>custom_icon <aside>/<a href="obj.html">obj</a>/<a href="obj/effect/mapping_helpers/custom_icon.html">effect/mapping_helpers/custom_icon</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/mapping_helpers/_mapping_helpers.dm#L349"><img src="git.png" width="16" height="16" title="code/modules/mapping/mapping_helpers/_mapping_helpers.dm 349"></a></h1><p>Fetches an external dmi and applies to the target object</p><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/effect/mapping_helpers/custom_icon.html#var/first_match_only">first_match_only</a></th><td>Will inject into all fitting the criteria if false, otherwise first found.</td></tr><tr><th><a href="obj/effect/mapping_helpers/custom_icon.html#var/icon_url">icon_url</a></th><td>This should return raw dmi in response to http get request. For example: &quot;https://github.com/tgstation/SS13-sprites/raw/master/mob/medu.dmi?raw=true&quot;</td></tr><tr><th><a href="obj/effect/mapping_helpers/custom_icon.html#var/target_name">target_name</a></th><td>Will inject into atoms with this name.</td></tr><tr><th><a href="obj/effect/mapping_helpers/custom_icon.html#var/target_type">target_type</a></th><td>Will inject into atoms of this type.</td></tr><tr><th><a href="obj/effect/mapping_helpers/custom_icon.html#var/target_variable">target_variable</a></th><td>This is the var tha will be set with the fetched icon. In case you want to set some secondary icon sheets like inhands and such.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/first_match_only"><aside class="declaration">var </aside>first_match_only <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/mapping_helpers/_mapping_helpers.dm#L354"><img src="git.png" width="16" height="16" title="code/modules/mapping/mapping_helpers/_mapping_helpers.dm 354"></a></h3><p>Will inject into all fitting the criteria if false, otherwise first found.</p><h3 id="var/icon_url"><aside class="declaration">var </aside>icon_url <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/mapping_helpers/_mapping_helpers.dm#L364"><img src="git.png" width="16" height="16" title="code/modules/mapping/mapping_helpers/_mapping_helpers.dm 364"></a></h3><p>This should return raw dmi in response to http get request. For example: &quot;https://github.com/tgstation/SS13-sprites/raw/master/mob/medu.dmi?raw=true&quot;</p><h3 id="var/target_name"><aside class="declaration">var </aside>target_name <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/mapping_helpers/_mapping_helpers.dm#L358"><img src="git.png" width="16" height="16" title="code/modules/mapping/mapping_helpers/_mapping_helpers.dm 358"></a></h3><p>Will inject into atoms with this name.</p><h3 id="var/target_type"><aside class="declaration">var </aside>target_type <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/mapping_helpers/_mapping_helpers.dm#L356"><img src="git.png" width="16" height="16" title="code/modules/mapping/mapping_helpers/_mapping_helpers.dm 356"></a></h3><p>Will inject into atoms of this type.</p><h3 id="var/target_variable"><aside class="declaration">var </aside>target_variable <aside> </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/mapping/mapping_helpers/_mapping_helpers.dm#L360"><img src="git.png" width="16" height="16" title="code/modules/mapping/mapping_helpers/_mapping_helpers.dm 360"></a></h3><p>This is the var tha will be set with the fetched icon. In case you want to set some secondary icon sheets like inhands and such.</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>