flock

Vars
active_pings	A k:V list of client : image, see ping().
bandwidth	The total amount of computational power available, before whats being used.
bits	The bits
current_egg_cost	The current substrate cost to lay an egg.
drones	The drones
enemies	A k:v list of mob : details, contains enemy mobs.
flock_game_status	Flock status, won, lost, etc
ignores	A k:V list of mob : TRUE, where mob is mobs that ai will ignore.
marked_for_conversion	A k:V list of atoms the Overmind has marked for conversion, where the value is TRUE
marked_for_deconstruction	A k:v list of atoms the Overmind has marked for deconstruction, where the value is TRUE
max_traces	The maximum amount of traces allowed.
notice_images	Cache of images used by notices.
overmind	The master of the flock
structures	Every structure we've built.
traces	The traces
turf_reservations	A k:V list of reserved_turf = TRUE.
turf_reservations_by_flock	A k:V list of flock mobs to their reserved turf.
ui_tab	Current UI tab, saves on data sending.
used_bandwidth	The computational power being used.
Procs
add_bandwidth_influence	Wrapper for handling bandwidth alongside used_bandwidth for new mobs
add_ignore	Adds a mob to the ignored list.
add_notice	Places a flock notice on an atom. See flock_defines.dm
add_ping_image	Helper for adding a ping image to a client's screen and handling clean up.
add_structure	Add a structure to the flock.
add_unit	Adds a unit to the flock and sets up all of the tracking.
available_bandwidth	Returns the amount of available bandwidth. Can return negative if over budget.
can_afford	Returns TRUE if the flock has the required bandwidth
claim_turf	Claim it for the flock, optionally converting it. Converting should only be avoided if the turf is already a flockturf.
claimed_turf_change	Called when a turf owned by the flock changes.
cleanup_ping_images	Called by add_ping_image via timer callback.
consider_game_over	Ends the flock if it is unable to continue spreading.
create_hud_images	Instantiates all of the flock notice image singletons.
create_structure	Wrapper for spawning a tealprint, used by Create Structure
deconstruct_mark_deleted	Called when an atom marked for deconstruction is qdeleted.
free_structure	Remove a structure from the flock.
free_turf	Free a turf from reservation, allowing AI to target it again. override_turf can be given to lookup the user if there isnt a user in this context.
free_unit	Removes a unit from the flock.
game_over	Kills off the flock. Pass completely_destroy = FALSE to allow the overmind to live on.
get_egg_elligibility_cost	Returns the substract requirement to be able to spend substrate on an egg. See above proc.
get_priority_turfs	Returns a list of turfs marked for conversion, minus turfs that drones have already reserved.
get_total_health_percentage	Returns the total percentage of the sum of every mob's health and max health.
get_total_substrate	Returns the total amount of substrate by all flock mobs.
is_mob_enemy	Returns TRUE if the given mob is an enemy.
is_mob_ignored	Returns TRUE if the given mob is ignored by the flock.
is_on_safe_z	Checks to see if the given atom is allowed to be there. Has lots of behavior like making drones dormant and snapping traces back to the station.
is_turf_free	Returns TRUE if the given turf is not reserved.
on_client_gone	Called when a client holding a ping image disconnects.
on_enemy_gone	Called when an enemy atom is deleted.
on_ignore_gone	Called when an ignored mob is deleted.
on_unit_death	Called when a unit under the flock's control dies.
ping	Pings a location, alerting all flocktraces.
refresh_unlockables	Refreshes the status of every unlockable.
register_overmind	Sets the flock's overmind
remove_bandwidth_influence	Wrapper for handling bandwidth alongside used_bandwidth for mobs leaving the flock
remove_enemy	Removes an atom from the enemies list.
remove_ignore	Removes a mob from the ignore list.
remove_notice	Removes a flock notice from an atom.
reserve_turf	Reserves a turf, making AI ignore it for the purposes of targetting.
reserved_turf_change	Called when a turf reserved by a flock mob changes.
set_flock_game_status	Setter for flock_game_status.
start	Called after everything is setup, and clients are in control of their mobs.
stop_tracking_turf	Stop tracking a turf that is in our claimed walls or claimed floors lists.
toggle_deconstruction_mark	(un)Mark a flock atom for deconstruction. Returns FALSE if it cannot be deconstructed.
total_bandwidth	Returns the total amount of bandwidth, including bandwidth being used.
update_egg_cost	Updates the substrate cost of an egg given the current status of the flock.
update_enemy	Updates a mob's enemy status. If they are already an enemy, their entry will be updated with new information.
update_relay_huds	Update the relay status huds for all flock traces and the overmind.

Var Details

var
active_pings
– /list

A k:V list of client : image, see ping().

var
bandwidth
– /datum/point_holder

The total amount of computational power available, before whats being used.

var
bits
– /list

The bits

var
current_egg_cost

The current substrate cost to lay an egg.

var
drones
– /list

The drones

var
enemies
– /list

A k:v list of mob : details, contains enemy mobs.

var
flock_game_status

Flock status, won, lost, etc

var
ignores
– /list

A k:V list of mob : TRUE, where mob is mobs that ai will ignore.

var
marked_for_conversion
– /list

A k:V list of atoms the Overmind has marked for conversion, where the value is TRUE

var
marked_for_deconstruction
– /list

A k:v list of atoms the Overmind has marked for deconstruction, where the value is TRUE

var
max_traces

The maximum amount of traces allowed.

var
notice_images
– /list

Cache of images used by notices.

var
overmind
– /mob/camera/flock/overmind

The master of the flock

var
structures
– /list

Every structure we've built.

var
traces
– /list

The traces

var
turf_reservations
– /list

A k:V list of reserved_turf = TRUE.

var
turf_reservations_by_flock
– /list

A k:V list of flock mobs to their reserved turf.

var
ui_tab

Current UI tab, saves on data sending.

var
used_bandwidth

The computational power being used.

Proc Details

proc
add_bandwidth_influence
(num)

Wrapper for handling bandwidth alongside used_bandwidth for new mobs

proc
add_ignore
(/atom/movable/ignore)

Adds a mob to the ignored list.

proc
add_notice
(/atom/target, notice_type)

Places a flock notice on an atom. See flock_defines.dm

proc
add_ping_image
(/client/C, /image/ping, duration)

Helper for adding a ping image to a client's screen and handling clean up.

proc
add_structure
(/obj/structure/flock/struct)

Add a structure to the flock.

proc
add_unit
(/mob/unit)

Adds a unit to the flock and sets up all of the tracking.

proc
available_bandwidth
()

Returns the amount of available bandwidth. Can return negative if over budget.

proc
can_afford
(amt)

Returns TRUE if the flock has the required bandwidth

proc
claim_turf
(/turf/T, convert)

Claim it for the flock, optionally converting it. Converting should only be avoided if the turf is already a flockturf.

proc
claimed_turf_change
(/turf/source)

Called when a turf owned by the flock changes.

proc
cleanup_ping_images
(/client/C, /list/images_to_clean)

Called by add_ping_image via timer callback.

proc
consider_game_over
()

Ends the flock if it is unable to continue spreading.

proc
create_hud_images
()

Instantiates all of the flock notice image singletons.

proc
create_structure
(/turf/location, structure_type)

Wrapper for spawning a tealprint, used by Create Structure

proc
deconstruct_mark_deleted
(/datum/source)

Called when an atom marked for deconstruction is qdeleted.

proc
free_structure
(/obj/structure/flock/struct)

Remove a structure from the flock.

proc
free_turf
(/mob/living/simple_animal/flock/user, /turf/override_turf)

Free a turf from reservation, allowing AI to target it again. override_turf can be given to lookup the user if there isnt a user in this context.

proc
free_unit
(/mob/unit)

Removes a unit from the flock.

proc
game_over
(completely_destroy)

Kills off the flock. Pass completely_destroy = FALSE to allow the overmind to live on.

proc
get_egg_elligibility_cost
()

Returns the substract requirement to be able to spend substrate on an egg. See above proc.

proc
get_priority_turfs
(/mob/living/simple_animal/flock/bird)

Returns a list of turfs marked for conversion, minus turfs that drones have already reserved.

proc
get_total_health_percentage
()

Returns the total percentage of the sum of every mob's health and max health.

proc
get_total_substrate
()

Returns the total amount of substrate by all flock mobs.

proc
is_mob_enemy
(/mob/M)

Returns TRUE if the given mob is an enemy.

proc
is_mob_ignored
(/mob/M)

Returns TRUE if the given mob is ignored by the flock.

proc
is_on_safe_z
(/atom/A)

Checks to see if the given atom is allowed to be there. Has lots of behavior like making drones dormant and snapping traces back to the station.

proc
is_turf_free
(/turf/T)

Returns TRUE if the given turf is not reserved.

proc
on_client_gone
(/client/source)

Called when a client holding a ping image disconnects.

proc
on_enemy_gone
(/datum/source)

Called when an enemy atom is deleted.

proc
on_ignore_gone
(/datum/source)

Called when an ignored mob is deleted.

proc
on_unit_death
(/datum/source)

Called when a unit under the flock's control dies.

proc
ping
(/turf/T, /mob/camera/flock/pinger)

Pings a location, alerting all flocktraces.

proc
refresh_unlockables
()

Refreshes the status of every unlockable.

proc
register_overmind
(/mob/camera/flock_overmind)

Sets the flock's overmind

proc
remove_bandwidth_influence
(num)

Wrapper for handling bandwidth alongside used_bandwidth for mobs leaving the flock

proc
remove_enemy
(/atom/movable/enemy, skip_buckled)

Removes an atom from the enemies list.

proc
remove_ignore
(/atom/movable/ignore, skip_buckled)

Removes a mob from the ignore list.

proc
remove_notice
(/atom/target, notice_type)

Removes a flock notice from an atom.

proc
reserve_turf
(/mob/living/simple_animal/flock/user, /turf/target, remove_on_change)

Reserves a turf, making AI ignore it for the purposes of targetting.

proc
reserved_turf_change
(/datum/source)

Called when a turf reserved by a flock mob changes.

proc
set_flock_game_status
(new_status)

Setter for flock_game_status.

proc
start
()

Called after everything is setup, and clients are in control of their mobs.

proc
stop_tracking_turf
(/turf/T)

Stop tracking a turf that is in our claimed walls or claimed floors lists.

proc
toggle_deconstruction_mark
(/atom/A)

(un)Mark a flock atom for deconstruction. Returns FALSE if it cannot be deconstructed.

proc
total_bandwidth
()

Returns the total amount of bandwidth, including bandwidth being used.

proc
update_egg_cost
()

Updates the substrate cost of an egg given the current status of the flock.

proc
update_enemy
(/atom/movable/enemy)

Updates a mob's enemy status. If they are already an enemy, their entry will be updated with new information.

proc
update_relay_huds
()

Update the relay status huds for all flock traces and the overmind.

flock /datum/flock

Vars

Procs

Var Details

var active_pings – /list

var bandwidth – /datum/point_holder

var bits – /list

var current_egg_cost

var drones – /list

var enemies – /list

var flock_game_status

var ignores – /list

var marked_for_conversion – /list

var marked_for_deconstruction – /list

var max_traces

var notice_images – /list

var overmind – /mob/camera/flock/overmind

var structures – /list

var traces – /list

var turf_reservations – /list

var turf_reservations_by_flock – /list

var ui_tab

var used_bandwidth

Proc Details

proc add_bandwidth_influence(num)

proc add_ignore(/atom/movable/ignore)

proc add_notice(/atom/target, notice_type)

proc add_ping_image(/client/C, /image/ping, duration)

proc add_structure(/obj/structure/flock/struct)

proc add_unit(/mob/unit)

proc available_bandwidth()

proc can_afford(amt)

proc claim_turf(/turf/T, convert)

proc claimed_turf_change(/turf/source)

proc cleanup_ping_images(/client/C, /list/images_to_clean)

proc consider_game_over()

proc create_hud_images()

proc create_structure(/turf/location, structure_type)

proc deconstruct_mark_deleted(/datum/source)

proc free_structure(/obj/structure/flock/struct)

proc free_turf(/mob/living/simple_animal/flock/user, /turf/override_turf)

proc free_unit(/mob/unit)

proc game_over(completely_destroy)

proc get_egg_elligibility_cost()

proc get_priority_turfs(/mob/living/simple_animal/flock/bird)

proc get_total_health_percentage()

proc get_total_substrate()

proc is_mob_enemy(/mob/M)

proc is_mob_ignored(/mob/M)

proc is_on_safe_z(/atom/A)

proc is_turf_free(/turf/T)

proc on_client_gone(/client/source)

proc on_enemy_gone(/datum/source)

proc on_ignore_gone(/datum/source)

proc on_unit_death(/datum/source)

proc ping(/turf/T, /mob/camera/flock/pinger)

proc refresh_unlockables()

proc register_overmind(/mob/camera/flock_overmind)

proc remove_bandwidth_influence(num)

proc remove_enemy(/atom/movable/enemy, skip_buckled)

proc remove_ignore(/atom/movable/ignore, skip_buckled)

proc remove_notice(/atom/target, notice_type)

proc reserve_turf(/mob/living/simple_animal/flock/user, /turf/target, remove_on_change)

proc reserved_turf_change(/datum/source)

proc set_flock_game_status(new_status)

proc start()

proc stop_tracking_turf(/turf/T)

proc toggle_deconstruction_mark(/atom/A)

proc total_bandwidth()

proc update_egg_cost()

proc update_enemy(/atom/movable/enemy)

proc update_relay_huds()