/tg/ Station 13 - Modules - TypesVar Details - Proc Details

bot

Vars

ai_waypointThe end point of a bot's path, or the target location.
automated_announcementsList of strings to sound effects corresponding to automated messages the bot can play
base_speedThe speed at which the bot moves, or the number of times it moves per process() tick.
bot_cover_flagsBot-related cover flags on the Bot to deal with what has been done to their cover, including emagging. BOT_COVER_MAINTS_OPEN | BOT_COVER_LOCKED | BOT_COVER_EMAGGED | BOT_COVER_HACKED
bot_mode_flagsBot-related mode flags on the Bot indicating how they will act. BOT_MODE_ON | BOT_MODE_AUTOPATROL | BOT_MODE_REMOTE_ENABLED | BOT_MODE_CAN_BE_SAPIENT | BOT_MODE_ROUNDSTART_POSSESSION
bot_typeThe type of bot it is, for radio control.
calling_aiLinks a bot to the AI calling it.
can_be_possessedIf true we will allow ghosts to control this mob
data_hud_typeThe type of data HUD the bot uses. Diagnostic by default.
destinationDestination description tag
frustrationUsed by some bots for tracking failures to reach their target.
hackablesSmall name of what the bot gets messed with when getting hacked/emagged.
ignore_listList of unreachable targets for an ignore-list enabled bot to ignore.
internal_radioThe bot's radio, for speaking to people.
modeStandardizes the vars that indicate the bot is busy with its function.
nearest_beaconthe nearest beacon's tag
nearest_beacon_locThe nearest beacon's location
new_destinationPending new destination (waiting for beacon response)
next_destinationThe next destination in the patrol route
next_salute_checkCooldown between salutations for commissioned bots
offer_ghosts_cooldownIf true we will offer this
pa_systemAction we use to say voice lines out loud, also we just pass anything we try to say through here just in case it plays a voice line
paicardThe inserted (if any) pAI in this bot.
pathList of turfs through which a bot 'steps' to reach the waypoint, associated with the path image, if there is one.
pathsetThe bot is on a custom set path.
patrol_targetTurf a bot is summoned to navitage towards.
player_accessAdditonal access given to player-controlled bots.
possessed_messageMessage to display upon possession
prev_accessAll initial access this bot started with.
radio_channelThe bot's default radio channel
radio_keywhich channels can the bot listen to
robot_armThe Robot arm attached to this robot - has a 50% chance to drop on death.
summon_targetTurf of a user summoning a bot towards their location.
triesNumber of times the bot tried and failed to move.

Procs

bot_stepPerforms a step_towards and increments the path if successful. Returns TRUE if the bot moved and FALSE otherwise.
check_possessionReturns true if this mob can be controlled
disable_possessionDisables this bot from being possessed by ghosts
ejectpaiEjects a pAI from this bot
ejectpairemoteEjects the pAI remotely.
enable_possessionAllows this bot to be controlled by a ghost, who will become its mind
get_emagged_messageReturns a string of flavor text for emagged bots as defined by policy.
get_mode_uiReturns a status string about the bot's current status, if it's moving, manually controlled, or idle.
insertpaiPlaces a pAI in control of this mob
post_possessionFired after something takes control of this mob
renameAllows renaming the bot to something else
scanAttempt to scan tiles near [src], first by checking adjacent, then if a target is still not found, nearby.
speakPass a message to have the bot say() it, passing through our announcement action to potentially also play a sound. Optionally pass a frequency to say it on the radio.
topic_deniedAccess check proc for bot topics! Remember to place in a bot's individual Topic if desired.

Var Details

ai_waypoint

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

automated_announcements

List of strings to sound effects corresponding to automated messages the bot can play

base_speed

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

bot_cover_flags

Bot-related cover flags on the Bot to deal with what has been done to their cover, including emagging. BOT_COVER_MAINTS_OPEN | BOT_COVER_LOCKED | BOT_COVER_EMAGGED | BOT_COVER_HACKED

bot_mode_flags

Bot-related mode flags on the Bot indicating how they will act. BOT_MODE_ON | BOT_MODE_AUTOPATROL | BOT_MODE_REMOTE_ENABLED | BOT_MODE_CAN_BE_SAPIENT | BOT_MODE_ROUNDSTART_POSSESSION

bot_type

The type of bot it is, for radio control.

calling_ai

Links a bot to the AI calling it.

can_be_possessed

If true we will allow ghosts to control this mob

data_hud_type

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

destination

Destination description tag

frustration

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

hackables

Small name of what the bot gets messed with when getting hacked/emagged.

ignore_list

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

internal_radio

The bot's radio, for speaking to people.

mode

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

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

The next destination in the patrol route

next_salute_check

Cooldown between salutations for commissioned bots

offer_ghosts_cooldown

If true we will offer this

pa_system

Action we use to say voice lines out loud, also we just pass anything we try to say through here just in case it plays a voice line

paicard

The inserted (if any) pAI in this bot.

path

List of turfs through which a bot 'steps' to reach the waypoint, associated with the path image, if there is one.

pathset

The bot is on a custom set path.

patrol_target

Turf a bot is summoned to navitage towards.

player_access

Additonal access given to player-controlled bots.

possessed_message

Message to display upon possession

prev_access

All initial access this bot started with.

radio_channel

The bot's default radio channel

radio_key

which channels can the bot listen to

robot_arm

The Robot arm attached to this robot - has a 50% chance to drop on death.

summon_target

Turf of a user summoning a bot towards their location.

tries

Number of times the bot tried and failed to move.

Proc Details

bot_step

Performs a step_towards and increments the path if successful. Returns TRUE if the bot moved and FALSE otherwise.

check_possession

Returns true if this mob can be controlled

disable_possession

Disables this bot from being possessed by ghosts

ejectpai

Ejects a pAI from this bot

ejectpairemote

Ejects the pAI remotely.

enable_possession

Allows this bot to be controlled by a ghost, who will become its mind

get_emagged_message

Returns a string of flavor text for emagged bots as defined by policy.

get_mode_ui

Returns a status string about the bot's current status, if it's moving, manually controlled, or idle.

insertpai

Places a pAI in control of this mob

post_possession

Fired after something takes control of this mob

rename

Allows renaming the bot to something else

scan

Attempt to scan tiles near [src], first by checking adjacent, then if a target is still not found, nearby.

scan_types - list (of typepaths) that nearby tiles are being scanned for. old_target - what has already been scanned, and will early return at checkscan. scan_range - how far away from [src] will be scanned, if nothing is found directly adjacent.

speak

Pass a message to have the bot say() it, passing through our announcement action to potentially also play a sound. Optionally pass a frequency to say it on the radio.

topic_denied

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