mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-08-26 13:37:58 +01:00
1 line
10 KiB
HTML
1 line
10 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/structure/closet - 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/closet.html#var">Var Details</a> - <a href="obj/structure/closet.html#proc">Proc Details</a></header><main><h1>closet <aside>/<a href="obj.html">obj</a>/<a href="obj/structure.html">structure</a>/<a href="obj/structure/closet.html">closet</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L1"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/structure/closet.html#var/closed_door_sprite">closed_door_sprite</a></th><td>Overwrites icon_state for the closed door sprite. Only necessary if the closed door sprite has a different name than the icon_state.</td></tr><tr><th><a href="obj/structure/closet.html#var/custom_skin">custom_skin</a></th><td>Added to initial(icon_state) if not null. Used for IC customization, e.g. when painting cardboard boxes.</td></tr><tr><th><a href="obj/structure/closet.html#var/door_anim_angle">door_anim_angle</a></th><td>The maximum angle the door will be drawn at</td></tr><tr><th><a href="obj/structure/closet.html#var/door_anim_squish">door_anim_squish</a></th><td>Vertical squish of the door</td></tr><tr><th><a href="obj/structure/closet.html#var/door_anim_time">door_anim_time</a></th><td>Amount of time it takes for the door animation to play</td></tr><tr><th><a href="obj/structure/closet.html#var/door_hinge_x">door_hinge_x</a></th><td>X position of the closet door hinge</td></tr><tr><th><a href="obj/structure/closet.html#var/door_obj">door_obj</a></th><td>The overlay for the closet's door</td></tr><tr><th><a href="obj/structure/closet.html#var/enable_door_overlay">enable_door_overlay</a></th><td>Whether this closet uses a door overlay at all. If <code>FALSE</code>, it'll switch to a system where the entire icon_state is replaced with <code>[icon_state]_open</code> instead.</td></tr><tr><th><a href="obj/structure/closet.html#var/has_closed_overlay">has_closed_overlay</a></th><td>Whether this closet uses a door overlay for when it is closed</td></tr><tr><th><a href="obj/structure/closet.html#var/has_opened_overlay">has_opened_overlay</a></th><td>Whether this closet uses a door overlay for when it is opened</td></tr><tr><th><a href="obj/structure/closet.html#var/is_animating_door">is_animating_door</a></th><td>Whether or not this door is being animated</td></tr><tr><th><a href="obj/structure/closet.html#var/opened_door_sprite">opened_door_sprite</a></th><td>Overwrites icon_state for the opened door sprite. Only necessary if the opened door sprite has a different name than the icon_state.</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/structure/closet.html#proc/animate_door">animate_door</a></th><td>Animates the closet door opening and closing</td></tr><tr><th><a href="obj/structure/closet.html#proc/end_door_animation">end_door_animation</a></th><td>Ends the door animation and removes the animated overlay</td></tr><tr><th><a href="obj/structure/closet.html#proc/get_door_transform">get_door_transform</a></th><td>Calculates the matrix to be applied to the animated door overlay</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/closed_door_sprite"><aside class="declaration">var </aside>closed_door_sprite <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L15"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 15"></a></h3><p>Overwrites icon_state for the closed door sprite. Only necessary if the closed door sprite has a different name than the icon_state.</p><h3 id="var/custom_skin"><aside class="declaration">var </aside>custom_skin <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L17"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 17"></a></h3><p>Added to initial(icon_state) if not null. Used for IC customization, e.g. when painting cardboard boxes.</p><h3 id="var/door_anim_angle"><aside class="declaration">var </aside>door_anim_angle <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L42"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 42"></a></h3><p>The maximum angle the door will be drawn at</p><h3 id="var/door_anim_squish"><aside class="declaration">var </aside>door_anim_squish <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L40"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 40"></a></h3><p>Vertical squish of the door</p><h3 id="var/door_anim_time"><aside class="declaration">var </aside>door_anim_time <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L46"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 46"></a></h3><p>Amount of time it takes for the door animation to play</p><h3 id="var/door_hinge_x"><aside class="declaration">var </aside>door_hinge_x <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L44"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 44"></a></h3><p>X position of the closet door hinge</p><h3 id="var/door_obj"><aside class="declaration">var </aside>door_obj <aside>– /<a href="obj.html">obj</a>/effect/overlay/closet_door</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L36"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 36"></a></h3><p>The overlay for the closet's door</p><h3 id="var/enable_door_overlay"><aside class="declaration">var </aside>enable_door_overlay <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L48"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 48"></a></h3><p>Whether this closet uses a door overlay at all. If <code>FALSE</code>, it'll switch to a system where the entire icon_state is replaced with <code>[icon_state]_open</code> instead.</p><h3 id="var/has_closed_overlay"><aside class="declaration">var </aside>has_closed_overlay <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L52"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 52"></a></h3><p>Whether this closet uses a door overlay for when it is closed</p><h3 id="var/has_opened_overlay"><aside class="declaration">var </aside>has_opened_overlay <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L50"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 50"></a></h3><p>Whether this closet uses a door overlay for when it is opened</p><h3 id="var/is_animating_door"><aside class="declaration">var </aside>is_animating_door <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L38"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 38"></a></h3><p>Whether or not this door is being animated</p><h3 id="var/opened_door_sprite"><aside class="declaration">var </aside>opened_door_sprite <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L13"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 13"></a></h3><p>Overwrites icon_state for the opened door sprite. Only necessary if the opened door sprite has a different name than the icon_state.</p><h2 id="proc">Proc Details</h2><h3 id="proc/animate_door"><aside class="declaration">proc </aside>animate_door<aside>(closing) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L99"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 99"></a></aside></h3><p>Animates the closet door opening and closing</p><h3 id="proc/end_door_animation"><aside class="declaration">proc </aside>end_door_animation<aside>() <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L135"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 135"></a></aside></h3><p>Ends the door animation and removes the animated overlay</p><h3 id="proc/get_door_transform"><aside class="declaration">proc </aside>get_door_transform<aside>(angle) <a href="https://github.com/ParadiseSS13/Paradise/blob/8a8a00a2a9bec485351e5f219982b7315d3504fa/code/game/objects/structures/crates_lockers/closets.dm#L142"><img src="git.png" width="16" height="16" title="code/game/objects/structures/crates_lockers/closets.dm 142"></a></aside></h3><p>Calculates the matrix to be applied to the animated door overlay</p></main><footer>paradise.dme <a href="https://github.com/ParadiseSS13/Paradise/tree/8a8a00a2a9bec485351e5f219982b7315d3504fa">8a8a00a</a> (master) — <a href="https://github.com/SpaceManiac/SpacemanDMM/blob/master/crates/dmdoc/README.md">dmdoc 1.11.0</a></footer></body></html> |