robot

Vars
ai_lockdown	Boolean of whether the borg was locked by its AI or nothing
alert_control	Station alert datum for showing alerts UI
can_ride_typecache	What types of mobs are allowed to ride/buckle to this mob
cell	If this is a path, this gets created as an object in Initialize.
disabled_modules	For checking which modules are disabled or not.
ident	Random serial number generated for each cyborg upon its initialization
interfaceButton	The reference to the built-in tablet that borgs carry.
ion_trail	Ionpulse effect.
ionpulse	Jetpack-like effect.
ionpulse_on	Jetpack-like effect.
lampButton	Lamp button reference
lamp_color	Set lamp color
lamp_doom	Set to true if a doomsday event is locking our lamp to on and RED
lamp_enabled	If the lamp is turned on
lamp_functional	If the lamp isn't broken.
lamp_intensity	Lamp brightness. Starts at 3, but can be 1 - 5.
lawupdate	Cyborgs will sync their laws with their AI by default
lockcharge	Boolean of whether the borg is locked down or not
lockdown_timer	Timer that allows the borg to self-unlock after a set amount of time
low_power_mode	Whether the robot has no charge left.
model	Represents the cyborg's model (engineering, medical, etc.)
previous_health	the last health before updating - to check net change in health
robot_suit	Used for deconstruction to remember what the borg was constructed out of.
scrambledcodes	Used to determine if a borg shows up on the robotics console. Setting to TRUE hides them.
shown_robot_modules	Used to determine whether they have the module menu shown or not
spark_system	So they can initialize sparks whenever/N
Procs
Exited	Checking Exited() to detect if a hat gets up and walks off. Drones and pAIs might do this, after all.
activate_module	Finds the first available slot and attemps to put item item_module in it.
activated	Checks if the item is currently in a slot.
add_to_upgrades	Moves the upgrade inside the robot and registers relevant signals.
after_righted	For any special cases for robots after being righted.
apply_upgrade	Called when a mob uses an upgrade on an open borg. Checks to make sure the upgrade can be applied
borg_emag_end	A async proc called from [emag_act] that gives the borg a lot of flavortext, and applies the syndicate lawset after a delay.
break_all_cyborg_slots	Breaks all of a cyborg's slots.
break_cyborg_slot	Breaks the slot number, changing the icon.
cycle_modules	Cycles through the list of enabled modules, deselecting the current one and selecting the next one.
deploy_init	deploy_init: Deploys AI unit into AI shell
deselect_module	Deselects the module in the slot module_num. Arguments
draw_power	Draw power from the robot
dump_into_mmi	Dumps the current occupant of the cyborg into an MMI at the passed location Returns the borg's MMI on success
equip_module_to_slot	What's the first free slot for the borg? Is passed an item and a module slot. Equips the item to that borg slot.
get_active_held_item	Returns the thing in our active hand (whatever is in our active module-slot, in this case)
get_selected_module	The number of module slots we're checking Returns the slot number of the selected module, or zero if no modules are selected.
is_invalid_module_number	Checks if the provided module number is a valid number.
lockdown_override	Allows the borg to unlock themselves after a lenghty period of time.
make_shell	make_shell: Makes an AI shell out of a cyborg unit
observer_screen_update	Updates the observers's screens with cyborg itemss. Arguments
on_light_eater	Special handling for getting hit with a light eater
on_saboteur	special handling for getting shot with a light disruptor/saboteur e.g. the fisher
on_upgrade_deleted	Called when an applied upgrade is deleted.
remove_from_upgrades	Called when an upgrade is moved outside the robot. So don't call this directly, use forceMove etc.
repair_all_cyborg_slots	Repairs all slots. Unbroken slots are unaffected.
repair_cyborg_slot	Repairs the slot number, updating the icon.
revert_shell	revert_shell: Reverts AI shell back into a normal cyborg unit
select_module	Selects the module in the slot module_num. Arguments
set_lockcharge	Reports the event of the change in value of the lockcharge variable.
set_modularInterface_theme	Sets the tablet theme and icon
setup_default_name	Used to setup the a basic and (somewhat) unique name for the robot.
smash_headlamp	Handles headlamp smashing
toggle_headlamp	Handles headlamp toggling, disabling, and color setting.
toggle_module	Toggles selection of the module in the slot module_num. Arguments
uneq_active	Unequips the active held item, if there is one.
unequip_module_from_slot	Unequips item item_module from slot module_num. Deletes it if delete_after = TRUE.
update_sight	the current percent health of the robot (-1 to 1)
updatename	Updates the borg name taking the client preferences into account.

Var Details

var
ai_lockdown
–

Boolean of whether the borg was locked by its AI or nothing

var
alert_control
– /datum/station_alert

Station alert datum for showing alerts UI

var
can_ride_typecache
– /static/list

What types of mobs are allowed to ride/buckle to this mob

var
cell
– /obj/item/stock_parts/cell

If this is a path, this gets created as an object in Initialize.

var
disabled_modules
–

For checking which modules are disabled or not.

var
ident
–

Random serial number generated for each cyborg upon its initialization

var
interfaceButton
– /atom/movable/screen/robot/modpc

The reference to the built-in tablet that borgs carry.

var
ion_trail
– /datum/effect_system/trail_follow/ion

Ionpulse effect.

var
ionpulse
–

Jetpack-like effect.

var
ionpulse_on
–

Jetpack-like effect.

var
lampButton
– /atom/movable/screen/robot/lamp

Lamp button reference

var
lamp_color
–

Set lamp color

var
lamp_doom
–

Set to true if a doomsday event is locking our lamp to on and RED

var
lamp_enabled
–

If the lamp is turned on

var
lamp_functional
–

If the lamp isn't broken.

var
lamp_intensity
–

Lamp brightness. Starts at 3, but can be 1 - 5.

var
lawupdate
–

Cyborgs will sync their laws with their AI by default

var
lockcharge
–

Boolean of whether the borg is locked down or not

var
lockdown_timer
–

Timer that allows the borg to self-unlock after a set amount of time

var
low_power_mode
–

Whether the robot has no charge left.

var
model
– /obj/item/robot_model

Represents the cyborg's model (engineering, medical, etc.)

var
previous_health
–

the last health before updating - to check net change in health

var
robot_suit
– /obj/item/robot_suit

Used for deconstruction to remember what the borg was constructed out of.

var
scrambledcodes
–

Used to determine if a borg shows up on the robotics console. Setting to TRUE hides them.

var
shown_robot_modules
–

Used to determine whether they have the module menu shown or not

var
spark_system
– /datum/effect_system/spark_spread

So they can initialize sparks whenever/N

Proc Details

↑
Exited
(/atom/movable/gone, direction)

Checking Exited() to detect if a hat gets up and walks off. Drones and pAIs might do this, after all.

proc
activate_module
(/obj/item/item_module)

Finds the first available slot and attemps to put item item_module in it.

Arguments

item_module - the item being equipped to a slot.

proc
activated
(/obj/item/item_module)

Checks if the item is currently in a slot.

If the item is found in a slot, this returns TRUE. Otherwise, it returns FALSE Arguments

item_module - the item being checked

proc
add_to_upgrades
(/obj/item/borg/upgrade/new_upgrade)

Moves the upgrade inside the robot and registers relevant signals.

proc
after_righted
(/mob/user)

For any special cases for robots after being righted.

proc
apply_upgrade
(/obj/item/borg/upgrade/new_upgrade, /mob/user)

Called when a mob uses an upgrade on an open borg. Checks to make sure the upgrade can be applied

proc
borg_emag_end
(/mob/user)

A async proc called from [emag_act] that gives the borg a lot of flavortext, and applies the syndicate lawset after a delay.

proc
break_all_cyborg_slots
()

Breaks all of a cyborg's slots.

proc
break_cyborg_slot
(module_num)

Breaks the slot number, changing the icon.

Arguments

module_num - the slot number being repaired.

proc
cycle_modules
()

Cycles through the list of enabled modules, deselecting the current one and selecting the next one.

proc
deploy_init
(/mob/living/silicon/ai/AI)

deploy_init: Deploys AI unit into AI shell

Arguments:

AI - AI unit that initiated the deployment into the AI shell

proc
deselect_module
(module_num)

Deselects the module in the slot module_num. Arguments

module_num - the slot number being de-selected

proc
draw_power
(power_to_draw)

Draw power from the robot

proc
dump_into_mmi
(/atom/at_location)

Dumps the current occupant of the cyborg into an MMI at the passed location Returns the borg's MMI on success

proc
equip_module_to_slot
(/obj/item/item_module, module_num)

What's the first free slot for the borg? Is passed an item and a module slot. Equips the item to that borg slot.

Arguments

item_module - the item being equipped to a slot
module_num - the slot number being equipped to.

↑
get_active_held_item
()

Returns the thing in our active hand (whatever is in our active module-slot, in this case)

proc
get_selected_module
()

The number of module slots we're checking Returns the slot number of the selected module, or zero if no modules are selected.

proc
is_invalid_module_number
(module_num, check_all_slots)

Checks if the provided module number is a valid number.

If the number is between 1 and 3 (if check_all_slots is true) or between 1 and the number of disabled modules (if check_all_slots is false), then it returns FALSE. Otherwise, it returns TRUE. Arguments

module_num - the passed module num that is checked for validity.
check_all_slots - TRUE = the proc checks all slots | FALSE = the proc only checks un-disabled slots

proc
lockdown_override
()

Allows the borg to unlock themselves after a lenghty period of time.

proc
make_shell
(/obj/item/borg/upgrade/ai/board)

make_shell: Makes an AI shell out of a cyborg unit

Arguments:

board - B.O.R.I.S. module board used for transforming the cyborg into AI shell

proc
observer_screen_update
(/obj/item/item_module, add)

Updates the observers's screens with cyborg itemss. Arguments

item_module - the item being added or removed from the screen
add - whether or not the item is being added, or removed.

proc
on_light_eater
(/mob/living/silicon/robot/source, /datum/light_eater)

Special handling for getting hit with a light eater

proc
on_saboteur
(/datum/source, disrupt_duration)

special handling for getting shot with a light disruptor/saboteur e.g. the fisher

proc
on_upgrade_deleted
(/obj/item/borg/upgrade/old_upgrade)

Called when an applied upgrade is deleted.

proc
remove_from_upgrades
(/obj/item/borg/upgrade/old_upgrade)

Called when an upgrade is moved outside the robot. So don't call this directly, use forceMove etc.

proc
repair_all_cyborg_slots
()

Repairs all slots. Unbroken slots are unaffected.

proc
repair_cyborg_slot
(module_num)

Repairs the slot number, updating the icon.

Arguments

module_num - the module number being repaired.

proc
revert_shell
()

revert_shell: Reverts AI shell back into a normal cyborg unit

proc
select_module
(module_num)

Selects the module in the slot module_num. Arguments

module_num - the slot number being selected

proc
set_lockcharge
(new_lockcharge)

Reports the event of the change in value of the lockcharge variable.

proc
set_modularInterface_theme
()

Sets the tablet theme and icon

These variables are based on if the borg is a syndicate type or is emagged. This gets used in model change code and also borg emag code.

proc
setup_default_name
()

Used to setup the a basic and (somewhat) unique name for the robot.

proc
smash_headlamp
()

Handles headlamp smashing

When called (such as by the shadowperson lighteater's attack), this proc will break the borg's headlamp and then call toggle_headlamp to disable the light. It also plays a sound effect of glass breaking, and tells the borg what happened to its chat. Broken lights can be repaired by using a flashlight on the borg.

proc
toggle_headlamp
(turn_off, update_color)

Handles headlamp toggling, disabling, and color setting.

The initial if statment is a bit long, but the gist of it is that should the lamp be on AND the update_color arg be true, we should simply change the color of the lamp but not disable it. Otherwise, should the turn_off arg be true, the lamp already be enabled, any of the normal reasons the lamp would turn off happen, or the update_color arg be passed with the lamp not on, we should set the lamp off. The update_color arg is only ever true when this proc is called from the borg tablet, when the color selection feature is used.

Arguments:

arg1 - turn_off, if enabled will force the lamp into an off state (rather than toggling it if possible)
arg2 - update_color, if enabled, will adjust the behavior of the proc to change the color of the light if it is already on.

proc
toggle_module
(module_num)

Toggles selection of the module in the slot module_num. Arguments

module_num - the slot number being toggled

proc
uneq_active
()

Unequips the active held item, if there is one.

proc
unequip_module_from_slot
(/obj/item/item_module, module_num)

Unequips item item_module from slot module_num. Deletes it if delete_after = TRUE.

Arguments

item_module - the item being unequipped
module_num - the slot number being unequipped.

↑
update_sight
()

the current percent health of the robot (-1 to 1)

proc
updatename
(/client/pref_source)

Updates the borg name taking the client preferences into account.

robot /mob/living/silicon/robot

Vars

Procs

Var Details

var ai_lockdown –

var alert_control – /datum/station_alert

var can_ride_typecache – /static/list

var cell – /obj/item/stock_parts/cell

var disabled_modules –

var ident –

var interfaceButton – /atom/movable/screen/robot/modpc

var ion_trail – /datum/effect_system/trail_follow/ion

var ionpulse –

var ionpulse_on –

var lampButton – /atom/movable/screen/robot/lamp

var lamp_color –

var lamp_doom –

var lamp_enabled –

var lamp_functional –

var lamp_intensity –

var lawupdate –

var lockcharge –

var lockdown_timer –

var low_power_mode –

var model – /obj/item/robot_model

var previous_health –

var robot_suit – /obj/item/robot_suit

var scrambledcodes –

var shown_robot_modules –

var spark_system – /datum/effect_system/spark_spread

Proc Details

↑Exited(/atom/movable/gone, direction)

proc activate_module(/obj/item/item_module)

proc activated(/obj/item/item_module)

proc add_to_upgrades(/obj/item/borg/upgrade/new_upgrade)

proc after_righted(/mob/user)

proc apply_upgrade(/obj/item/borg/upgrade/new_upgrade, /mob/user)

proc borg_emag_end(/mob/user)

proc break_all_cyborg_slots()

proc break_cyborg_slot(module_num)

proc cycle_modules()

proc deploy_init(/mob/living/silicon/ai/AI)

proc deselect_module(module_num)

proc draw_power(power_to_draw)

proc dump_into_mmi(/atom/at_location)

proc equip_module_to_slot(/obj/item/item_module, module_num)

↑get_active_held_item()

proc get_selected_module()

proc is_invalid_module_number(module_num, check_all_slots)

proc lockdown_override()

proc make_shell(/obj/item/borg/upgrade/ai/board)

proc observer_screen_update(/obj/item/item_module, add)

proc on_light_eater(/mob/living/silicon/robot/source, /datum/light_eater)

proc on_saboteur(/datum/source, disrupt_duration)

proc on_upgrade_deleted(/obj/item/borg/upgrade/old_upgrade)

proc remove_from_upgrades(/obj/item/borg/upgrade/old_upgrade)

proc repair_all_cyborg_slots()

proc repair_cyborg_slot(module_num)

proc revert_shell()

proc select_module(module_num)

proc set_lockcharge(new_lockcharge)

proc set_modularInterface_theme()

proc setup_default_name()

proc smash_headlamp()

proc toggle_headlamp(turn_off, update_color)

proc toggle_module(module_num)

proc uneq_active()

proc unequip_module_from_slot(/obj/item/item_module, module_num)

↑update_sight()

proc updatename(/client/pref_source)

robot
/mob/living/silicon/robot

var
ai_lockdown
–

var
alert_control
– /datum/station_alert

var
can_ride_typecache
– /static/list

var
cell
– /obj/item/stock_parts/cell

var
disabled_modules
–

var
ident
–

var
interfaceButton
– /atom/movable/screen/robot/modpc

var
ion_trail
– /datum/effect_system/trail_follow/ion

var
ionpulse
–

var
ionpulse_on
–

var
lampButton
– /atom/movable/screen/robot/lamp

var
lamp_color
–

var
lamp_doom
–

var
lamp_enabled
–

var
lamp_functional
–

var
lamp_intensity
–

var
lawupdate
–

var
lockcharge
–

var
lockdown_timer
–

var
low_power_mode
–

var
model
– /obj/item/robot_model

var
previous_health
–

var
robot_suit
– /obj/item/robot_suit

var
scrambledcodes
–

var
shown_robot_modules
–

var
spark_system
– /datum/effect_system/spark_spread

↑
Exited
(/atom/movable/gone, direction)

proc
activate_module
(/obj/item/item_module)

proc
activated
(/obj/item/item_module)

proc
add_to_upgrades
(/obj/item/borg/upgrade/new_upgrade)

proc
after_righted
(/mob/user)

proc
apply_upgrade
(/obj/item/borg/upgrade/new_upgrade, /mob/user)

proc
borg_emag_end
(/mob/user)

proc
break_all_cyborg_slots
()

proc
break_cyborg_slot
(module_num)

proc
cycle_modules
()

proc
deploy_init
(/mob/living/silicon/ai/AI)

proc
deselect_module
(module_num)

proc
draw_power
(power_to_draw)

proc
dump_into_mmi
(/atom/at_location)

proc
equip_module_to_slot
(/obj/item/item_module, module_num)

↑
get_active_held_item
()

proc
get_selected_module
()

proc
is_invalid_module_number
(module_num, check_all_slots)

proc
lockdown_override
()

proc
make_shell
(/obj/item/borg/upgrade/ai/board)

proc
observer_screen_update
(/obj/item/item_module, add)

proc
on_light_eater
(/mob/living/silicon/robot/source, /datum/light_eater)

proc
on_saboteur
(/datum/source, disrupt_duration)

proc
on_upgrade_deleted
(/obj/item/borg/upgrade/old_upgrade)

proc
remove_from_upgrades
(/obj/item/borg/upgrade/old_upgrade)

proc
repair_all_cyborg_slots
()

proc
repair_cyborg_slot
(module_num)

proc
revert_shell
()

proc
select_module
(module_num)

proc
set_lockcharge
(new_lockcharge)

proc
set_modularInterface_theme
()

proc
setup_default_name
()

proc
smash_headlamp
()

proc
toggle_headlamp
(turn_off, update_color)

proc
toggle_module
(module_num)

proc
uneq_active
()

proc
unequip_module_from_slot
(/obj/item/item_module, module_num)

↑
update_sight
()

proc
updatename
(/client/pref_source)