notificationsystem.c File Reference

Go to the source code of this file.

Data Structures
class	NotificationSystem

Enumerations
enum	NotificationType {   FRIEND_CONNECTED , INVITE_FAIL_SAME_SERVER , JOIN_FAIL_GET_SESSION , CONNECT_FAIL_GENERIC ,   DISCONNECTED , GENERIC_ERROR , NOTIFICATIONS_END }
	DEPRECATED (moved into NotificationSystem). More...

Functions
string	GetDetailText ()
string	GetIcon ()
float	GetRemainingTime ()
float	GetTime ()
string	GetTitleText ()
void	NotificationRuntimeData (float time, NotificationData data, string detail_text)
void	SetTime (float time)
	DEPRECATED.
void	UpdateRemainingTime (float updateInterval)

Variables
string	m_DetailText
float	m_NotificationTime
enum NotificationType	m_StaticData
float	m_TimeRemaining
static const float	NOTIFICATION_FADE_TIME = 3.0

Enumeration Type Documentation

NotificationType

enum NotificationType

DEPRECATED (moved into NotificationSystem).

Enumerator
FRIEND_CONNECTED
INVITE_FAIL_SAME_SERVER
JOIN_FAIL_GET_SESSION
CONNECT_FAIL_GENERIC
DISCONNECTED
GENERIC_ERROR
NOTIFICATIONS_END

Definition at line 3 of file notificationsystem.c.

Function Documentation

GetDetailText()

string GetDetailText

(

)

Definition at line 55 of file notificationsystem.c.

References m_DetailText.

GetIcon()

string GetIcon

(

)

Definition at line 45 of file notificationsystem.c.

References m_StaticData.

Referenced by Container::GetFocusedIcon(), Container::GetIcon(), and Container::UpdateSelection().

GetRemainingTime()

float GetRemainingTime

(

)

Definition at line 40 of file notificationsystem.c.

References m_TimeRemaining.

Referenced by Tick().

GetTime()

float GetTime

(

)

Definition at line 35 of file notificationsystem.c.

References m_NotificationTime.

GetTitleText()

string GetTitleText

(

)

Definition at line 50 of file notificationsystem.c.

References m_StaticData.

NotificationRuntimeData()

void NotificationRuntimeData	(	float	time,
		NotificationData	data,
		string	detail_text )

Definition at line 23 of file notificationsystem.c.

References m_DetailText, m_NotificationTime, m_StaticData, and m_TimeRemaining.

Referenced by NotificationSystem::AddNotification(), NotificationUI::AddNotification(), NotificationSystem::AddNotificationExtended(), NotificationUI::RemoveNotification(), and NotificationSystem::Update().

SetTime()

void SetTime

(

float

time

)

DEPRECATED.

UpdateRemainingTime()

void UpdateRemainingTime

(

float

updateInterval

)

Definition at line 60 of file notificationsystem.c.

References m_TimeRemaining.

Variable Documentation

m_DetailText

string m_DetailText

Definition at line 21 of file notificationsystem.c.

Referenced by GetDetailText(), and NotificationRuntimeData().

m_NotificationTime

float m_NotificationTime

Definition at line 19 of file notificationsystem.c.

Referenced by GetTime(), and NotificationRuntimeData().

m_StaticData

enum NotificationType m_StaticData

Referenced by GetIcon(), GetTitleText(), and NotificationRuntimeData().

m_TimeRemaining

float m_TimeRemaining

Definition at line 20 of file notificationsystem.c.

Referenced by GetRemainingTime(), NotificationRuntimeData(), and UpdateRemainingTime().

NOTIFICATION_FADE_TIME

const float NOTIFICATION_FADE_TIME = 3.0

static

Definition at line 1 of file notificationsystem.c.