movable

Vars
active_mutations	List of the active mutation types
audio_emote_cd_status	Cooldown on audio effects from emotes.
audio_emote_unintentional_cd_status	Cooldown on audio effects from unintentional emotes.
buckled	movable atoms buckled to this mob
buckling	movable atom we are buckled to
emote_cooldown_override	Override for cooldowns on non-audio emotes. Should be a number in deciseconds.
emotes_used	Tracks last uses of emotes for cooldown purposes
hand	True for left hand active, otherwise for right hand active
has_enabled_antagHUD	Whether antagHUD has been enabled previously.
health_hud_override	Overrides the health HUD element state if set.
input_focus	The datum receiving keyboard input. parent mob by default.
memory	only set while the move is ongoing, to prevent shuffling between pullees
open_uis	global
runechat_msg_location	A soft reference to the location where this mob's runechat message will appear. Uses `UID()`.
s_active	Active storage container
sound_environment_override	Override for sound_environments. If this is set the user will always hear a specific type of reverb (Instead of the area defined reverb)
zone_selected	The zone this mob is currently targeting
Procs
ForceContractDisease	Forces the mob to contract a virus. If the mob can have viruses. Ignores clothing and other protection Returns TRUE if it succeeds. False if it doesn't
Process_Spacemove	Process_Spacemove Called by /client/Move() For moving in space Return 1 for movement 0 for none
adjust_nutrition	Adjust the nutrition of a mob
become_mouse	Returns true if the player successfully becomes a mouse
buckle_mob	Buckle to another mob
can_buckle	can the mob be buckled to something by default?
can_resist	Can this mob resist (default FALSE)
can_unbuckle	can the mob be unbuckled from something by default?
can_use_audio_emote	Helper proc to determine if a mob can use emotes that make sound or not.
create_chat_message	Creates a message overlay at a defined location for a given speaker
custom_emote	Perform a custom emote.
emote	Send an emote.
flash_screen_color	Flash up a color as an overlay on a player's screen, then fade back to normal.
get_mob_buckling_height	returns the height in pixel the mob should have when buckled to another mob.
get_telepathic_targets	Returns an assoc list which contains the mobs in range and their "visible" name. Mobs out of view but in range will be listed as unknown. Else they will have their visible name
ghost_can_reenter	Checks if a mob's ghost can reenter their body or not. Used to check for DNR or AntagHUD.
manual_emote	Allows the intrepid coder to send a basic emote Takes text as input, sends it out to those who need to know after some light parsing If you need something more complex, make it into a datum emote Arguments:
pointed	Point at an atom
post_buckle_mob	Call back post buckle to a mob to offset your visual height
post_unbuckle_mob	Call back post unbuckle from a mob, (reset your visual height here)
run_mode	proc version to finish /mob/verb/mode() execution. used in case the proc needs to be queued for the tick after its first called
run_pointed	possibly delayed verb that finishes the pointing process starting in [/mob/verb/pointed()]. either called immediately or in the tick after pointed() was called, as per the [DEFAULT_QUEUE_OR_CALL_VERB()] macro
run_quick_equip	proc extender of [/mob/verb/quick_equip] used to make the verb queuable if the server is overloaded
set_nutrition	Force set the mob nutrition
set_typing_indicator	Toggles the floating chat bubble above a players head.
shared_ui_interaction	public
show_rads	Show an overlay of radiation levels on radioactive objects.
shuttleRotate	Turf rotate procs
start_audio_emote_cooldown	Start the cooldown for an emote that plays audio.
throw_alert	Proc to create or update an alert. Returns the alert if the alert is new or updated, 0 if it was thrown already. Each mob may only have one alert per category.
update_runechat_msg_location	Updates the mob's runechat maptext display location.
usable_emote_keys	Get a list of all emote keys usable by the current mob.

Var Details

var
active_mutations
– /list

List of the active mutation types

var
audio_emote_cd_status
–

Cooldown on audio effects from emotes.

var
audio_emote_unintentional_cd_status
–

Cooldown on audio effects from unintentional emotes.

var
buckled
– /atom/movable

movable atoms buckled to this mob

var
buckling
– /atom/movable

movable atom we are buckled to

var
emote_cooldown_override
–

Override for cooldowns on non-audio emotes. Should be a number in deciseconds.

var
emotes_used
– /list

Tracks last uses of emotes for cooldown purposes

var
hand
–

True for left hand active, otherwise for right hand active

var
has_enabled_antagHUD
–

Whether antagHUD has been enabled previously.

var
health_hud_override
–

Overrides the health HUD element state if set.

var
input_focus
– /datum

The datum receiving keyboard input. parent mob by default.

var
memory
–

only set while the move is ongoing, to prevent shuffling between pullees

var
open_uis
– /list

global

Used to track UIs for a mob.

var
runechat_msg_location
–

A soft reference to the location where this mob's runechat message will appear. Uses UID().

var
s_active
– /obj/item/storage

Active storage container

var
sound_environment_override
–

Override for sound_environments. If this is set the user will always hear a specific type of reverb (Instead of the area defined reverb)

var
zone_selected
–

The zone this mob is currently targeting

Proc Details

proc
ForceContractDisease
(/datum/disease/D, respect_carrier, notify_ghosts)

Forces the mob to contract a virus. If the mob can have viruses. Ignores clothing and other protection Returns TRUE if it succeeds. False if it doesn't

Arguments:

D - the disease the mob will try to contract
respect_carrier - if set to TRUE will not ignore the disease carrier flag
notify_ghosts - will notify ghosts of infection if set to TRUE

Process_Spacemove
(movement_dir)

Process_Spacemove Called by /client/Move() For moving in space Return 1 for movement 0 for none

proc
adjust_nutrition
(change)

Adjust the nutrition of a mob

proc
become_mouse
()

Returns true if the player successfully becomes a mouse

buckle_mob
(/mob/living/M, force, check_loc)

Buckle to another mob

You can buckle on mobs if you're next to them since most are dense

Turns you to face the other mob too

proc
can_buckle
()

can the mob be buckled to something by default?

proc
can_resist
()

Can this mob resist (default FALSE)

proc
can_unbuckle
()

can the mob be unbuckled from something by default?

proc
can_use_audio_emote
(intentional)

Helper proc to determine if a mob can use emotes that make sound or not.

proc
create_chat_message
(/atom/movable/speaker, raw_message, italics, size, symbol)

Creates a message overlay at a defined location for a given speaker

Arguments:

speaker - The atom who is saying this message
raw_message - The text content of the message
italics - Vacuum and other things
size - Size of the message
symbol - The symbol type of the message

proc
custom_emote
(m_type, message, intentional)

Perform a custom emote.

m_type: Type of message to send.
message: Content of the message. If none is provided, the user will be prompted to choose the input.
intentional: Whether or not the user intendeded to perform the emote.

proc
emote
(emote_key, type_override, message, intentional, force_silence)

Send an emote.

emote_key: Key of the emote being triggered
m_type: Type of the emote, like EMOTE_AUDIBLE. If this is not null, the default type of the emote will be overridden.
message: Custom parameter for the emote. This should be used if you want to pass something like a target programmatically.
intentional: Whether or not the emote was deliberately triggered by the mob. If true, it's forced, which skips some checks when calling the emote.
force_silence: If true, unusable/nonexistent emotes will not notify the user.

proc
flash_screen_color
(flash_color, flash_time)

Flash up a color as an overlay on a player's screen, then fade back to normal.

Arguments:

flash_color - The color to overlay on the screen.
flash_time - The time it takes for the color to fade back to normal.

proc
get_mob_buckling_height
(/mob/seat)

returns the height in pixel the mob should have when buckled to another mob.

proc
get_telepathic_targets
()

Returns an assoc list which contains the mobs in range and their "visible" name. Mobs out of view but in range will be listed as unknown. Else they will have their visible name

proc
ghost_can_reenter
()

Checks if a mob's ghost can reenter their body or not. Used to check for DNR or AntagHUD.

Returns FALSE if there is a ghost, and it can't reenter the body. Returns TRUE otherwise.

proc
manual_emote
(text)

Allows the intrepid coder to send a basic emote Takes text as input, sends it out to those who need to know after some light parsing If you need something more complex, make it into a datum emote Arguments:

text - The text to send out

Returns TRUE if it was able to run the emote, FALSE otherwise.

verb
pointed
(/atom/A)

Point at an atom

mob verbs are faster than object verbs. See this byond forum post for why this isn't atom/verb/pointed()

note: ghosts can point, this is intended

visible_message will handle invisibility properly

overridden here and in /mob/dead/observer for different point span classes and sanity checks

post_buckle_mob
(/mob/living/M)

Call back post buckle to a mob to offset your visual height

post_unbuckle_mob
(/mob/living/M)

Call back post unbuckle from a mob, (reset your visual height here)

proc
run_mode
()

proc version to finish /mob/verb/mode() execution. used in case the proc needs to be queued for the tick after its first called

proc
run_pointed
(/atom/A)

possibly delayed verb that finishes the pointing process starting in [/mob/verb/pointed()]. either called immediately or in the tick after pointed() was called, as per the [DEFAULT_QUEUE_OR_CALL_VERB()] macro

proc
run_quick_equip
()

proc extender of [/mob/verb/quick_equip] used to make the verb queuable if the server is overloaded

proc
set_nutrition
(change)

Force set the mob nutrition

proc
set_typing_indicator
(state, me)

Toggles the floating chat bubble above a players head.

Arguments:

state - Should a chat bubble be shown or hidden
me - Is the bubble being caused by the 'me' emote command

proc
shared_ui_interaction
(src_object)

public

Standard interaction/sanity checks. Different mob types may have overrides.

return UI_state The state of the UI.

proc
show_rads
(range)

Show an overlay of radiation levels on radioactive objects.

↑
shuttleRotate
(rotation, params)

Turf rotate procs

Mob rotate procs

proc
start_audio_emote_cooldown
(intentional, cooldown)

Start the cooldown for an emote that plays audio.

Arguments:

intentional - Whether or not the user deliberately triggered this emote.
cooldown - The amount of time that should be waited before any other audio emote can fire.

proc
throw_alert
(category, type, severity, /obj/new_master, override, timeout_override, no_anim, icon_override, /list/alert_args)

Proc to create or update an alert. Returns the alert if the alert is new or updated, 0 if it was thrown already. Each mob may only have one alert per category.

Arguments:

category - a text string corresponding to what type of alert it is
type - a type path of the actual alert type to throw
severity - is an optional number that will be placed at the end of the icon_state for this alert For example, high pressure's icon_state is "highpressure" and can be serverity 1 or 2 to get "highpressure1" or "highpressure2"
obj/new_master - optional argument. Sets the alert's icon state to "template" in the ui_style icons with the master as an overlay. Clicks are forwarded to master
no_anim - whether the alert should play a small sliding animation when created on the player's screen
icon_override - makes it so the alert is not replaced until cleared by a clear_alert with clear_override, and it's used for hallucinations.
list/alert_args - a list of arguments to pass to the alert when creating it

proc
update_runechat_msg_location
()

Updates the mob's runechat maptext display location.

By default, we set this to the src mob's UID().

proc
usable_emote_keys
(intentional_use)

Get a list of all emote keys usable by the current mob.

intentional_use: Whether or not to check based on if the action was intentional.

mob /mob inherits /atom/movable

Vars

Procs

Var Details

var active_mutations – /list

var audio_emote_cd_status –

var audio_emote_unintentional_cd_status –

var buckled – /atom/movable

var buckling – /atom/movable

var emote_cooldown_override –

var emotes_used – /list

var hand –

var has_enabled_antagHUD –

var health_hud_override –

var input_focus – /datum

var memory –

var open_uis – /list

var runechat_msg_location –

var s_active – /obj/item/storage

var sound_environment_override –

var zone_selected –

Proc Details

proc ForceContractDisease(/datum/disease/D, respect_carrier, notify_ghosts)

Process_Spacemove(movement_dir)

proc adjust_nutrition(change)

proc become_mouse()

buckle_mob(/mob/living/M, force, check_loc)

proc can_buckle()

proc can_resist()

proc can_unbuckle()

proc can_use_audio_emote(intentional)

proc create_chat_message(/atom/movable/speaker, raw_message, italics, size, symbol)

proc custom_emote(m_type, message, intentional)

proc emote(emote_key, type_override, message, intentional, force_silence)

proc flash_screen_color(flash_color, flash_time)

proc get_mob_buckling_height(/mob/seat)

proc get_telepathic_targets()

proc ghost_can_reenter()

proc manual_emote(text)

verb pointed(/atom/A)

post_buckle_mob(/mob/living/M)

post_unbuckle_mob(/mob/living/M)

proc run_mode()

proc run_pointed(/atom/A)

proc run_quick_equip()

proc set_nutrition(change)

proc set_typing_indicator(state, me)

proc shared_ui_interaction(src_object)

proc show_rads(range)

↑shuttleRotate(rotation, params)

proc start_audio_emote_cooldown(intentional, cooldown)

proc throw_alert(category, type, severity, /obj/new_master, override, timeout_override, no_anim, icon_override, /list/alert_args)

proc update_runechat_msg_location()

proc usable_emote_keys(intentional_use)

mob
/mob
inherits /atom/movable

var
active_mutations
– /list

var
audio_emote_cd_status
–

var
audio_emote_unintentional_cd_status
–

var
buckled
– /atom/movable

var
buckling
– /atom/movable

var
emote_cooldown_override
–

var
emotes_used
– /list

var
hand
–

var
has_enabled_antagHUD
–

var
health_hud_override
–

var
input_focus
– /datum

var
memory
–

var
open_uis
– /list

var
runechat_msg_location
–

var
s_active
– /obj/item/storage

var
sound_environment_override
–

var
zone_selected
–

proc
ForceContractDisease
(/datum/disease/D, respect_carrier, notify_ghosts)

Process_Spacemove
(movement_dir)

proc
adjust_nutrition
(change)

proc
become_mouse
()

buckle_mob
(/mob/living/M, force, check_loc)

proc
can_buckle
()

proc
can_resist
()

proc
can_unbuckle
()

proc
can_use_audio_emote
(intentional)

proc
create_chat_message
(/atom/movable/speaker, raw_message, italics, size, symbol)

proc
custom_emote
(m_type, message, intentional)

proc
emote
(emote_key, type_override, message, intentional, force_silence)

proc
flash_screen_color
(flash_color, flash_time)

proc
get_mob_buckling_height
(/mob/seat)

proc
get_telepathic_targets
()

proc
ghost_can_reenter
()

proc
manual_emote
(text)

verb
pointed
(/atom/A)

post_buckle_mob
(/mob/living/M)

post_unbuckle_mob
(/mob/living/M)

proc
run_mode
()

proc
run_pointed
(/atom/A)

proc
run_quick_equip
()

proc
set_nutrition
(change)

proc
set_typing_indicator
(state, me)

proc
shared_ui_interaction
(src_object)

proc
show_rads
(range)

↑
shuttleRotate
(rotation, params)

proc
start_audio_emote_cooldown
(intentional, cooldown)

proc
throw_alert
(category, type, severity, /obj/new_master, override, timeout_override, no_anim, icon_override, /list/alert_args)

proc
update_runechat_msg_location
()

proc
usable_emote_keys
(intentional_use)