Files
Paradise/datum/character_save.html

13 lines
8.5 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>/datum/character_save - 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/character_save.html#var">Var Details</a> - <a href="datum/character_save.html#proc">Proc Details</a></header><main><h1>character_save <aside>/<a href="datum.html">datum</a>/<a href="datum/character_save.html">character_save</a></aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L5"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 5"></a></h1><table class="summary" cellspacing="0"><tr><td colspan="2"><h2>Vars</h2></td></tr><tr><th><a href="datum/character_save.html#var/body_accessory">body_accessory</a></th><td>The body accessory name of the mob (e.g. wings, tail).</td></tr><tr><th><a href="datum/character_save.html#var/custom_emotes">custom_emotes</a></th><td>Custom emote text (&quot;name&quot; = &quot;emote text&quot;)</td></tr><tr><th><a href="datum/character_save.html#var/cyborg_brain_type">cyborg_brain_type</a></th><td>If a spawned cyborg should have an MMI, a positronic, or a robobrain. MMI by default</td></tr><tr><th><a href="datum/character_save.html#var/from_db">from_db</a></th><td>Is this character from the DB?</td></tr><tr><th><a href="datum/character_save.html#var/pda_ringtone">pda_ringtone</a></th><td>The ringtone their PDA should start with</td></tr><tr><th><a href="datum/character_save.html#var/quirks">quirks</a></th><td>A list/JSON of the quirk datums to attach to the character</td></tr><tr><th><a href="datum/character_save.html#var/runechat_color">runechat_color</a></th><td>Runechat color</td></tr><tr><th><a href="datum/character_save.html#var/slot_number">slot_number</a></th><td>Character slot number, used for saves and stuff.</td></tr><tr><th><a href="datum/character_save.html#var/valid_save">valid_save</a></th><td>Is this character valid to be picked? This is necessary to avoid someone getting a bald human called &quot;Character 30&quot;</td></tr><tr><td colspan="2"><h2>Procs</h2></td></tr><tr><th><a href="datum/character_save.html#proc/SetChoices">SetChoices</a></th><td>limit - The amount of jobs allowed per column. Defaults to 17 to make it look nice.
splitJobs - Allows you split the table by job. You can make different tables for each department by including their heads. Defaults to CE to make it look nice.
widthPerColumn - Screen's width for every column.
height - Screen's height.
1366x768 is a common screen resolution, and increasing widthPerColumn or height to above 400 and 700,
will result in the window being placed outside the screen for these users. If we get more jobs than limit x 3, increase limit.</td></tr><tr><th><a href="datum/character_save.html#proc/load">load</a></th><td>Load in and process the database's information on the player's character save.
The order of indices here is the relative order from get_query() in 20-load-characters.dm.</td></tr></table><h2 id="var">Var Details</h2><h3 id="var/body_accessory"><aside class="declaration">var </aside>body_accessory <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L45"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 45"></a></h3><p>The body accessory name of the mob (e.g. wings, tail).</p><h3 id="var/custom_emotes"><aside class="declaration">var </aside>custom_emotes <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L108"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 108"></a></h3><p>Custom emote text (&quot;name&quot; = &quot;emote text&quot;)</p><h3 id="var/cyborg_brain_type"><aside class="declaration">var </aside>cyborg_brain_type <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L43"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 43"></a></h3><p>If a spawned cyborg should have an MMI, a positronic, or a robobrain. MMI by default</p><h3 id="var/from_db"><aside class="declaration">var </aside>from_db <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L95"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 95"></a></h3><p>Is this character from the DB?</p><h3 id="var/pda_ringtone"><aside class="declaration">var </aside>pda_ringtone <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L112"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 112"></a></h3><p>The ringtone their PDA should start with</p><h3 id="var/quirks"><aside class="declaration">var </aside>quirks <aside> /list</aside> <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L114"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 114"></a></h3><p>A list/JSON of the quirk datums to attach to the character</p><h3 id="var/runechat_color"><aside class="declaration">var </aside>runechat_color <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L110"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 110"></a></h3><p>Runechat color</p><h3 id="var/slot_number"><aside class="declaration">var </aside>slot_number <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L99"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 99"></a></h3><p>Character slot number, used for saves and stuff.</p><h3 id="var/valid_save"><aside class="declaration">var </aside>valid_save <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L97"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 97"></a></h3><p>Is this character valid to be picked? This is necessary to avoid someone getting a bald human called &quot;Character 30&quot;</p><h2 id="proc">Proc Details</h2><h3 id="proc/SetChoices"><aside class="declaration">proc </aside>SetChoices<aside>(/<a href="mob.html">mob</a>/user, limit, /list/splitJobs, widthPerColumn, height) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L2091"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 2091"></a></aside></h3><p>limit - The amount of jobs allowed per column. Defaults to 17 to make it look nice.
splitJobs - Allows you split the table by job. You can make different tables for each department by including their heads. Defaults to CE to make it look nice.
widthPerColumn - Screen's width for every column.
height - Screen's height.
1366x768 is a common screen resolution, and increasing widthPerColumn or height to above 400 and 700,
will result in the window being placed outside the screen for these users. If we get more jobs than limit x 3, increase limit.</p><h3 id="proc/load"><aside class="declaration">proc </aside>load<aside>(/<a href="datum.html">datum</a>/<a href="datum/db_query.html">db_query</a>/query) <a href="https://github.com/ParadiseSS13/Paradise/blob/edee60476d21ee840643bd1abe7f6003a8c65773/code/modules/client/preference/character.dm#L442"><img src="git.png" width="16" height="16" title="code/modules/client/preference/character.dm 442"></a></aside></h3><p>Load in and process the database's information on the player's character save.
The order of indices here is the relative order from get_query() in 20-load-characters.dm.</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>