announcer.qc File Reference

#include "announcer.qh"
#include <client/draw.qh>
#include <client/hud/panel/centerprint.qh>
#include <client/hud/panel/scoreboard.qh>
#include <client/mutators/_mod.qh>
#include <common/notifications/all.qh>
#include <common/stats.qh>
#include <common/mapinfo.qh>
#include <common/ent_cs.qh>

Include dependency graph for announcer.qc:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	ANNOUNCER_CHECKMINUTE(minute)

Functions
void	Announcer ()
void	Announcer_ClearTitle ()
void	Announcer_Countdown (entity this)
void	Announcer_Duel ()
void	Announcer_Gamestart ()
void	Announcer_Time ()
string	AnnouncerOption ()

Variables
bool	announcer_1min
bool	announcer_5min
entity	announcer_countdown
bool	prev_inround
string	prev_pl1_name
	Displays duel title; updates it if the players in-game have changed.
string	prev_pl2_name
float	prev_roundstarttime
float	prev_starttime
float	previous_game_starttime
	Checks whether the server initiated a map restart (stat_game_starttime changed)

Macro Definition Documentation

ANNOUNCER_CHECKMINUTE

#define ANNOUNCER_CHECKMINUTE

(

minute

)

Value:

    MACRO_BEGIN \
    if(announcer_##minute##min) { \
        if(timeleft > minute * 60) \
            announcer_##minute##min = false; \
    } else { \
        if(timeleft < minute * 60 && timeleft > minute * 60 - 1) { \
            announcer_##minute##min = true; \
            Local_Notification(MSG_ANNCE, ANNCE_REMAINING_MIN_##minute); \
        } \
    } \
MACRO_END

Definition at line 176 of file announcer.qc.

#define ANNOUNCER_CHECKMINUTE(minute) MACRO_BEGIN \
    if(announcer_##minute##min) { \
        if(timeleft > minute * 60) \
            announcer_##minute##min = false; \
    } else { \
        if(timeleft < minute * 60 && timeleft > minute * 60 - 1) { \
            announcer_##minute##min = true; \
            Local_Notification(MSG_ANNCE, ANNCE_REMAINING_MIN_##minute); \
        } \
    } \
MACRO_END

Referenced by Announcer_Time().

Function Documentation

Announcer()

void Announcer

(

)

Definition at line 228 of file announcer.qc.

{
    // announcer code sets gametype name as centerprint title
    if(!gametype)
        return;
    Announcer_Gamestart();
    Announcer_Time();
}

References Announcer_Gamestart(), Announcer_Time(), and gametype.

Referenced by CSQC_UpdateView().

Announcer_ClearTitle()

void Announcer_ClearTitle

(

)

Definition at line 48 of file announcer.qc.

{
    strfree(prev_pl1_name);
    strfree(prev_pl2_name);
    centerprint_ClearTitle();
}

References centerprint_ClearTitle(), prev_pl1_name, prev_pl2_name, and strfree.

Referenced by Announcer_Countdown(), and Announcer_Gamestart().

Announcer_Countdown()

void Announcer_Countdown

(

entity

this

)

Definition at line 58 of file announcer.qc.

{
    float starttime = STAT(GAMESTARTTIME);
    float roundstarttime = STAT(ROUNDSTARTTIME);
    if(roundstarttime == -1)
    {
        Local_Notification(MSG_CENTER, CENTER_COUNTDOWN_ROUNDSTOP);
        delete(this);
        announcer_countdown = NULL;
        Announcer_ClearTitle();
        return;
    }
 
    bool inround = (roundstarttime && time >= starttime);
    float countdown = (inround ? roundstarttime - time : starttime - time);
    float countdown_rounded = floor(0.5 + countdown);
 
    if (starttime != prev_starttime || roundstarttime != prev_roundstarttime || prev_inround != inround)
        this.skin = 0; // restart centerprint countdown
 
    if(countdown <= 0) // countdown has finished, starttime is now
    {
        Local_Notification(MSG_CENTER, CENTER_COUNTDOWN_BEGIN);
        Local_Notification(MSG_MULTI, COUNTDOWN_BEGIN);
        delete(this);
        announcer_countdown = NULL;
        Announcer_ClearTitle();
        return;
    }
    else // countdown is still going
    {
        if(inround)
        {
            if(!prev_inround) Announcer_ClearTitle(); // clear title if we just started the match
            if (!this.skin) // first tic
                Local_Notification(MSG_CENTER, CENTER_COUNTDOWN_ROUNDSTART, STAT(ROUNDS_PLAYED) + 1, countdown_rounded);
            Notification annce_num = Announcer_PickNumber(CNT_ROUNDSTART, countdown_rounded);
            if(annce_num != NULL)
                Local_Notification(MSG_ANNCE, annce_num);
            this.nextthink = (roundstarttime - (countdown - 1));
        }
        else
        {
            if (!this.skin) // first tic
                Local_Notification(MSG_CENTER, CENTER_COUNTDOWN_GAMESTART, countdown_rounded);
            Notification annce_num = Announcer_PickNumber(CNT_GAMESTART, countdown_rounded);
            if(!roundstarttime && annce_num != NULL) // Don't announce game start in round based modes
                Local_Notification(MSG_ANNCE, annce_num);
            this.nextthink = (starttime - (countdown - 1));
        }
        // Don't call centerprint countdown in the remaining tics, it will continue automatically.
        // It's an optimization but also fixes ^COUNT shown in the last tic because of high slowmo values (15+).
        // Hopefully it fixes ^COUNT occasionally shown in online servers, probably due to lags.
        this.skin = 1; // recycled field
    }
 
    prev_inround = inround;
    prev_starttime = starttime;
    prev_roundstarttime = roundstarttime;
}

References Announcer_ClearTitle(), announcer_countdown, Announcer_PickNumber(), CNT_GAMESTART, CNT_ROUNDSTART, entity(), floor(), Local_Notification(), nextthink, NULL, prev_inround, prev_roundstarttime, prev_starttime, skin, STAT, and time.

Referenced by Announcer_Gamestart().

Announcer_Duel()

void Announcer_Duel

(

)

Definition at line 29 of file announcer.qc.

{
    Scoreboard_UpdatePlayerTeams();
 
    entity pl1 = players.sort_next;
    entity pl2 = pl1.sort_next;
    string pl1_name = (pl1 && pl1.team != NUM_SPECTATOR ? entcs_GetName(pl1.sv_entnum) : "???");
    string pl2_name = (pl2 && pl2.team != NUM_SPECTATOR ? entcs_GetName(pl2.sv_entnum) : "???");
 
    if(pl1_name == prev_pl1_name && pl2_name == prev_pl2_name)
        return; // Players haven't changed, stop here
 
    strcpy(prev_pl1_name, pl1_name);
    strcpy(prev_pl2_name, pl2_name);
 
    // There are new duelers, update title
    centerprint_SetDuelTitle(pl1_name, pl2_name);
}

References centerprint_SetDuelTitle(), entcs_GetName(), entity(), NUM_SPECTATOR, players, prev_pl1_name, prev_pl2_name, Scoreboard_UpdatePlayerTeams(), and strcpy.

Referenced by Announcer_Gamestart().

Announcer_Gamestart()

void Announcer_Gamestart

(

)

Definition at line 127 of file announcer.qc.

{
    float startTime = STAT(GAMESTARTTIME);
    float roundstarttime = STAT(ROUNDSTARTTIME);
    if(time > startTime && roundstarttime > startTime)
        startTime = roundstarttime;
    if(intermission || warmup_stage)
    {
        if(announcer_countdown)
        {
            Announcer_ClearTitle();
            centerprint_Kill(ORDINAL(CPID_ROUND));
            delete(announcer_countdown);
            announcer_countdown = NULL;
        }
        return;
    }
 
    if(announcer_countdown && gametype.m_1v1)
        Announcer_Duel();
 
    if(previous_game_starttime != startTime)
    {
        if(time < startTime)
        {
            if (!announcer_countdown)
            {
                announcer_countdown = new_pure(announcer_countdown);
                setthink(announcer_countdown, Announcer_Countdown);
            }
 
            if(!warmup_stage && time < STAT(GAMESTARTTIME))
            {
                if (gametype.m_1v1)
                    Announcer_Duel();
                else
                    centerprint_SetTitle(strcat("^BG", MapInfo_Type_ToText(gametype))); // Show gametype as title
 
                if(time + 5.0 < startTime) // if connecting to server while restart was active don't always play prepareforbattle
                    Local_Notification(MSG_ANNCE, ANNCE_PREPARE);
            }
 
            announcer_countdown.nextthink = startTime - floor(startTime - time + 0.5); //synchronize nextthink to startTime
        }
    }
 
    previous_game_starttime = startTime;
}

References Announcer_ClearTitle(), Announcer_Countdown(), announcer_countdown, Announcer_Duel(), centerprint_Kill(), centerprint_SetTitle(), CPID_ROUND, floor(), gametype, intermission, Local_Notification(), MapInfo_Type_ToText(), new_pure, NULL, ORDINAL, previous_game_starttime, setthink, STAT, strcat(), time, and warmup_stage.

Referenced by Announcer().

Announcer_Time()

void Announcer_Time

(

)

Definition at line 188 of file announcer.qc.

{
    static bool warmup_stage_prev;
 
    if(intermission)
        return;
 
    if (warmup_stage != warmup_stage_prev)
    {
        announcer_5min = announcer_1min = false;
        warmup_stage_prev = warmup_stage;
        return;
    }
 
    float starttime = STAT(GAMESTARTTIME);
    if(time < starttime)
    {
        announcer_5min = announcer_1min = false;
        return;
    }
 
    float timeleft;
    if(warmup_stage)
    {
        float warmup_timelimit = STAT(WARMUP_TIMELIMIT);
        if(warmup_timelimit > 0)
            timeleft = max(0, warmup_timelimit + starttime - time);
        else
            timeleft = 0;
    }
    else
        timeleft = max(0, STAT(TIMELIMIT) * 60 + starttime - time);
 
    if(autocvar_cl_announcer_maptime >= 2)
        ANNOUNCER_CHECKMINUTE(5);
 
    if((autocvar_cl_announcer_maptime == 1) || (autocvar_cl_announcer_maptime == 3))
        ANNOUNCER_CHECKMINUTE(1);
}

References announcer_1min, announcer_5min, ANNOUNCER_CHECKMINUTE, autocvar_cl_announcer_maptime, intermission, max(), STAT, time, and warmup_stage.

Referenced by Announcer().

AnnouncerOption()

string AnnouncerOption

(

)

Definition at line 14 of file announcer.qc.

{
    string ret = autocvar_cl_announcer;
    MUTATOR_CALLHOOK(AnnouncerOption, ret);
    ret = M_ARGV(0, string);
    return ret;
}

References AnnouncerOption(), autocvar_cl_announcer, M_ARGV, and MUTATOR_CALLHOOK.

Referenced by AnnouncerOption(), and MUTATOR_HOOKABLE().

Variable Documentation

announcer_1min

bool announcer_1min

Definition at line 12 of file announcer.qc.

Referenced by Announcer_Time().

announcer_5min

bool announcer_5min

Definition at line 13 of file announcer.qc.

Referenced by Announcer_Time().

announcer_countdown

entity announcer_countdown

Definition at line 22 of file announcer.qc.

Referenced by Announcer_Countdown(), and Announcer_Gamestart().

prev_inround

bool prev_inround

Definition at line 55 of file announcer.qc.

Referenced by Announcer_Countdown().

prev_pl1_name

string prev_pl1_name

Displays duel title; updates it if the players in-game have changed.

Definition at line 27 of file announcer.qc.

Referenced by Announcer_ClearTitle(), and Announcer_Duel().

prev_pl2_name

string prev_pl2_name

Definition at line 28 of file announcer.qc.

Referenced by Announcer_ClearTitle(), and Announcer_Duel().

prev_roundstarttime

float prev_roundstarttime

Definition at line 57 of file announcer.qc.

Referenced by Announcer_Countdown().

prev_starttime

float prev_starttime

Definition at line 56 of file announcer.qc.

Referenced by Announcer_Countdown().

previous_game_starttime

float previous_game_starttime

Checks whether the server initiated a map restart (stat_game_starttime changed)

TODO: Use a better solution where a common shared entitiy is used that contains timelimit, fraglimit and game_starttime! Requires engine changes (remove STAT_TIMELIMIT and STAT_FRAGLIMIT to be auto-sent)

Definition at line 126 of file announcer.qc.

Referenced by Announcer_Gamestart().