/datum/emote

Vars
cooldown	The cooldown between the uses of the emote.
emote_type	Whether the emote is visible and/or audible bitflag
hands_use_check	Checks if the mob can use its hands before performing the emote.
key	What calls the emote.
key_third_person	This will also call the emote.
message	Message displayed when emote is used.
message_AI	Message displayed if the user is an AI.
message_alien	Message displayed if the user is a grown alien.
message_ipc	Message to display if the user is an IPC
message_larva	Message displayed if the user is an alien larva.
message_mime	Message displayed if the user is a mime.
message_monkey	Message displayed if the user is a monkey.
message_param	Message with %t at the end to allow adding params to the message, like for mobs doing an emote relatively to something else.
message_robot	Message displayed if the user is a robot.
message_simple	Message to display if the user is a simple_animal or basic mob.
message_vox	Message to display if the user is a vox
mob_type_allowed_typecache	Types that are allowed to use that emote.
mob_type_blacklist_typecache	Types that are NOT allowed to use that emote.
mob_type_ignore_stat_typecache	Types that can use this emote regardless of their state.
muzzle_ignore	Will only work if the emote is EMOTE_AUDIBLE.
only_forced_audio	Can only code call this event instead of the player.
sound	Sound to play when emote is called.
stat_allowed	In which state can you use this emote? (Check stat.dm for a full list of them)
vary	Used for the honk borg emote.
Procs
can_run_emote	Check to see if the user is allowed to run the emote.
check_cooldown	For handling emote cooldown, return true to allow the emote to happen
should_play_sound	Check to see if the user should play a sound when performing the emote.

Var Details

var
cooldown
–

The cooldown between the uses of the emote.

var
emote_type
–

Whether the emote is visible and/or audible bitflag

var
hands_use_check
–

Checks if the mob can use its hands before performing the emote.

var
key
–

What calls the emote.

var
key_third_person
–

This will also call the emote.

var
message
–

Message displayed when emote is used.

var
message_AI
–

Message displayed if the user is an AI.

var
message_alien
–

Message displayed if the user is a grown alien.

var
message_ipc
–

Message to display if the user is an IPC

var
message_larva
–

Message displayed if the user is an alien larva.

var
message_mime
–

Message displayed if the user is a mime.

var
message_monkey
–

Message displayed if the user is a monkey.

var
message_param
–

Message with %t at the end to allow adding params to the message, like for mobs doing an emote relatively to something else.

var
message_robot
–

Message displayed if the user is a robot.

var
message_simple
–

Message to display if the user is a simple_animal or basic mob.

var
message_vox
–

Message to display if the user is a vox

var
mob_type_allowed_typecache
– /list

Types that are allowed to use that emote.

var
mob_type_blacklist_typecache
– /list

Types that are NOT allowed to use that emote.

var
mob_type_ignore_stat_typecache
– /list

Types that can use this emote regardless of their state.

var
muzzle_ignore
–

Will only work if the emote is EMOTE_AUDIBLE.

var
only_forced_audio
–

Can only code call this event instead of the player.

var
sound
–

Sound to play when emote is called.

var
stat_allowed
–

In which state can you use this emote? (Check stat.dm for a full list of them)

var
vary
–

Used for the honk borg emote.

Proc Details

proc
can_run_emote
(/mob/user, status_check, intentional)

Check to see if the user is allowed to run the emote.

Arguments:

user - Person that is trying to send the emote.
status_check - Bool that says whether we should check their stat or not.
intentional - Bool that says whether the emote was forced (FALSE) or not (TRUE).

Returns a bool about whether or not the user can run the emote.

proc
check_cooldown
(/mob/user, intentional, update, is_keybind)

For handling emote cooldown, return true to allow the emote to happen

proc
should_play_sound
(/mob/user, intentional)

Check to see if the user should play a sound when performing the emote.

Arguments:

user - Person that is doing the emote.
intentional - Bool that says whether the emote was forced (FALSE) or not (TRUE).

Returns a bool about whether or not the user should play a sound when performing the emote.

/datum/emote

Vars

Procs

Var Details

var cooldown –

var emote_type –

var hands_use_check –

var key –

var key_third_person –

var message –

var message_AI –

var message_alien –

var message_ipc –

var message_larva –

var message_mime –

var message_monkey –

var message_param –

var message_robot –

var message_simple –

var message_vox –

var mob_type_allowed_typecache – /list

var mob_type_blacklist_typecache – /list

var mob_type_ignore_stat_typecache – /list

var muzzle_ignore –

var only_forced_audio –

var sound –

var stat_allowed –

var vary –