notice.h File Reference

Interface to the in-game notice display. More...

#include "render.h"
#include "text.h"

Include dependency graph for notice.h:

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

Go to the source code of this file.

Defines

#define NOTICE_NOEXPIRATION   0xFFFFFFFF
 An expiration time used to indicate that a message does not expire and will be displayed until explicitly removed.

Enumerations

enum  NOTICE_TYPE {
  NOTICE_KILL, NOTICE_LOCALKILL, NOTICE_TEAMKILL, NOTICE_LOCALTEAMKILL,
  NOTICE_REDFLAGHELD, NOTICE_BLUEFLAGHELD, NOTICE_REDFLAGCAP, NOTICE_BLUEFLAGCAP,
  NOTICE_MAXTYPE
}
 The different categories of notices. More...

Functions

void AddNotice (Uint32 expiryTime, Uint8 type, rtsa_char *format,...)
 Adds a new notice to the display.
void AddScoreNotice (int killerId, int killedId, int score)
 Adds a notice about a player shooting another.
void RemoveAllNotices ()
 Remove all notices from the system and the display.
void RemoveNotice (Uint8 type)
 Removes a notice of the specified type.
void UpdateNotices (Uint32 time)
 Update all visible notices by removing any expired notices and placing notices at their proper location when notices are added or removed.


Detailed Description

Interface to the in-game notice display.

Author:
Jeff Jackowski (jeffj@ro.com)
Copyright (C) 2007 Jeff Jackowski

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Or visit their website at: http://www.gnu.org/

Definition in file notice.h.


Generated on Mon May 28 04:41:40 2007 for Retro Tank Super Attack by  doxygen 1.5.2