cTeamGather Class Reference

Private Member Functions
function	__create_client_hud_elem (alignX, alignY, horzAlign, vertAlign, xOffset, yOffset, fontScale, color, str_text)
function	cleanup ()
function	cleanup_floor_effect ()
	constructor ()
function	create_player_huds ()
function	create_teamgather_event (v_interact_pos, v_interact_angles, v_gather_pos, e_interact_entity)
	destructor ()
function	display_hud_player_leader (e_player)
function	display_hud_player_team_member (e_player)
function	gather_players ()
function	get_players_playing ()
function	get_time_remaining ()
function	get_time_remaining_in_seconds ()
function	interact_entity_highlight (highlight_object)
function	is_player_in_gather_position (e_player)
function	is_teamgather_complete ()
function	onUseGameobject (player)
function	player_lowready_state (lower_weapon)
function	players_in_position (in_position)
function	set_teamgather_complete (success)
function	setup_gameobject (v_pos, STR_MODEL, STR_USE_HINT, e_los_ignore_me)
function	spawn_floor_effect ()
function	start_player_timer (total_time)
function	team_member_zoom_button_check (e_player)
function	teamgather_failure ()
function	teamgather_main_update ()
function	teamgather_success ()
function	teleport_player_into_position (e_player)
function	update_players_in_radius (force_player_into_position)

Private Attributes
var	e_gameobject
var	m_e_interact_entity
var	m_e_player_leader
var	m_gather_fx
var	m_num_players
var	m_num_players_ready
var	m_success
var	m_teamgather_complete
var	m_v_gather_position
var	m_v_interact_angles
var	m_v_interact_position
var	n_font_scale
var	v_font_color

Detailed Description

Definition at line 75 of file teamgather_shared.gsc.

Member Function Documentation

__create_client_hud_elem()

function cTeamGather::__create_client_hud_elem ( alignX  , alignY  , horzAlign  , vertAlign  , xOffset  , yOffset  , fontScale  , color  , str_text    )

private

Definition at line 811 of file teamgather_shared.gsc.

Referenced by display_hud_player_leader(), and teamgather_success().

cleanup()

function cTeamGather::cleanup ( )

private

Definition at line 122 of file teamgather_shared.gsc.

References cleanup_floor_effect(), destroy_object(), and e_gameobject.

cleanup_floor_effect()

function cTeamGather::cleanup_floor_effect ( )

private

Definition at line 326 of file teamgather_shared.gsc.

References FLOOR_EFFECTS_ACTIVE, and IS_TRUE.

Referenced by cleanup().

constructor()

cTeamGather::constructor ( )

private

Definition at line 99 of file teamgather_shared.gsc.

References e_gameobject, m_num_players, m_teamgather_complete, n_font_scale, and v_font_color.

create_player_huds()

function cTeamGather::create_player_huds ( )

private

Definition at line 378 of file teamgather_shared.gsc.

References display_hud_player_leader(), display_hud_player_team_member(), get_players_playing(), and m_e_player_leader.

Referenced by gather_players().

create_teamgather_event()

function cTeamGather::create_teamgather_event ( v_interact_pos  , v_interact_angles  , v_gather_pos  , e_interact_entity    )

private

Definition at line 130 of file teamgather_shared.gsc.

References m_v_interact_angles, and m_v_interact_position.

destructor()

cTeamGather::destructor ( )

private

Definition at line 116 of file teamgather_shared.gsc.

display_hud_player_leader()

function cTeamGather::display_hud_player_leader ( e_player  )

private

Definition at line 707 of file teamgather_shared.gsc.

References __create_client_hud_elem(), array, is_teamgather_complete(), m_num_players, m_num_players_ready, n_font_scale, and v_font_color.

Referenced by create_player_huds().

display_hud_player_team_member()

function cTeamGather::display_hud_player_team_member ( e_player  )

private

Definition at line 750 of file teamgather_shared.gsc.

Referenced by create_player_huds().

gather_players()

function cTeamGather::gather_players ( )

private

Definition at line 362 of file teamgather_shared.gsc.

References create_player_huds(), GATHER_COUNTDOWN, start_player_timer(), and teamgather_main_update().

get_players_playing()

function cTeamGather::get_players_playing ( )

private

Definition at line 878 of file teamgather_shared.gsc.

Referenced by create_player_huds(), teamgather_failure(), teamgather_success(), teleport_player_into_position(), and update_players_in_radius().

get_time_remaining()

function cTeamGather::get_time_remaining ( )

private

Definition at line 843 of file teamgather_shared.gsc.

Referenced by get_time_remaining_in_seconds().

get_time_remaining_in_seconds()

function cTeamGather::get_time_remaining_in_seconds ( )

private

Definition at line 854 of file teamgather_shared.gsc.

References GATHER_COUNTDOWN, and get_time_remaining().

Referenced by get_time_remaining_in_seconds().

interact_entity_highlight()

function cTeamGather::interact_entity_highlight ( highlight_object  )

private

Definition at line 343 of file teamgather_shared.gsc.

References m_e_interact_entity.

is_player_in_gather_position()

function cTeamGather::is_player_in_gather_position ( e_player  )

private

Definition at line 568 of file teamgather_shared.gsc.

References GATHER_RADIUS, and m_v_gather_position.

Referenced by player_lowready_state().

is_teamgather_complete()

function cTeamGather::is_teamgather_complete ( )

private

Definition at line 405 of file teamgather_shared.gsc.

References m_teamgather_complete.

Referenced by display_hud_player_leader(), and teamgather_main_update().

onUseGameobject()

function cTeamGather::onUseGameobject ( player  )

private

Definition at line 293 of file teamgather_shared.gsc.

player_lowready_state()

function cTeamGather::player_lowready_state ( lower_weapon  )

private

Definition at line 605 of file teamgather_shared.gsc.

References _disableWeapon(), _enableWeapon(), and isWeaponEnabled().

Referenced by player_lowready_state(), and team_member_zoom_button_check().

players_in_position()

function cTeamGather::players_in_position ( in_position  )

private

Definition at line 491 of file teamgather_shared.gsc.

Referenced by teamgather_main_update().

set_teamgather_complete()

function cTeamGather::set_teamgather_complete ( success  )

private

Definition at line 412 of file teamgather_shared.gsc.

Referenced by teamgather_main_update().

setup_gameobject()

function cTeamGather::setup_gameobject ( v_pos  , STR_MODEL  , STR_USE_HINT  , e_los_ignore_me    )

private

Definition at line 232 of file teamgather_shared.gsc.

References spawn().

spawn_floor_effect()

function cTeamGather::spawn_floor_effect ( )

private

Definition at line 303 of file teamgather_shared.gsc.

start_player_timer()

function cTeamGather::start_player_timer ( total_time  )

private

Definition at line 834 of file teamgather_shared.gsc.

Referenced by gather_players().

team_member_zoom_button_check()

function cTeamGather::team_member_zoom_button_check ( e_player  )

private

Definition at line 628 of file teamgather_shared.gsc.

Referenced by team_member_zoom_button_check().

teamgather_failure()

function cTeamGather::teamgather_failure ( )

private

Definition at line 209 of file teamgather_shared.gsc.

References get_players_playing().

teamgather_main_update()

function cTeamGather::teamgather_main_update ( )

private

Definition at line 422 of file teamgather_shared.gsc.

References is_teamgather_complete(), m_num_players, m_num_players_ready, players_in_position(), set_teamgather_complete(), and update_players_in_radius().

Referenced by gather_players().

teamgather_success()

function cTeamGather::teamgather_success ( )

private

Definition at line 183 of file teamgather_shared.gsc.

References __create_client_hud_elem(), DISPLAY_SUCCESS_TEXT_TIME, get_players_playing(), n_font_scale, and v_font_color.

teleport_player_into_position()

function cTeamGather::teleport_player_into_position ( e_player  )

private

Definition at line 640 of file teamgather_shared.gsc.

References get_players_playing(), m_v_gather_position, m_v_interact_angles, m_v_interact_position, MIN_PLAYER_TELEPORT_DISTANCE, and TELEPORT_RADIUS.

Referenced by display_hud_player_leader(), and player_lowready_state().

update_players_in_radius()

function cTeamGather::update_players_in_radius ( force_player_into_position  )

private

Definition at line 518 of file teamgather_shared.gsc.

References get_players_playing(), and m_num_players.

Referenced by teamgather_main_update().

Field Documentation

e_gameobject

var cTeamGather::e_gameobject

private

Definition at line 77 of file teamgather_shared.gsc.

Referenced by cleanup(), and constructor().

m_e_interact_entity

var cTeamGather::m_e_interact_entity

private

Definition at line 84 of file teamgather_shared.gsc.

Referenced by interact_entity_highlight(), and teamgather_main_update().

m_e_player_leader

var cTeamGather::m_e_player_leader

private

Definition at line 97 of file teamgather_shared.gsc.

Referenced by create_player_huds(), and team_member_zoom_button_check().

m_gather_fx

var cTeamGather::m_gather_fx

private

Definition at line 82 of file teamgather_shared.gsc.

Referenced by create_player_huds().

m_num_players

var cTeamGather::m_num_players

private

Definition at line 89 of file teamgather_shared.gsc.

Referenced by constructor(), display_hud_player_leader(), get_time_remaining_in_seconds(), teamgather_main_update(), and update_players_in_radius().

m_num_players_ready

var cTeamGather::m_num_players_ready

private

Definition at line 90 of file teamgather_shared.gsc.

Referenced by display_hud_player_leader(), get_time_remaining_in_seconds(), player_lowready_state(), and teamgather_main_update().

m_success

var cTeamGather::m_success

private

Definition at line 87 of file teamgather_shared.gsc.

m_teamgather_complete

var cTeamGather::m_teamgather_complete

private

Definition at line 86 of file teamgather_shared.gsc.

Referenced by constructor(), and is_teamgather_complete().

m_v_gather_position

var cTeamGather::m_v_gather_position

private

Definition at line 95 of file teamgather_shared.gsc.

Referenced by create_player_huds(), is_player_in_gather_position(), and teleport_player_into_position().

m_v_interact_angles

var cTeamGather::m_v_interact_angles

private

Definition at line 93 of file teamgather_shared.gsc.

Referenced by create_teamgather_event(), and teleport_player_into_position().

m_v_interact_position

var cTeamGather::m_v_interact_position

private

Definition at line 92 of file teamgather_shared.gsc.

Referenced by create_teamgather_event(), and teleport_player_into_position().

n_font_scale

var cTeamGather::n_font_scale

private

Definition at line 79 of file teamgather_shared.gsc.

Referenced by constructor(), display_hud_player_leader(), and teamgather_success().

v_font_color

var cTeamGather::v_font_color

private

Definition at line 80 of file teamgather_shared.gsc.

Referenced by constructor(), display_hud_player_leader(), and teamgather_success().

---

The documentation for this class was generated from the following file:

• scripts/shared/teamgather_shared.gsc