Template_GameType Class Reference

Server-side interpreter. More...

List of all members.

Public Member Functions
bool	CheckForRejection (String IPCheck, String LoginName, out String Error, bool bLog)
	See if an IP is banned.
bool	FindByID (int IDNum, out pawn P)
	Find a player.
void	AdminMessage (String AMessage, Optional bool bBeep)
	Admin message.
void	AcceptPlayer (PlayerReplicationInfo PRI, String CN, String V)
	Accept a player.
void	EPRITimer (Template_EPRI EPRI)
	PlayerReplicationInfo timer.
bool	InterpretReplicatedFunction (UnrealIPlayer Other, String FunctionTitle, optional String arguments)
	A playerpawn has done something.
void	EGRITimer ()
	GameReplicationInfo timer.
TeamInfo	GetTeamInfo (byte Team)
	Get a TeamInfo.
Public Attributes
class< MapList >	MapListClass
	Map list class.
class< Template_DownloadMonitor >	DLMainClass
	Download monitor class.
class< Template_Voting >	MapVotingClass
	Map voting class.
class< Template_Voting >	MutatorVotingClass
	Mutator voting class.
class< Template_IPLog >	IPLogClass
	IP logging class.
Template_DownloadMonitor	DLMain
	Download monitor object.
Template_Voting	MapVoteMain
	Map voting object.
Template_Voting	MutatorVoteMain
	Mutator voting object.
Template_IPLog	IPL
	IP Logging object.

---

Detailed Description

Server-side object that will process everything related to the game. The purpose of creating this is to give the programmer the ability to completely separate common server-side code from their client-side code.

---

Member Function Documentation

bool CheckForRejection	(	String	IPCheck,
		String	LoginName,
		out String	Error,
		bool	bLog
	)

See if a given IP is banned.

Parameters:

	IPCheck	The IP to check
	LoginName	The name that this IP is logging in with
	Error	A String variable that will be given information about the rejection if the player is rejected
	bLog	Whether to log the incident

Returns:

True if the given IP is banned, else false

bool FindByID	(	int	IDNum,
		out pawn	P
	)

Find a player by their ID.

Parameters:

	IDNum	The ID to search for
	P	A pawn variable that will be set to the pawn that is found, if they are found

Returns:

True if a player with the specified ID was found, false if not

void AdminMessage	(	String	AMessage,
		Optional bool	bBeep
	)

Broadcast a message to all admins using the 'A' message type.

Parameters:

	AMessage	The message to broadcast
	bBeep	Whether the message should beep when received

void AcceptPlayer	(	PlayerReplicationInfo	PRI,
		String	CN,
		String	V
	)

Called when a player's information has been obtained and they should be accepted.

Parameters:

	PRI	The PlayerReplicationInfo of the accepted player
	CN	The computer name of the accepted player
	V	The engine version of the accepted player

Remarks:

This function is responsible for calling Template_EDMPlayer.FullyConnected()

void EPRITimer

(

Template_EPRI

EPRI

)

Called every two seconds by each player's Template_EPRI.

Parameters:

EPRI

The Template_EPRI that called this.

bool InterpretReplicatedFunction	(	UnrealIPlayer	Other,
		String	FunctionTitle,
		optional String	arguments
	)

Called by every single ROLE < 4 replicated PlayerPawn function.

Parameters:

	Other	The player that invoked this
	FunctionTitle	The name of the function they performed
	arguments	Any additional arguments for the function

Returns:

True if the request was NOT handled here, otherwise false if this function has properly handled the request.

Remarks:

If true is returned, the calling player object is responsible for handling the function.

void EGRITimer

(

)

Called every second by the game's Template_EGRI.

TeamInfo GetTeamInfo

(

byte

Team

)

Get the TeamInfo object for a particular team. This function exists because gametypes are abstracted, so the TeamInfo object must be obtained here.

Parameters:

Team

The index of the desired team

Returns:

The TeamInfo object pertaining to the specified team, if any

---

Member Data Documentation

class<MapList> MapListClass

The class to use for the server's map list.

class<Template_DownloadMonitor> DLMainClass

The class that is used to handle download monitoring.

class<Template_Voting> MapVotingClass

The class that is used to handle map voting.

class<Template_Voting> MutatorVotingClass

The class that is used to handle mutator voting.

class<Template_IPLog> IPLogClass

The class that is used to handle IP logging.

Template_DownloadMonitor DLMain

The object that is used to handle download monitoring.

Template_Voting MapVoteMain

The object that is used to handle map voting.

Template_Voting MutatorVoteMain

The object that is used to handle mutator voting.

Template_IPLog IPL

The object that is used to handle IP logging.