About this class

This class delegates active MapC logic.

The ncMapDelegate class is for any set of active level specific logic. It can be accessed in QuakeC via the global g_grMap from the server-side.

Startup

Upon server init, the game will attempt to find a MapC progs file alongside the BSP or MAP that is being played on.

If you load map foobar in the console, and it'll find the map at <gamedir>/maps/foobar.bsp, then our server-game will look for a MapC progs over at <gamedir>/maps/foobar.dat.

Implementing MapC Progs

Similarily to RuleC, that progs can be implemented with as many binds to the ncMapDelegate class as you like. The only requirement is you include the header found under src/server/api.h.

Example MapC

To be written.

Class To Progs Callback Mappings

Left = class method, right = name of the callback function for you to implement in progs.

To be written.**

The underlying return values and parameters are inherited from its class counter-part.

Inheritance diagram for ncMapDelegate:

Public Member Functions
void	ncMapDelegate (void)

virtual void	Save (float)
	Handles saving a copy of this entity to a given filehandle. More...

virtual void	Restore (string, string)
	Similar to ncIO::SpawnKey() but for save-game fields. More...

virtual void	RestoreComplete (void)
	Called when the entity has been successfully restored from a savegame file. More...

virtual void	Input (entity, string, string)
	Called when we are being prompted by another object/function with an input message. More...

virtual void	InitPostEnts (void)
	Overridable: Called when all map entities have initialized. More...

virtual void	FrameStart (void)
	Overridable: Called every server frame. More...

virtual bool	ConsoleCommand (ncPlayer, string)
	Overridable: Called when a client issues a console command. More...

virtual bool	ClientCommand (ncClient, string)
	Overridable: Called when a client issues a client command. More...

virtual bool	ImpulseCommand (ncClient, float)
	Overridable: Called when a client issues an impulse command. More...

virtual void	PlayerConnect (ncPlayer)
	Overridable: Called when a ncPlayer joins the server. More...

virtual void	PlayerDisconnect (ncPlayer)
	Overridable: Called when a ncPlayer leaves the server. More...

virtual void	PlayerKill (ncPlayer)
	Overridable: Called when a ncPlayer issues the `kill` console command. More...

virtual void	PlayerSpawn (ncPlayer)
	Overridable: Called when a ncPlayer spawns, called sometime after joining. More...

virtual void	PlayerPreFrame (ncPlayer)
	Overridable: Called before running physics on the ncPlayer in question. More...

virtual void	PlayerPostFrame (ncPlayer)
	Overridable: Called after running physics on the ncPlayer in question. More...

virtual void	PlayerDeath (ncPlayer, ncEntity, ncEntity, string)
	Overridable: Called when a ncPlayer dies in the game. More...

virtual void	PlayerPain (ncPlayer, ncActor, ncDict)
	Overridable: Called when a ncPlayer feels pain. More...

virtual bool	PlayerCanAttack (ncPlayer)
	Overridable: Called to check if a ncPlayer can attack. More...

virtual void	NPCDeath (ncActor, ncEntity, ncEntity)
	Overridable:: Called when an NPC gets killed. More...

virtual bool	PlayerRequestRespawn (ncPlayer)
	Overridable: called when a ncPlayer requests a respawn. More...

virtual bool	PlayerRequestTeam (ncPlayer, int team)
	Overridable: called when a ncPlayer requests joining a specific team. More...

virtual void	LevelNewParms (void)
	Overridable: Called to set up new level parms for any ncPlayer. More...

virtual void	LevelChangeParms (ncPlayer)
	Overridable: Called to store parms for a specific ncPlayer. More...

virtual int	MaxItemPerSlot (int)
	Overridable: Returns how many items players can carry in a given slot. More...

virtual bool	MonstersSpawn (void)
	Overridable: Returns if ncMonster or ncTalkMonster entities can spawn. More...

virtual void	IntermissionStart (void)
	Called when intermission starts. More...

virtual void	IntermissionCycle (void)
	Called when the intermission system calls a new map. More...

virtual void	IntermissionEnd (void)
	Called when intermission ends. More...

virtual void	IntermissionToPlayer (ncPlayer)
	Run to send a specific player to an intermission. More...

virtual bool	InIntermission (void)
	Returns if the gamerules find themselves in an intermission. More...

virtual bool	IsTeamplay (void)
	Returns if this gamerule considers itself teamplay oriented. More...

virtual bool	IsMultiplayer (void)
	Returns if the gamerule is a multiplayer game. More...

virtual void	ChatMessageAll (ncClient, string)
	Called by Nuclide when the server has received a chat message that is to be distributed amongst all clients, regardless of team. More...

virtual void	ChatMessageTeam (ncClient, string)
	Called by Nuclide when the server has received a chat message that is to be distributed amongst all clients of the same team. More...

virtual string	Title (void)
	Returns the title of the gamemode running. More...

nonvirtual ncMapDelegate	LinkProgs (void)

Constructor & Destructor Documentation

◆ ncMapDelegate()

void ncMapDelegate::ncMapDelegate ( void )

Member Function Documentation

◆ ChatMessageAll()

void ncMapDelegate::ChatMessageAll	(	ncClient	cl,
		string	strMessage
	)

virtual

Called by Nuclide when the server has received a chat message that is to be distributed amongst all clients, regardless of team.

◆ ChatMessageTeam()

void ncMapDelegate::ChatMessageTeam	(	ncClient	cl,
		string	strMessage
	)

virtual

Called by Nuclide when the server has received a chat message that is to be distributed amongst all clients of the same team.

◆ ClientCommand()

bool ncMapDelegate::ClientCommand	(	ncClient	pl,
		string	cmd
	)

virtual

Overridable: Called when a client issues a client command.

◆ ConsoleCommand()

bool ncMapDelegate::ConsoleCommand	(	ncPlayer	pl,
		string	cmd
	)

virtual

Overridable: Called when a client issues a console command.

◆ FrameStart()

void ncMapDelegate::FrameStart ( void )

virtual

Overridable: Called every server frame.

◆ ImpulseCommand()

bool ncMapDelegate::ImpulseCommand	(	ncClient	pl,
		float	num
	)

virtual

Overridable: Called when a client issues an impulse command.

◆ InIntermission()

bool ncMapDelegate::InIntermission ( void )

virtual

Returns if the gamerules find themselves in an intermission.

◆ InitPostEnts()

void ncMapDelegate::InitPostEnts ( void )

virtual

Overridable: Called when all map entities have initialized.

◆ Input()

void ncMapDelegate::Input	(	entity	eAct,
		string	strInput,
		string	strData
	)

virtual

Called when we are being prompted by another object/function with an input message.

Reimplemented from ncIO.

◆ IntermissionCycle()

void ncMapDelegate::IntermissionCycle ( void )

virtual

Called when the intermission system calls a new map.

◆ IntermissionEnd()

void ncMapDelegate::IntermissionEnd ( void )

virtual

Called when intermission ends.

◆ IntermissionStart()

void ncMapDelegate::IntermissionStart ( void )

virtual

Called when intermission starts.

Will send all current players to the intermission screen.

◆ IntermissionToPlayer()

void ncMapDelegate::IntermissionToPlayer ( ncPlayer targetPlayer )

virtual

Run to send a specific player to an intermission.

Like when joining late.

◆ IsMultiplayer()

bool ncMapDelegate::IsMultiplayer ( void )

virtual

Returns if the gamerule is a multiplayer game.

◆ IsTeamplay()

bool ncMapDelegate::IsTeamplay ( void )

virtual

Returns if this gamerule considers itself teamplay oriented.

◆ LevelChangeParms()

void ncMapDelegate::LevelChangeParms ( ncPlayer pl )

virtual

Overridable: Called to store parms for a specific ncPlayer.

◆ LevelNewParms()

void ncMapDelegate::LevelNewParms ( void )

virtual

Overridable: Called to set up new level parms for any ncPlayer.

◆ LinkProgs()

ncMapDelegate ncMapDelegate::LinkProgs ( void )

◆ MaxItemPerSlot()

int ncMapDelegate::MaxItemPerSlot ( int slot )

virtual

Overridable: Returns how many items players can carry in a given slot.

◆ MonstersSpawn()

bool ncMapDelegate::MonstersSpawn ( void )

virtual

Overridable: Returns if ncMonster or ncTalkMonster entities can spawn.

◆ NPCDeath()

void ncMapDelegate::NPCDeath	(	ncActor	npc,
		ncEntity	attacker,
		ncEntity	inflictor
	)

virtual

Overridable:: Called when an NPC gets killed.

◆ PlayerCanAttack()

bool ncMapDelegate::PlayerCanAttack ( ncPlayer bp )

virtual

Overridable: Called to check if a ncPlayer can attack.

◆ PlayerConnect()

void ncMapDelegate::PlayerConnect ( ncPlayer pl )

virtual

Overridable: Called when a ncPlayer joins the server.

◆ PlayerDeath()

void ncMapDelegate::PlayerDeath	(	ncPlayer	deadPlayer,
		ncEntity	inflictor,
		ncEntity	attacker,
		string	weaponDef
	)

virtual

Overridable: Called when a ncPlayer dies in the game.

◆ PlayerDisconnect()

void ncMapDelegate::PlayerDisconnect ( ncPlayer pl )

virtual

Overridable: Called when a ncPlayer leaves the server.

◆ PlayerKill()

void ncMapDelegate::PlayerKill ( ncPlayer pl )

virtual

Overridable: Called when a ncPlayer issues the kill console command.

◆ PlayerPain()

void ncMapDelegate::PlayerPain	(	ncPlayer	pl,
		ncActor	attacker,
		ncDict	damageDecl
	)

virtual

Overridable: Called when a ncPlayer feels pain.

◆ PlayerPostFrame()

void ncMapDelegate::PlayerPostFrame ( ncPlayer pl )

virtual

Overridable: Called after running physics on the ncPlayer in question.

◆ PlayerPreFrame()

void ncMapDelegate::PlayerPreFrame ( ncPlayer pl )

virtual

Overridable: Called before running physics on the ncPlayer in question.

◆ PlayerRequestRespawn()

bool ncMapDelegate::PlayerRequestRespawn ( ncPlayer pl )

virtual

Overridable: called when a ncPlayer requests a respawn.

In a multiplayer game, it'll put you back into the game as a player. In a singleplayer game, it might load the most recent save.

Returns: True/false depending on the respawn succeeded.

◆ PlayerRequestTeam()

bool ncMapDelegate::PlayerRequestTeam	(	ncPlayer	pl,
		int	team
	)

virtual

Overridable: called when a ncPlayer requests joining a specific team.

Returns: True/false depending on the team change success.

◆ PlayerSpawn()

void ncMapDelegate::PlayerSpawn ( ncPlayer pl )

virtual

Overridable: Called when a ncPlayer spawns, called sometime after joining.

◆ Restore()

void ncMapDelegate::Restore	(	string	strKey,
		string	strValue
	)

virtual

Similar to ncIO::SpawnKey() but for save-game fields.

Whatever you write into file handles within your ncIO::Save() method needs to be read back in here.

Reimplemented from ncIO.

◆ RestoreComplete()

void ncMapDelegate::RestoreComplete ( void )

virtual

Called when the entity has been successfully restored from a savegame file.

Reimplemented from ncIO.

◆ Save()

void ncMapDelegate::Save ( float handle )

virtual

Handles saving a copy of this entity to a given filehandle.

Within you want to use the ncIO::SaveFloat() etc. methods to write the internal member attributes to the specified file handle.

Reimplemented from ncIO.

◆ Title()

string ncMapDelegate::Title ( void )

virtual

Returns the title of the gamemode running.

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

src/server/MapDelegate.h
src/server/MapDelegate.qc

About this class

Startup

Implementing MapC Progs

Example MapC

Class To Progs Callback Mappings

Public Member Functions

Constructor & Destructor Documentation

◆ ncMapDelegate()

Member Function Documentation

◆ ChatMessageAll()

◆ ChatMessageTeam()

◆ ClientCommand()

◆ ConsoleCommand()

◆ FrameStart()

◆ ImpulseCommand()

◆ InIntermission()

◆ InitPostEnts()

◆ Input()

◆ IntermissionCycle()

◆ IntermissionEnd()

◆ IntermissionStart()

◆ IntermissionToPlayer()

◆ IsMultiplayer()

◆ IsTeamplay()

◆ LevelChangeParms()

◆ LevelNewParms()

◆ LinkProgs()

◆ MaxItemPerSlot()

◆ MonstersSpawn()

◆ NPCDeath()

◆ PlayerCanAttack()

◆ PlayerConnect()

◆ PlayerDeath()

◆ PlayerDisconnect()

◆ PlayerKill()

◆ PlayerPain()

◆ PlayerPostFrame()

◆ PlayerPreFrame()

◆ PlayerRequestRespawn()

◆ PlayerRequestTeam()

◆ PlayerSpawn()

◆ Restore()

◆ RestoreComplete()

◆ Save()

◆ Title()