mob
Vars | |
| client_colors | The set of /datum/client_color currently applied to the mob, if any. |
|---|---|
| confused | Positive Integer. The mob's current confusion level. Ticks down every Fire() in SSMobs. See set_confused(), mod_confused(), clear_confused(), and is_confused(). |
| do_unique_user_handle | Integer. Unique sequential ID from the do_after proc used to validate DO_USER_UNIQUE_ACT flag checks. |
| logout_time | Integer or null. Stores the world.time value at the time of Logout(). If null, the mob is either considered logged in or has never logged out. |
| renderers | Renderers on /mob We attach renderers to mobs for their lifespan. Only mobs with clients get renderers, and they are removed again when the mob loses its client. Mobs get their own unique renderer instances but it would not be inconceivable to share them globally. The list of renderers associated with this mob. |
| see_black | Sight Set Handling |
Procs | |
| AltClickOn | Called when the mob alt+clicks on an atom. By default, this calls the targeted atom's on_click/alt extension's on_click() proc, or the atom's AltClick() proc. |
| AltShiftClickOn | Called when the mob alt+shift+clicks on an atom. By default, this calls the atom's AltShiftClick() proc. |
| CreateRenderers | Creates the mob's renderers on /Login() |
| CtrlAltClickOn | Called when the mob ctrl+alt+clicks on an atom. By default, this calls the atom's CtrlAltClick() proc or calls the mob's pointed() proc. |
| CtrlAltShiftClickOn | Called when the mob ctrl+alt+shift+clicks on an atom. By default, this calls the atom's CtrlAltShiftClick() proc. |
| CtrlClickOn | Called when the mob ctrl+clicks on an atom. By default, this calls the targeted atom's CtrlClick() proc. |
| CtrlShiftClickOn | Called when the mob ctrl+shift+clicks on an atom. By default, calls the atom's CtrlShiftClick() proc. |
| GetAllHeld | Fetches all held items of the given path. |
| HandsEmpty | Whether or not the mob's hands or other holding slots are empty. Returns boolean. |
| HasFreeHand | Whether or not the mob has any free hands/holding slots. |
| IsHolding | Checks if a given item or path is in any of the mob's hands or other holding slots. |
| MiddleClickOn | Called when a mob middle-clicks on an object. By default, this is used only as a hotkey to call swap_hand(). |
| RangedAttack | Called when a mob attmepts to interact with an object that it is not adjacent to. For complex mobs, this includes interacting with an empty hand or empty module. |
| RemoveRenderers | Removes the mob's renderers on /Logout() |
| RestrainedClickOn | Called when a mob attempts to interact with an atom while handcuffed or otherwise restrained. Not currently used. |
| ShiftClickOn | Called when the mob shift+clicks on an atom. By default, this calls the targeted atom's ShiftClick() proc. |
| ShowMemories | Verbs |
| UnarmedAttack | Called when the mob interacts with something it is adjacent to. For complex mobs, this includes interacting with an empty hand or empty module. Generally, this translates to attack_hand(), attack_robot(), etc. |
| add_client_color | Adds an instance of color_type to the mob's client_colors list if one doesn't already exist. |
| add_to_living_mob_list | Life Handling |
| attack_empty_hand | Called when a mob attempts to use an empty hand on itself. |
| blueswitch | Handles applying blueswitch effects to the mob and creating the clone. |
| clear_client_colors | Clears the mobs client_colors list. |
| clear_confused | Sets a mob's confused value to 0. |
| direct_machine_interface | Whether or not the mob can directly interact with the machine regardless of screen and input status. Checked in CanUseTopic(). |
| do_skilled | Performs a do_after timer, with a modifier applied to the delay time based on the user's skill in the given skill path. |
| drop_item | Drops the item in our active hand. TODO: rename this to drop_active_hand or something Make sure you are ABSOLUTELY CERTAIN you need to drop this and ignore unequip checks (For example, grabs can be "dropped" but only willingly) Else use unequip_item |
| equip_to_appropriate_slot | Place I into the first slot it fits in the order of slots_by_priority, returning the slot or falsy. |
| equip_to_slot | UNSAFELY place I into this mob's inventory at slot if existentially possible. Generally, use the _if_possible version. |
| equip_to_slot_if_possible | Attempt to place I into this mob's inventory at slot. See TRYEQUIP_* flags for behavior modifiers. |
| fetch_bans | Aliases to _find_bans_in_connections() with this mob's fetch_connections() result. |
| fetch_connections | Aliases to _fetch_connections() with this mob's client, if present, or this mob's ckey/last ckey, last IP, and last CID. |
| get_attack_speed | Used to get how fast a mob should attack, and influences click delay. This is just for inheritance. |
| has_client_color | Checks whether the mob has an instance of color_type in its client_colors list. |
| has_danger_grab | Checks if the target has a grab from the user |
| isEquipped | Returns truthy when item is in the mobs inventory slots, or in slot if specified. |
| is_confused | Whether or not the mob's confusion level is at the threshhold. |
| is_species | Determine if the mob is the supplied species by text name, species path, or species instance name |
| mod_confused | Modifies a mob's confused value by mod_amount. |
| remove_client_color | Removes an instance of color_type from the mob's client_colors list, returning TRUE if one existed. |
| remove_grabs_and_pulls | Remove all grabs applied to target mob. Useful when mob is entering a compartment where they're not supposed to be grabbed. |
| set_confused | Sets a mob's confused value. |
| set_see_in_dark | See In Dark Set Handling |
| set_see_invisible | See Invisible Set Handling |
| show_associated_bans | Aliases to _show_associated_bans() using this mob's fetch_bans() result, ckey, IP address, and CID. |
| show_associated_connections | Aliases to _show_associated_connections() using this mob's fetch_connections() result, ckey, IP address, and CID. |
| update_client_color | Resets the mob's client.color to null and then applies the client_colors list. |
| use_sanity_check | Validates the mob can perform general interactions. Primarily intended for use after inputs, sleeps, timers, etc to ensure the action can still be completed. |
Var Details
client_colors
The set of /datum/client_color currently applied to the mob, if any.
confused
Positive Integer. The mob's current confusion level. Ticks down every Fire() in SSMobs. See set_confused(), mod_confused(), clear_confused(), and is_confused().
do_unique_user_handle
Integer. Unique sequential ID from the do_after proc used to validate DO_USER_UNIQUE_ACT flag checks.
logout_time
Integer or null. Stores the world.time value at the time of Logout(). If null, the mob is either considered logged in or has never logged out.
renderers
Renderers on /mob We attach renderers to mobs for their lifespan. Only mobs with clients get renderers, and they are removed again when the mob loses its client. Mobs get their own unique renderer instances but it would not be inconceivable to share them globally. The list of renderers associated with this mob.
see_black
Sight Set Handling
Proc Details
AltClickOn
Called when the mob alt+clicks on an atom. By default, this calls the targeted atom's on_click/alt extension's on_click() proc, or the atom's AltClick() proc.
Parameters:
A- The atom that was clicked on.
Returns boolean. Whether or not the interaction was handled.
AltShiftClickOn
Called when the mob alt+shift+clicks on an atom. By default, this calls the atom's AltShiftClick() proc.
Parameters:
A- The atom that was clicked on.
Returns boolean - Whether or not the interaction was handled.
CreateRenderers
Creates the mob's renderers on /Login()
CtrlAltClickOn
Called when the mob ctrl+alt+clicks on an atom. By default, this calls the atom's CtrlAltClick() proc or calls the mob's pointed() proc.
Parameters:
A- The atom that was clicked on.
Returns boolean. Whether or not the interaction was handled.
CtrlAltShiftClickOn
Called when the mob ctrl+alt+shift+clicks on an atom. By default, this calls the atom's CtrlAltShiftClick() proc.
Parameters:
A- The atom that was clicked on.
Returns boolean - Whether or not the interaction was handled.
CtrlClickOn
Called when the mob ctrl+clicks on an atom. By default, this calls the targeted atom's CtrlClick() proc.
Parameters:
A- The atom that was clicked on.
Returns boolean - Whether or not the action was handled.
CtrlShiftClickOn
Called when the mob ctrl+shift+clicks on an atom. By default, calls the atom's CtrlShiftClick() proc.
Parameters:
A- The atom that was clicked on.
Returns boolean. Whether or not the interaction was handled.
GetAllHeld
Fetches all held items of the given path.
If not passed any parameters, will simply fetch all held items.
Parameters:
item_path(path) - Path to the item type to fetch. Must be a type of/obj/item.
Returns list of found instances, or null.
HandsEmpty
Whether or not the mob's hands or other holding slots are empty. Returns boolean.
HasFreeHand
Whether or not the mob has any free hands/holding slots.
IsHolding
Checks if a given item or path is in any of the mob's hands or other holding slots.
Parameters:
item- The item to check for. Either a reference or a path. If a path, will check for any instance of path or its subtypes.
Returns instance of /obj/item or null. the item found in the mob's hands.
MiddleClickOn
Called when a mob middle-clicks on an object. By default, this is used only as a hotkey to call swap_hand().
Parameters:
A- The atom that was clicked on.
Returns boolean. Whether or not the interaction was handled.
RangedAttack
Called when a mob attmepts to interact with an object that it is not adjacent to. For complex mobs, this includes interacting with an empty hand or empty module.
Exception: Telekinesis will call UnarmedAttack([target], 0) instead.
Parameters:
A- The atom that was clicked on/interacted with.params- List of click parameters. See BYOND'sCLick()documentation.
Returns boolean - Whether or not the mob was able to perform the interaction.
RemoveRenderers
Removes the mob's renderers on /Logout()
RestrainedClickOn
Called when a mob attempts to interact with an atom while handcuffed or otherwise restrained. Not currently used.
Parameters:
A- The atom that was clicked on/interacted with.
ShiftClickOn
Called when the mob shift+clicks on an atom. By default, this calls the targeted atom's ShiftClick() proc.
Parameters:
A- The atom that was clicked on.
Returns boolean. Whether or not the interaction was handled.
ShowMemories
Verbs
UnarmedAttack
Called when the mob interacts with something it is adjacent to. For complex mobs, this includes interacting with an empty hand or empty module. Generally, this translates to attack_hand(), attack_robot(), etc.
Exception: This is also called when telekinesis is used, even if not adjacent to the target.
Parameters:
A- The atom that was clicked on/interacted with.proximity_flag- Whether or not the mob was at range from the targeted atom. Generally, this is always1unless telekinesis was used, where this will be0. This is not currently passed to attack_hand, and is instead used in human click code to allow glove touches only at melee range.
Returns boolean - Whether or not the mob was able to perform the interaction.
add_client_color
Adds an instance of color_type to the mob's client_colors list if one doesn't already exist.
add_to_living_mob_list
Life Handling
attack_empty_hand
Called when a mob attempts to use an empty hand on itself.
Parameters:
bp_hand(string,BP_R_HANDorBP_L_HAND) - The targeted and used hand's bodypart slot.
blueswitch
Handles applying blueswitch effects to the mob and creating the clone.
Parameters:
ghost- The bluespace ghost triggering the switch.
Returns instance of mob. The created bluespace clone, or null if no clone was created.
clear_client_colors
Clears the mobs client_colors list.
clear_confused
Sets a mob's confused value to 0.
Returns integer. The new value of confused.
direct_machine_interface
Whether or not the mob can directly interact with the machine regardless of screen and input status. Checked in CanUseTopic().
do_skilled
Performs a do_after timer, with a modifier applied to the delay time based on the user's skill in the given skill path.
Parameters
base_delayInteger (Seconds) - Base delay for the timer. This is added to the final delay time.skill_pathPath or list of paths (Subtypes of/singleton/hierarchy/skill; Any ofSKILL_*) - The skill used to modify the delay time. If provided as a list, the skill that produces the smallest timer is used. Passed toskill_delay_mult().target(Defaultnull) - The atom being interacted with. Passed directly todo_after().factorFloat (Default0.3) - Modifier factor used to modify the delay applied to the action. Passed toskill_delay_mult().do_flagsBitflag (Any ofDO_*; DefaultDO_PUBLIC_UNIQUE) - Flags passed on todo_after().
Returns boolean. Whether or not the do after check passed.
drop_item
Drops the item in our active hand. TODO: rename this to drop_active_hand or something Make sure you are ABSOLUTELY CERTAIN you need to drop this and ignore unequip checks (For example, grabs can be "dropped" but only willingly) Else use unequip_item
equip_to_appropriate_slot
Place I into the first slot it fits in the order of slots_by_priority, returning the slot or falsy.
equip_to_slot
UNSAFELY place I into this mob's inventory at slot if existentially possible. Generally, use the _if_possible version.
equip_to_slot_if_possible
Attempt to place I into this mob's inventory at slot. See TRYEQUIP_* flags for behavior modifiers.
fetch_bans
Aliases to _find_bans_in_connections() with this mob's fetch_connections() result.
Returns list of lists.
fetch_connections
Aliases to _fetch_connections() with this mob's client, if present, or this mob's ckey/last ckey, last IP, and last CID.
Returns list of lists.
get_attack_speed
Used to get how fast a mob should attack, and influences click delay. This is just for inheritance.
Parameters:
item- The item being used in the attack, if any.
Returns a number indicating the determined attack cooldown/speed.
has_client_color
Checks whether the mob has an instance of color_type in its client_colors list.
has_danger_grab
Checks if the target has a grab from the user
isEquipped
Returns truthy when item is in the mobs inventory slots, or in slot if specified.
is_confused
Whether or not the mob's confusion level is at the threshhold.
Parameters:
threshhold(Positive Integer, default1) - The threshhold at which the mob should be considered confused.
Returns boolean.
is_species
Determine if the mob is the supplied species by text name, species path, or species instance name
mod_confused
Modifies a mob's confused value by mod_amount.
Parameters:
mod_amount(Integer) - The amount to modifyconfusedby. Allows negative values for subtraction. Decimal values are rounded.floor(Positive Integer, default0) - The minimum value to setconfusedto. Decimal values are rounded.ceiling(Positive Integer, defaultCONFUSED_MAX) - The maximum value to setconfusedto. Decimal values are rounded.
Returns integer. The new value of confused.
remove_client_color
Removes an instance of color_type from the mob's client_colors list, returning TRUE if one existed.
remove_grabs_and_pulls
Remove all grabs applied to target mob. Useful when mob is entering a compartment where they're not supposed to be grabbed.
set_confused
Sets a mob's confused value.
Parameters:
amount(Positive Int) - The confused value to set. Decimal values are rounded.limit(Positive Int, defaultCONFUSED_MAX) - The maximum valueconfusedcan be set to. Decimal values are rounded.
Returns integer. The new value of confused.
set_see_in_dark
See In Dark Set Handling
set_see_invisible
See Invisible Set Handling
show_associated_bans
Aliases to _show_associated_bans() using this mob's fetch_bans() result, ckey, IP address, and CID.
Has no return value.
show_associated_connections
Aliases to _show_associated_connections() using this mob's fetch_connections() result, ckey, IP address, and CID.
Has no return value.
update_client_color
Resets the mob's client.color to null and then applies the client_colors list.
use_sanity_check
Validates the mob can perform general interactions. Primarily intended for use after inputs, sleeps, timers, etc to ensure the action can still be completed.
Parameters:
target- The atom being interacted with.tool- The item being used to interact. Optional. Defaults toFALSEto differentiate between a nulled reference and an empty parameter.flags(Bitflag, any ofSANITY_CHECK_*, defaultSANITY_CHECK_DEFAULT) - Bitflags of additional settings. Seecode\__defines\misc.dm.
Returns boolean.