crayon

Vars
actually_paints	If set to false, this just applies a chemical and cannot paint symbols
all_drawables	Combined lists
can_change_colour	If the user can toggle the colour, a la vanilla spraycan
charges	Number of times this item can be used, INFINITE_CHARGES for unlimited
charges_left	Number of remaining charges
crayon_color	Crayon overlay to use if placed into a crayon box
drawings	List of selectable drawing options
drawtype	Contains chosen symbol to draw
edible	Whether or not you can eat this. Doesn't mean it is a good idea to eat it.
expose_turfs	If true, sprayed turfs should also have the internal chemical applied to them
graffiti	List of selectable graffiti options If an associated value is present, the graffiti has its own cost otherwise it'll be the default value. Ditto with the other other lists below.
graffiti_large_h	List of selectable large options
has_cap	Whether this item has a cap that can be toggled on and off
icon_capped	Icon state to use when capped
icon_uncapped	Icon state to use when uncapped
instant	If false a do_after is required to draw something, otherwise it applies immediately
is_capped	Whether the cap is currently on or off
oriented	List of selectable orientable options
overlay_paint_colour	If true, a coloured overlay is applied to display the currently selected colour
paint_color	Current paint colour
paint_mode	Dictates how large of an area we cover with our paint
post_noise	Whether to play a sound after using
pre_noise	Whether to play a sound before using
randoms	List of selectable random options
reagent_contents	Reagents which are applied to things you use this on, or yourself if you eat it
runes	List of selectable rune options
self_contained	If true, this deletes itself when empty
symbols	List of selectable symbol options
text_buffer	Stores buffer of text to draw, one character at a time
volume_multiplier	Multiplies effect of reagent when applied to mobs or surfaces
Procs
after_eat	Used for edible component to reduce charges_left on bite.
check_empty	When eating a crayon, check_empty() can be called twice producing two messages unless we check for being deleted first.
refill	Refills charges_left in infinite crayons on use. Sets charges_left in infinite crayons to 100 for spawning reagents. Spawns reagents in crayons based on the amount of charges_left if not spawned yet.
set_painting_tool_color	Sets painting color and updates appearance.
use_charges	Returns number of charges actually used.
use_on	Attempts to color the target. Returns how many charges were used.

Var Details

var
actually_paints
–

If set to false, this just applies a chemical and cannot paint symbols

var
all_drawables
– /static/list

Combined lists

var
can_change_colour
–

If the user can toggle the colour, a la vanilla spraycan

var
charges
–

Number of times this item can be used, INFINITE_CHARGES for unlimited

var
charges_left
–

Number of remaining charges

var
crayon_color
–

Crayon overlay to use if placed into a crayon box

var
drawings
– /static/list

List of selectable drawing options

var
drawtype
–

Contains chosen symbol to draw

var
edible
–

Whether or not you can eat this. Doesn't mean it is a good idea to eat it.

var
expose_turfs
–

If true, sprayed turfs should also have the internal chemical applied to them

var
graffiti
– /static/list

List of selectable graffiti options If an associated value is present, the graffiti has its own cost otherwise it'll be the default value. Ditto with the other other lists below.

var
graffiti_large_h
– /static/list

List of selectable large options

var
has_cap
–

Whether this item has a cap that can be toggled on and off

var
icon_capped
–

Icon state to use when capped

var
icon_uncapped
–

Icon state to use when uncapped

var
instant
–

If false a do_after is required to draw something, otherwise it applies immediately

var
is_capped
–

Whether the cap is currently on or off

var
oriented
– /static/list

List of selectable orientable options

var
overlay_paint_colour
–

If true, a coloured overlay is applied to display the currently selected colour

var
paint_color
–

Current paint colour

var
paint_mode
–

Dictates how large of an area we cover with our paint

var
post_noise
–

Whether to play a sound after using

var
pre_noise
–

Whether to play a sound before using

var
randoms
– /static/list

List of selectable random options

var
reagent_contents
– /list

Reagents which are applied to things you use this on, or yourself if you eat it

var
runes
– /static/list

List of selectable rune options

var
self_contained
–

If true, this deletes itself when empty

var
symbols
– /static/list

List of selectable symbol options

var
text_buffer
–

Stores buffer of text to draw, one character at a time

var
volume_multiplier
–

Multiplies effect of reagent when applied to mobs or surfaces

Proc Details

proc
after_eat
(/mob/user)

Used for edible component to reduce charges_left on bite.

proc
check_empty
(/mob/user, amount, requires_full, override_infinity)

When eating a crayon, check_empty() can be called twice producing two messages unless we check for being deleted first.

Arguments:

user - the user.
amount - used for use_on() and when requires_full is TRUE
requires_full - if TRUE and charges_left < amount it will balloon_alert you. Used just for borgs spraycan it seems.
override_infinity - if TRUE it will override checks for infinite crayons.

proc
refill
()

Refills charges_left in infinite crayons on use. Sets charges_left in infinite crayons to 100 for spawning reagents. Spawns reagents in crayons based on the amount of charges_left if not spawned yet.

set_painting_tool_color
(chosen_color)

Sets painting color and updates appearance.

proc
use_charges
(/mob/user, amount, requires_full, override_infinity)

Returns number of charges actually used.

Arguments:

user - the user.
amount - how much charges do we reduce.
requires_full - Seems to transfer its data to the same argument on check_empty(). I'm not sure tho.
override_infinity - if TRUE stops infinite crayons from refilling.

proc
use_on
(/atom/target, /mob/user, params)

Attempts to color the target. Returns how many charges were used.

crayon /obj/item/toy/crayon

Vars

Procs

Var Details

var actually_paints –

var all_drawables – /static/list

var can_change_colour –

var charges –

var charges_left –

var crayon_color –

var drawings – /static/list

var drawtype –

var edible –

var expose_turfs –

var graffiti – /static/list

var graffiti_large_h – /static/list

var has_cap –

var icon_capped –

var icon_uncapped –

var instant –

var is_capped –

var oriented – /static/list

var overlay_paint_colour –

var paint_color –

var paint_mode –

var post_noise –

var pre_noise –

var randoms – /static/list

var reagent_contents – /list

var runes – /static/list

var self_contained –

var symbols – /static/list

var text_buffer –

var volume_multiplier –

Proc Details

proc after_eat(/mob/user)

proc check_empty(/mob/user, amount, requires_full, override_infinity)

proc refill()

set_painting_tool_color(chosen_color)

proc use_charges(/mob/user, amount, requires_full, override_infinity)

proc use_on(/atom/target, /mob/user, params)

crayon
/obj/item/toy/crayon

var
actually_paints
–

var
all_drawables
– /static/list

var
can_change_colour
–

var
charges
–

var
charges_left
–

var
crayon_color
–

var
drawings
– /static/list

var
drawtype
–

var
edible
–

var
expose_turfs
–

var
graffiti
– /static/list

var
graffiti_large_h
– /static/list

var
has_cap
–

var
icon_capped
–

var
icon_uncapped
–

var
instant
–

var
is_capped
–

var
oriented
– /static/list

var
overlay_paint_colour
–

var
paint_color
–

var
paint_mode
–

var
post_noise
–

var
pre_noise
–

var
randoms
– /static/list

var
reagent_contents
– /list

var
runes
– /static/list

var
self_contained
–

var
symbols
– /static/list

var
text_buffer
–

var
volume_multiplier
–

proc
after_eat
(/mob/user)

proc
check_empty
(/mob/user, amount, requires_full, override_infinity)

proc
refill
()

set_painting_tool_color
(chosen_color)

proc
use_charges
(/mob/user, amount, requires_full, override_infinity)

proc
use_on
(/atom/target, /mob/user, params)