sheepishgoat
5 lines
11 KiB
HTML
5 lines
11 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><base href="../"><link rel="stylesheet" href="dmdoc.css"><title>/obj/vehicle - /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/vehicle.html#var">Var Details</a> - <a href="obj/vehicle.html#proc">Proc Details</a></header><main><h1>vehicle <aside>/<a href="obj.html">obj</a>/<a href="obj/vehicle.html">vehicle</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L1"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 1"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="obj/vehicle.html#var/autogrant_actions_controller">autogrant_actions_controller</a></th><td>Assoc list "[bitflag]" = list(typepaths)</td></tr><tr><th><a href="obj/vehicle.html#var/autogrant_actions_passenger">autogrant_actions_passenger</a></th><td>Plain list of typepaths</td></tr><tr><th><a href="obj/vehicle.html#var/canmove">canmove</a></th><td>Whether the vehicle is currently able to move</td></tr><tr><th><a href="obj/vehicle.html#var/default_driver_move">default_driver_move</a></th><td>Handle driver movement instead of letting something else do it like riding datums.</td></tr><tr><th><a href="obj/vehicle.html#var/emulate_door_bumps">emulate_door_bumps</a></th><td>When bumping a door try to make occupants bump them to open them.</td></tr><tr><th><a href="obj/vehicle.html#var/enclosed">enclosed</a></th><td>Is the rider protected from bullets? assume no</td></tr><tr><th><a href="obj/vehicle.html#var/inserted_key">inserted_key</a></th><td>The inserted key, needed on some vehicles to start the engine</td></tr><tr><th><a href="obj/vehicle.html#var/key_type">key_type</a></th><td>If the driver needs a certain item in hand (or inserted, for vehicles) to drive this. For vehicles, this must be duplicated on their riding component subtype
|
||
[/datum/component/riding/var/keytype] variable because only a few specific checks are handled here with this var, and the majority of it is on the riding component
|
||
Eventually the remaining checks should be moved to the component and this var removed.</td></tr><tr><th><a href="obj/vehicle.html#var/key_type_exact">key_type_exact</a></th><td>Can subtypes of this key work</td></tr><tr><th><a href="obj/vehicle.html#var/max_drivers">max_drivers</a></th><td>Maximum amount of drivers</td></tr><tr><th><a href="obj/vehicle.html#var/mouse_pointer">mouse_pointer</a></th><td>Do we have a special mouse</td></tr><tr><th><a href="obj/vehicle.html#var/occupant_actions">occupant_actions</a></th><td>Assoc list mob = list(type = action datum assigned to mob)</td></tr><tr><th><a href="obj/vehicle.html#var/occupants">occupants</a></th><td>mob = bitflags of their control level.</td></tr><tr><th><a href="obj/vehicle.html#var/trailer">trailer</a></th><td>This vehicle will follow us when we move (like atrailer duh)</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="obj/vehicle.html#proc/add_trailer">add_trailer</a></th><td>To add a trailer to the vehicle in a manner that allows safe qdels</td></tr><tr><th><a href="obj/vehicle.html#proc/generate_integrity_message">generate_integrity_message</a></th><td>Returns a readable string of the vehicle's health for examining. Overridden by subtypes who want to be more verbose with their health messages.</td></tr><tr><th><a href="obj/vehicle.html#proc/remove_trailer">remove_trailer</a></th><td>To remove a trailer from the vehicle in a manner that allows safe qdels</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/autogrant_actions_controller"><aside class="declaration">var </aside>autogrant_actions_controller <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L39"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 39"></a></h3><p>Assoc list "[bitflag]" = list(typepaths)</p><h3 id="var/autogrant_actions_passenger"><aside class="declaration">var </aside>autogrant_actions_passenger <aside>– /list</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L37"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 37"></a></h3><p>Plain list of typepaths</p><h3 id="var/canmove"><aside class="declaration">var </aside>canmove <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L29"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 29"></a></h3><p>Whether the vehicle is currently able to move</p><h3 id="var/default_driver_move"><aside class="declaration">var </aside>default_driver_move <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L33"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 33"></a></h3><p>Handle driver movement instead of letting something else do it like riding datums.</p><h3 id="var/emulate_door_bumps"><aside class="declaration">var </aside>emulate_door_bumps <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L31"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 31"></a></h3><p>When bumping a door try to make occupants bump them to open them.</p><h3 id="var/enclosed"><aside class="declaration">var </aside>enclosed <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L35"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 35"></a></h3><p>Is the rider protected from bullets? assume no</p><h3 id="var/inserted_key"><aside class="declaration">var </aside>inserted_key <aside>– /<a href="obj.html">obj</a>/<a href="obj/item.html">item</a>/key</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L25"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 25"></a></h3><p>The inserted key, needed on some vehicles to start the engine</p><h3 id="var/key_type"><aside class="declaration">var </aside>key_type <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L23"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 23"></a></h3><p>If the driver needs a certain item in hand (or inserted, for vehicles) to drive this. For vehicles, this must be duplicated on their riding component subtype
|
||
[/datum/component/riding/var/keytype] variable because only a few specific checks are handled here with this var, and the majority of it is on the riding component
|
||
Eventually the remaining checks should be moved to the component and this var removed.</p><h3 id="var/key_type_exact"><aside class="declaration">var </aside>key_type_exact <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L27"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 27"></a></h3><p>Can subtypes of this key work</p><h3 id="var/max_drivers"><aside class="declaration">var </aside>max_drivers <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L15"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 15"></a></h3><p>Maximum amount of drivers</p><h3 id="var/mouse_pointer"><aside class="declaration">var </aside>mouse_pointer <aside>– </aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L47"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 47"></a></h3><p>Do we have a special mouse</p><h3 id="var/occupant_actions"><aside class="declaration">var </aside>occupant_actions <aside>– /list/mob</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L41"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 41"></a></h3><p>Assoc list mob = list(type = action datum assigned to mob)</p><h3 id="var/occupants"><aside class="declaration">var </aside>occupants <aside>– /list/mob</aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L12"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 12"></a></h3><p>mob = bitflags of their control level.</p><h3 id="var/trailer"><aside class="declaration">var </aside>trailer <aside>– /<a href="obj.html">obj</a>/<a href="obj/vehicle.html">vehicle</a></aside> <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L43"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 43"></a></h3><p>This vehicle will follow us when we move (like atrailer duh)</p><h2 id="proc">Proc Details</h2><h3 id="proc/add_trailer"><aside class="declaration">proc </aside>add_trailer<aside>(/<a href="obj.html">obj</a>/<a href="obj/vehicle.html">vehicle</a>/added_vehicle) <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L201"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 201"></a></aside></h3><p>To add a trailer to the vehicle in a manner that allows safe qdels</p><h3 id="proc/generate_integrity_message"><aside class="declaration">proc </aside>generate_integrity_message<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L62"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 62"></a></aside></h3><p>Returns a readable string of the vehicle's health for examining. Overridden by subtypes who want to be more verbose with their health messages.</p><h3 id="proc/remove_trailer"><aside class="declaration">proc </aside>remove_trailer<aside>() <a href="https://github.com/evilew/GS13-Citadel/blob/e8e0068531dd988f9e65b33ae7866d4fbf1fdd9e/code/modules/vehicles/_vehicle.dm#L206"><img src="git.png" width="16" height="16" title="code/modules/vehicles/_vehicle.dm 206"></a></aside></h3><p>To remove a trailer from the vehicle in a manner that allows safe qdels</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> |