ctf_controller

The CTF controller acts as a manager for an individual CTF game, each CTF game should have its own, the controller should handle all game-wide functionality.

Vars
auto_restart	When this CTF match ends should it automatically restart.
barricades	List of all barricades that have been destroyed during this CTF game.
control_points	List of all control points used by the game, if they exist.
ctf_enabled	Whether or not this CTF game is running.
game_id	The ID associated with this CTF game.
instagib_mode	Weather or not instagib mode has been enabled.
points_to_win	How many points a team needs to win.
respawn_cooldown	How long till players who die can respawn.
teams	List of all team_datums participating in this game.
victory_rejoin_text	The text shown once this CTF match ends.
Procs
add_player	Adds a player and a reference to their player component to the corresponding team.
add_team	Add an additional team to the current CTF game.
capture_flag	Called when a flag is captured by the provided team. Messages players telling them who scored a point and if points are high enough declares victory.
clear_control_points	Marks all control points as neutral, called when a CTF match ends.
control_point_scoring	Called when points are scored at a control point. Messages players telling them when a team is half way to winning and if points are high enough declares victory.
get_all_players	Returns a list of all players in all teams.
get_player_component	Returns a reference to a players component (if it exists) when provided with a player's ckey
get_players	Returns a list of all players in the provided team.
get_points	Returns the current amount of points the provided team has.
message_all_teams	Sends a message to all players in all CTF teams in this game.
remove_team	Called when a spawner is deleted, removes the team from this datum.
respawn_barricades	Respawns all barricades destroyed during the current CTF game, called when the match ends.
setup_rules	Some CTF maps may require alternate rulesets, this proc is called by the medisim spawners and CTF maploading.
team_valid_to_join	Identifies if the provided team is a valid team to join for the provided player.
toggle_instagib_mode	Enables and disables instagib mode in this game. During instagib mode respawns are faster, players are faster and people die faster (instant).
unload_ctf	Unloading CTF removes the map entirely and allows for a new map to be loaded in its place.
victory	Ends the current CTF game and informs all players which team won. Restarts CTF if auto_restart is enabled.

Var Details

var
auto_restart
–

When this CTF match ends should it automatically restart.

var
barricades
– /list/obj/effect/ctf/dead_barricade

List of all barricades that have been destroyed during this CTF game.

var
control_points
– /list/obj/machinery/ctf/control_point

List of all control points used by the game, if they exist.

var
ctf_enabled
–

Whether or not this CTF game is running.

var
game_id
–

The ID associated with this CTF game.

var
instagib_mode
–

Weather or not instagib mode has been enabled.

var
points_to_win
–

How many points a team needs to win.

var
respawn_cooldown
–

How long till players who die can respawn.

var
teams
– /list/datum/ctf_team

List of all team_datums participating in this game.

var
victory_rejoin_text
–

The text shown once this CTF match ends.

Proc Details

proc
add_player
(team_color, ckey, /datum/component/ctf_player/new_team_member)

Adds a player and a reference to their player component to the corresponding team.

proc
add_team
(/obj/machinery/ctf/spawner/spawner)

Add an additional team to the current CTF game.

proc
capture_flag
(team_color, /mob/living/user, team_span, /obj/item/ctf_flag/flag)

Called when a flag is captured by the provided team. Messages players telling them who scored a point and if points are high enough declares victory.

proc
clear_control_points
()

Marks all control points as neutral, called when a CTF match ends.

proc
control_point_scoring
(team_color, points)

Called when points are scored at a control point. Messages players telling them when a team is half way to winning and if points are high enough declares victory.

proc
get_all_players
()

Returns a list of all players in all teams.

proc
get_player_component
(team_color, ckey)

Returns a reference to a players component (if it exists) when provided with a player's ckey

proc
get_players
(team_color)

Returns a list of all players in the provided team.

proc
get_points
(team_color)

Returns the current amount of points the provided team has.

proc
message_all_teams
(message)

Sends a message to all players in all CTF teams in this game.

proc
remove_team
(team_color)

Called when a spawner is deleted, removes the team from this datum.

proc
respawn_barricades
()

Respawns all barricades destroyed during the current CTF game, called when the match ends.

proc
setup_rules
(points_to_win, victory_rejoin_text, auto_restart)

Some CTF maps may require alternate rulesets, this proc is called by the medisim spawners and CTF maploading.

proc
team_valid_to_join
(team_color, /mob/user)

Identifies if the provided team is a valid team to join for the provided player.

proc
toggle_instagib_mode
()

Enables and disables instagib mode in this game. During instagib mode respawns are faster, players are faster and people die faster (instant).

proc
unload_ctf
()

Unloading CTF removes the map entirely and allows for a new map to be loaded in its place.

proc
victory
(winning_team)

Ends the current CTF game and informs all players which team won. Restarts CTF if auto_restart is enabled.

ctf_controller /datum/ctf_controller

Vars

Procs

Var Details

var auto_restart –

var barricades – /list/obj/effect/ctf/dead_barricade

var control_points – /list/obj/machinery/ctf/control_point

var ctf_enabled –

var game_id –

var instagib_mode –

var points_to_win –

var respawn_cooldown –

var teams – /list/datum/ctf_team

var victory_rejoin_text –

Proc Details

proc add_player(team_color, ckey, /datum/component/ctf_player/new_team_member)

proc add_team(/obj/machinery/ctf/spawner/spawner)

proc capture_flag(team_color, /mob/living/user, team_span, /obj/item/ctf_flag/flag)

proc clear_control_points()

proc control_point_scoring(team_color, points)

proc get_all_players()

proc get_player_component(team_color, ckey)

proc get_players(team_color)

proc get_points(team_color)

proc message_all_teams(message)

proc remove_team(team_color)

proc respawn_barricades()

proc setup_rules(points_to_win, victory_rejoin_text, auto_restart)

proc team_valid_to_join(team_color, /mob/user)

proc toggle_instagib_mode()

proc unload_ctf()

proc victory(winning_team)