big_manipulator

The Big Manipulator's core. Main part of the mechanism that carries out the entire process.

Vars
allowed_priority_settings	What priority settings are available to use at the moment. We also use this list to sort priorities from ascending to descending.
allowed_types_to_pick_up	List where we can set selected type. Taking items by Initialize.
containment_obj	The object inside the manipulator.
drop_here	The direction the manipulator arm will drop items to.
drop_turf	The turf where the manipulator arm will drop items to.
filter_obj	The object used as a filter.
id_locked	Is manipulator locked by identity id.
interaction_delay	The time it takes for the manipulator to complete the action cycle.
interaction_mode	How should the manipulator interact with the object?
locked_by_this_id	weakref to id that locked this manipualtor.
manipulator_arm	The manipulator's arm.
manipulator_throw_range	The distance the thrown object should travel when thrown.
minimal_delay	Min time manipulator can have in delay. Changing on upgrade.
monkey_worker	The poor monkey that needs to use mode works.
on	Is the manipulator turned on?
override_priority	Overrides the priority selection, only accessing the top priority list element.
power_access_wire_cut	Is the power access wire cut? Disables the power button if `TRUE`.
power_use_lvl	Using high tier manipulators speeds up big manipulator and requires more energy.
priority_settings_for_drop	Priority settings depending on the manipulator drop mode that are available to this manipulator. Filled during Initialize.
priority_settings_for_use	Priority settings depending on the manipulator use mode that are available to this manipulator. Filled during Initialize.
selected_type	The `type` the manipulator will interact with only.
status	The status of the manipulator - `IDLE` or `BUSY`.
take_here	The direction the manipulator arm will take items from.
take_turf	The turf where the manipulator arm will take items from.
worker_interaction	How should the worker interact with the object?
Procs
change_delay	Changes manipulator working speed time.
change_mode	Proc called when we changing item interaction mode.
check_end_of_use	Check what we gonna do next with our item. Drop it or use again.
check_next_move	2.5 take and drop proc from [take and drop procs loop]: Choose what we will do with our item by checking the interaction_mode.
check_similarities	Using on change_priority: looks for a setting with the same number that we set earlier and reduce it.
create_manipulator_arm	Creat manipulator hand effect on manipulator core.
cycle_value	Cycles the given value in the given list. Retuns the next value in the list, or the first one if the list isn't long enough.
do_rotate_animation	Rotates manipulator hand 90 degrees.
drop_held_object	Drop item that manipulator is manipulating.
drop_thing	3.1 take and drop proc from [take and drop procs loop]: Drop our item. Checks the priority to drop item not only ground but also in the storage.
end_work	Fourth and last take and drop proc from [take and drop procs loop]: Finishes work and begins to look for a new item for [take and drop procs loop].
finish_manipulation	End of thirds take and drop proc from [take and drop procs loop]: Starts manipulator hand backward animation.
finish_rotate_animation	Rotates manipulator hand from 90 degrees to 180 or 0 if backward.
is_ready_to_work	Pre take and drop proc from [take and drop procs loop]: Can we begin the `take-and-drop` loop?
manipulator_lvl	Check servo tier and change manipulator speed, power_use and colour.
on_hand_qdel	Deliting hand will destroy our manipulator core.
press_on	Proc call when we press on/off button
rotate_big_hand	Changing take and drop turf dirs and also changing manipulator hand sprite dir.
search_type_by_priority_in_drop_turf	Proc that return item by type in priority list. Selects item and increasing priority number if don't found req type.
set_up_priority_settings	Init priority settings list for all modes.
start_work	Second take and drop proc from [take and drop procs loop]: Taking our item and start manipulator hand rotate animation.
take_and_drop_turfs_check	Changing take and drop turf tiles when we anchore manipulator or if manipulator not in turf.
throw_thing	3.3 take and drop proc from [take and drop procs loop]: Throw item away!!!
try_press_on	Proc that check if button not cutted when we press on button.
try_take_thing	First take and drop proc from [take and drop procs loop]: Check if we can take item from take_turf to work with him. This proc also calling from ATOM_ENTERED signal.
update_priority_list	Update priority list in ui. Creating new list and sort it by priority number.
use_thing	3.2 take and drop proc from [take and drop procs loop]: Use our item on random atom in drop turf contents then Starts manipulator hand backward animation by defualt, but You can also set the setting in ui so that it does not return to its privious position and continues to use object in its hand. Checks the priority so that you can configure which object it will select: mob/obj/turf. Also can use filter to interact only with obj in filter.

Var Details

var
allowed_priority_settings
– /list

What priority settings are available to use at the moment. We also use this list to sort priorities from ascending to descending.

var
allowed_types_to_pick_up
– /list

List where we can set selected type. Taking items by Initialize.

var
containment_obj
– /datum/weakref

The object inside the manipulator.

var
drop_here
–

The direction the manipulator arm will drop items to.

var
drop_turf
– /turf

The turf where the manipulator arm will drop items to.

var
filter_obj
– /datum/weakref

The object used as a filter.

var
id_locked
–

Is manipulator locked by identity id.

var
interaction_delay
–

The time it takes for the manipulator to complete the action cycle.

var
interaction_mode
–

How should the manipulator interact with the object?

var
locked_by_this_id
– /datum/weakref

weakref to id that locked this manipualtor.

var
manipulator_arm
– /obj/effect/big_manipulator_arm

The manipulator's arm.

var
manipulator_throw_range
–

The distance the thrown object should travel when thrown.

var
minimal_delay
–

Min time manipulator can have in delay. Changing on upgrade.

var
monkey_worker
– /datum/weakref

The poor monkey that needs to use mode works.

var
on
–

Is the manipulator turned on?

var
override_priority
–

Overrides the priority selection, only accessing the top priority list element.

var
power_access_wire_cut
–

Is the power access wire cut? Disables the power button if TRUE.

var
power_use_lvl
–

Using high tier manipulators speeds up big manipulator and requires more energy.

var
priority_settings_for_drop
– /list

Priority settings depending on the manipulator drop mode that are available to this manipulator. Filled during Initialize.

var
priority_settings_for_use
– /list

Priority settings depending on the manipulator use mode that are available to this manipulator. Filled during Initialize.

var
selected_type
– /atom

The type the manipulator will interact with only.

var
status
–

The status of the manipulator - IDLE or BUSY.

var
take_here
–

The direction the manipulator arm will take items from.

var
take_turf
– /turf

The turf where the manipulator arm will take items from.

var
worker_interaction
–

How should the worker interact with the object?

Proc Details

proc
change_delay
(new_delay)

Changes manipulator working speed time.

proc
change_mode
()

Proc called when we changing item interaction mode.

proc
check_end_of_use
(/obj/item/my_item, item_was_used)

Check what we gonna do next with our item. Drop it or use again.

proc
check_next_move
(/atom/movable/target, hand_is_empty)

2.5 take and drop proc from [take and drop procs loop]: Choose what we will do with our item by checking the interaction_mode.

proc
check_similarities
(number_we_minus)

Using on change_priority: looks for a setting with the same number that we set earlier and reduce it.

proc
create_manipulator_arm
()

Creat manipulator hand effect on manipulator core.

proc
cycle_value
(current_value, /list/possible_values)

Cycles the given value in the given list. Retuns the next value in the list, or the first one if the list isn't long enough.

proc
do_rotate_animation
(backward)

Rotates manipulator hand 90 degrees.

proc
drop_held_object
()

Drop item that manipulator is manipulating.

proc
drop_thing
(/atom/movable/target)

3.1 take and drop proc from [take and drop procs loop]: Drop our item. Checks the priority to drop item not only ground but also in the storage.

proc
end_work
()

Fourth and last take and drop proc from [take and drop procs loop]: Finishes work and begins to look for a new item for [take and drop procs loop].

proc
finish_manipulation
()

End of thirds take and drop proc from [take and drop procs loop]: Starts manipulator hand backward animation.

proc
finish_rotate_animation
(backward)

Rotates manipulator hand from 90 degrees to 180 or 0 if backward.

proc
is_ready_to_work
()

Pre take and drop proc from [take and drop procs loop]: Can we begin the take-and-drop loop?

proc
manipulator_lvl
()

Check servo tier and change manipulator speed, power_use and colour.

proc
on_hand_qdel
()

Deliting hand will destroy our manipulator core.

proc
press_on
(pressed_by)

Proc call when we press on/off button

proc
rotate_big_hand
()

Changing take and drop turf dirs and also changing manipulator hand sprite dir.

proc
search_type_by_priority_in_drop_turf
(/list/priority_list)

Proc that return item by type in priority list. Selects item and increasing priority number if don't found req type.

proc
set_up_priority_settings
()

Init priority settings list for all modes.

proc
start_work
(/atom/movable/target, hand_is_empty)

Second take and drop proc from [take and drop procs loop]: Taking our item and start manipulator hand rotate animation.

proc
take_and_drop_turfs_check
()

Changing take and drop turf tiles when we anchore manipulator or if manipulator not in turf.

proc
throw_thing
(/atom/movable/target)

3.3 take and drop proc from [take and drop procs loop]: Throw item away!!!

proc
try_press_on
(/mob/user)

Proc that check if button not cutted when we press on button.

proc
try_take_thing
(/datum/source, /atom/movable/target)

First take and drop proc from [take and drop procs loop]: Check if we can take item from take_turf to work with him. This proc also calling from ATOM_ENTERED signal.

proc
update_priority_list
()

Update priority list in ui. Creating new list and sort it by priority number.

proc
use_thing
(/atom/movable/target, hand_is_empty)

3.2 take and drop proc from [take and drop procs loop]: Use our item on random atom in drop turf contents then Starts manipulator hand backward animation by defualt, but You can also set the setting in ui so that it does not return to its privious position and continues to use object in its hand. Checks the priority so that you can configure which object it will select: mob/obj/turf. Also can use filter to interact only with obj in filter.

big_manipulator /obj/machinery/big_manipulator

Vars

Procs

Var Details

var allowed_priority_settings – /list

var allowed_types_to_pick_up – /list

var containment_obj – /datum/weakref

var drop_here –

var drop_turf – /turf

var filter_obj – /datum/weakref

var id_locked –

var interaction_delay –

var interaction_mode –

var locked_by_this_id – /datum/weakref

var manipulator_arm – /obj/effect/big_manipulator_arm

var manipulator_throw_range –

var minimal_delay –

var monkey_worker – /datum/weakref

var on –

var override_priority –

var power_access_wire_cut –

var power_use_lvl –

var priority_settings_for_drop – /list

var priority_settings_for_use – /list

var selected_type – /atom

var status –

var take_here –

var take_turf – /turf

var worker_interaction –

Proc Details

proc change_delay(new_delay)

proc change_mode()

proc check_end_of_use(/obj/item/my_item, item_was_used)

proc check_next_move(/atom/movable/target, hand_is_empty)

proc check_similarities(number_we_minus)

proc create_manipulator_arm()

proc cycle_value(current_value, /list/possible_values)

proc do_rotate_animation(backward)

proc drop_held_object()

proc drop_thing(/atom/movable/target)

proc end_work()

proc finish_manipulation()

proc finish_rotate_animation(backward)

proc is_ready_to_work()

proc manipulator_lvl()

proc on_hand_qdel()

proc press_on(pressed_by)

proc rotate_big_hand()

proc search_type_by_priority_in_drop_turf(/list/priority_list)

proc set_up_priority_settings()

proc start_work(/atom/movable/target, hand_is_empty)

proc take_and_drop_turfs_check()

proc throw_thing(/atom/movable/target)

proc try_press_on(/mob/user)

proc try_take_thing(/datum/source, /atom/movable/target)

proc update_priority_list()

proc use_thing(/atom/movable/target, hand_is_empty)