bot
/mob/living/simple_animal/bot

Vars
Radio	The bot's radio, for speaking to people.
access_card	The ID card that the bot "holds".
ai_waypoint	The end point of a bot's path, or the target location.
all_access	All access ID holder
allow_pai	Are we even allowed to insert a pai card.
auto_patrol	Set to `TRUE` make bot automatically patrol.
awaiting_beacon	Count of pticks awaiting a beacon response.
base_speed	The speed at which the bot moves, or the number of times it moves per process() tick.
blockcount	Number of times retried a blocked path.
bot_filter	The radio filter the bot uses to identify itself on the network.
bot_type	The type of bot it is, for radio control.
calling_ai	Links a bot to the AI calling it.
control_freq	Bot control frequency
data_hud_type	The type of data HUD the bot uses. Diagnostic by default.
declare_message	What the bot will display to the HUD user.
destination	Destination description tag.
frustration	Used by some bots for tracking failures to reach their target.
hacked	Used to differentiate between being hacked by silicons and emagged by humans.
hijacked	Being hijacked by a pulse demon?
ignore_list	List of unreachable targets for an ignore-list enabled bot to ignore.
ignorelistcleanuptimer	This ticks up every automated action, at 300 we clean the ignore list
mode	Standardizes the vars that indicate the bot is busy with its function.
mode_name	This holds text for what the bot is mode doing, reported on the remote bot control interface.
model	The type of bot it is.
nearest_beacon	The nearest beacon's tag.
nearest_beacon_loc	The nearest beacon's location.
new_destination	Pending new destination (waiting for beacon response).
next_destination	Next destination in the patrol route.
open	Maint panel
paicard	Inserted pai card.
path	List of turfs through which a bot 'steps' to reach the waypoint.
patrol_target	This is turf to navigate to (location of beacon).
radio_channel	The bot's default radio channel.
radio_config	Which channels can the bot listen to.
remote_disabled	If enabled, the AI cannot Remotely control a bot. It can still control it through cameras.
summon_target	The turf of a user summoning a bot.
text_dehack	Text shown when resetting a bots hacked status to normal.
text_dehack_fail	Shown when a silicon tries to reset a bot emagged with the emag item, which cannot be reset.
text_hack	Custom text returned to a silicon upon hacking a bot.
tries	Number of times the bot tried and failed to move.
window_width	0 for default size
Procs
bot_move	Movement proc for stepping a bot through a path generated through A-star. Pass a positive integer as an argument to override a bot's default speed.
calc_path	Calculates a path to the current destination, given an optional turf to avoid.
find_patrol_target	Finds the nearest beacon to self.
patrol_step	Perform a single patrol step.
post_signal	Send a radio signal with a single data key/value pair.
post_signal_multiple	Send a radio signal with multiple data key/values.
process_scan	When the scan finds a target, run bot specific processing to select it for the next step. Empty by default.
send_status	Signals bot status etc. to controller.
topic_denied	Access check proc for bot topics! Remember to place in a bot's individual Topic if desired.

Var Details

var
Radio
– /obj/item/radio/bot

The bot's radio, for speaking to people.

var
access_card
– /obj/item/card/id

The ID card that the bot "holds".

var
ai_waypoint
– /turf

The end point of a bot's path, or the target location.

var
all_access
– /static/obj/item/card/id

All access ID holder

var
allow_pai
–

Are we even allowed to insert a pai card.

var
auto_patrol
–

Set to TRUE make bot automatically patrol.

var
awaiting_beacon
–

Count of pticks awaiting a beacon response.

var
base_speed
–

The speed at which the bot moves, or the number of times it moves per process() tick.

var
blockcount
–

Number of times retried a blocked path.

var
bot_filter
–

The radio filter the bot uses to identify itself on the network.

var
bot_type
–

The type of bot it is, for radio control.

var
calling_ai
– /mob/living/silicon/ai

Links a bot to the AI calling it.

var
control_freq
–

Bot control frequency

var
data_hud_type
–

The type of data HUD the bot uses. Diagnostic by default.

var
declare_message
–

What the bot will display to the HUD user.

var
destination
–

Destination description tag.

var
frustration
–

Used by some bots for tracking failures to reach their target.

var
hacked
–

Used to differentiate between being hacked by silicons and emagged by humans.

var
hijacked
–

Being hijacked by a pulse demon?

var
ignore_list
– /list

List of unreachable targets for an ignore-list enabled bot to ignore.

var
ignorelistcleanuptimer
–

This ticks up every automated action, at 300 we clean the ignore list

var
mode
–

Standardizes the vars that indicate the bot is busy with its function.

var
mode_name
– /list

This holds text for what the bot is mode doing, reported on the remote bot control interface.

var
model
–

The type of bot it is.

var
nearest_beacon
–

The nearest beacon's tag.

var
nearest_beacon_loc
– /turf

The nearest beacon's location.

var
new_destination
–

Pending new destination (waiting for beacon response).

var
next_destination
–

Next destination in the patrol route.

var
open
–

Maint panel

var
paicard
– /obj/item/paicard

Inserted pai card.

var
path
– /list

List of turfs through which a bot 'steps' to reach the waypoint.

var
patrol_target
– /turf

This is turf to navigate to (location of beacon).

var
radio_channel
–

The bot's default radio channel.

var
radio_config
– /list

Which channels can the bot listen to.

var
remote_disabled
–

If enabled, the AI cannot Remotely control a bot. It can still control it through cameras.

var
summon_target
– /turf

The turf of a user summoning a bot.

var
text_dehack
–

Text shown when resetting a bots hacked status to normal.

var
text_dehack_fail
–

Shown when a silicon tries to reset a bot emagged with the emag item, which cannot be reset.

var
text_hack
–

Custom text returned to a silicon upon hacking a bot.

var
tries
–

Number of times the bot tried and failed to move.

var
window_width
–

0 for default size

Proc Details

proc
bot_move
(dest, move_speed)

Movement proc for stepping a bot through a path generated through A-star. Pass a positive integer as an argument to override a bot's default speed.

proc
calc_path
(/turf/avoid)

Calculates a path to the current destination, given an optional turf to avoid.

proc
find_patrol_target
()

Finds the nearest beacon to self.

proc
patrol_step
()

Perform a single patrol step.

proc
post_signal
(freq, key, value)

Send a radio signal with a single data key/value pair.

proc
post_signal_multiple
(freq, /list/keyval)

Send a radio signal with multiple data key/values.

proc
process_scan
(/atom/scan_target)

When the scan finds a target, run bot specific processing to select it for the next step. Empty by default.

proc
send_status
()

Signals bot status etc. to controller.

proc
topic_denied
(/mob/user)

Access check proc for bot topics! Remember to place in a bot's individual Topic if desired.

bot /mob/living/simple_animal/bot

Vars

Procs

Var Details

var Radio – /obj/item/radio/bot

var access_card – /obj/item/card/id

var ai_waypoint – /turf

var all_access – /static/obj/item/card/id

var allow_pai –

var auto_patrol –

var awaiting_beacon –

var base_speed –

var blockcount –

var bot_filter –

var bot_type –

var calling_ai – /mob/living/silicon/ai

var control_freq –

var data_hud_type –

var declare_message –

var destination –

var frustration –

var hacked –

var hijacked –

var ignore_list – /list

var ignorelistcleanuptimer –

var mode –

var mode_name – /list

var model –

var nearest_beacon –

var nearest_beacon_loc – /turf

var new_destination –

var next_destination –

var open –

var paicard – /obj/item/paicard

var path – /list

var patrol_target – /turf

var radio_channel –

var radio_config – /list

var remote_disabled –

var summon_target – /turf

var text_dehack –

var text_dehack_fail –

var text_hack –

var tries –

var window_width –