NSClientPlayer Class Reference

This entity class represents every player client. More...

#include <NSClientPlayer.h>

Inheritance diagram for NSClientPlayer:

Public Member Functions
void	NSClientPlayer (void)
virtual void	ProcessInput (void)
	Called within the class to deal with the final input handling of the client. More...
virtual void	PreFrame (void)
	Run once, every frame, before physics are run on the player. More...
virtual void	PostFrame (void)
	Run once, every frame, after physics are run on the player. More...
virtual void	Physics_Fall (float)
virtual void	Physics_Crouch (void)
virtual void	Physics_Prone (void)
virtual void	Physics_Jump (void)
virtual void	Physics_CheckJump (float)
virtual void	Physics_SetViewParms (void)
virtual void	Physics_WaterJump (void)
virtual void	Physics_WaterMove (void)
virtual float	Physics_MaxSpeed (void)
virtual void	Physics_InputPreMove (void)
virtual void	Physics_InputPostMove (void)
virtual void	Physics_Run (void)
	Overridable: Called when the entity is ready to move. More...
virtual bool	IsFakeSpectator (void)
	Returns if we're a 'fake' spectator. More...
virtual bool	IsRealSpectator (void)
	Returns if we're a 'real' spectator. More...
virtual bool	IsDead (void)
	Returns if we're considered 'dead'. More...
virtual bool	IsPlayer (void)
	Returns if we're a player. More...
virtual void	SharedInputFrame (void)
	Like ClientInputFrame and ServerInputFrame, but run on both client and server at the same time. More...
virtual bool	CanSprint (void)
	Overridable: Returns whether the client can sprint, with the command +sprint. More...
virtual bool	CanProne (void)
	Overridable: Returns whether the client can prone, with the commands +prone and goprone. More...
virtual bool	CanCrouch (void)
	Overridable: Returns whether the client can crouch, with the commands +crouch and gocrouch. More...
virtual bool	CanLean (void)
	Overridable: Returns whether the client can lean, with the commands +leanleft and +leanright. More...
virtual void	UpdatePlayerAnimation (float)
	Empty & shared between Client and Server. More...
virtual void	VehicleRelink (void)
virtual void	OnRemoveEntity (void)
	Handles what happens before the entity gets removed from the client game. More...
virtual void	ReceiveEntity (float, float)
	Client: Handles network updates from the server for the associated entity. More...
virtual void	PredictPreFrame (void)
virtual void	PredictPostFrame (void)
virtual void	ClientInputFrame (void)
	Client: Called on the client to give a chance to override input_* variables before networking them takes place. More...
virtual void	UpdateAliveCam (void)
	Client: Called every single client frame when this client is alive. More...
virtual void	UpdatePlayerJaw (float)
	Empty. More...
virtual void	UpdatePlayerAttachments (bool)
	Empty. More...
virtual float	predraw (void)
virtual void	postdraw (void)
	Client: Run after the rendering of 3D world is complete. More...
virtual void	Save (float)
	Handles saving a copy of this entity to a given filehandle. More...
virtual void	Restore (string, string)
	Similar to ::SpawnKey but for save-game fields. More...
virtual void	Respawn (void)
	Server: Called when the entity first spawns or when game-logic requests the entity to return to its original spawn state. More...
virtual void	EvaluateEntity (void)
	Run each tic after physics are run to determine if we need to send updates over the network. More...
virtual float	SendEntity (entity, float)
	Called by the engine whenever we need to send a client an update about this entity. More...
virtual void	Death (void)
	Called when the health is equal or below 0. More...
virtual void	ServerInputFrame (void)
	Server: This is where the input* variables arrive after sending them out from the client (see ClientInputFrame). More...
virtual float	OptimiseChangedFlags (entity, float)
	Helper function that will optimise the changed-flags of your player entity. More...
virtual void	MakePlayer (void)
	When called, will turn the client into a proper player. More...
virtual void	MakeTempSpectator (void)
	When called, will turn the client into a spectator until the next round. More...
virtual void	MakeSpectator (void)
	When called, will turn the client into a general spectator. More...
virtual void	InputUse_Down (void)
	Called when we press the button bound to +use. More...
virtual void	InputUse_Up (void)
	Called when we let go of the button bound to +use. More...
virtual void	Footsteps_Update (void)

Detailed Description

This entity class represents every player client.

When clients connect via the connect command, they will findthemselves of type NSClientPlayer.

Constructor & Destructor Documentation

NSClientPlayer()

void NSClientPlayer::NSClientPlayer

(

void

)

Member Function Documentation

CanCrouch()

bool NSClientPlayer::CanCrouch ( void  )

virtual

Overridable: Returns whether the client can crouch, with the commands +crouch and gocrouch.

Reimplemented from NSNavAI.

CanLean()

bool NSClientPlayer::CanLean ( void  )

virtual

Overridable: Returns whether the client can lean, with the commands +leanleft and +leanright.

Reimplemented from NSNavAI.

CanProne()

bool NSClientPlayer::CanProne ( void  )

virtual

Overridable: Returns whether the client can prone, with the commands +prone and goprone.

Reimplemented from NSNavAI.

CanSprint()

bool NSClientPlayer::CanSprint ( void  )

virtual

Overridable: Returns whether the client can sprint, with the command +sprint.

Reimplemented from NSNavAI.

ClientInputFrame()

void NSClientPlayer::ClientInputFrame ( void  )

virtual

Client: Called on the client to give a chance to override input_* variables before networking them takes place.

Reimplemented from NSClientSpectator.

Death()

virtual void NSClientPlayer::Death ( void  )

virtual

Called when the health is equal or below 0.

Reimplemented from NSSurfacePropEntity.

EvaluateEntity()

virtual void NSClientPlayer::EvaluateEntity ( void  )

virtual

Run each tic after physics are run to determine if we need to send updates over the network.

Reimplemented from NSClientSpectator.

Footsteps_Update()

void NSClientPlayer::Footsteps_Update ( void  )

virtual

InputUse_Down()

virtual void NSClientPlayer::InputUse_Down ( void  )

virtual

Called when we press the button bound to +use.

InputUse_Up()

virtual void NSClientPlayer::InputUse_Up ( void  )

virtual

Called when we let go of the button bound to +use.

IsDead()

bool NSClientPlayer::IsDead ( void  )

virtual

Returns if we're considered 'dead'.

NSClient, NSClientSpectator will always return false.

Reimplemented from NSClientSpectator.

IsFakeSpectator()

bool NSClientPlayer::IsFakeSpectator ( void  )

virtual

Returns if we're a 'fake' spectator.

This is a regular player acting as a spectator.

Reimplemented from NSClientSpectator.

IsPlayer()

bool NSClientPlayer::IsPlayer ( void  )

virtual

Returns if we're a player.

That is a type of client that is built on top of NSClientPlayer.

Reimplemented from NSClientSpectator.

IsRealSpectator()

bool NSClientPlayer::IsRealSpectator ( void  )

virtual

Returns if we're a 'real' spectator.

That is a client that can only spectate.

Reimplemented from NSClientSpectator.

MakePlayer()

virtual void NSClientPlayer::MakePlayer ( void  )

virtual

When called, will turn the client into a proper player.

MakeSpectator()

virtual void NSClientPlayer::MakeSpectator ( void  )

virtual

When called, will turn the client into a general spectator.

MakeTempSpectator()

virtual void NSClientPlayer::MakeTempSpectator ( void  )

virtual

When called, will turn the client into a spectator until the next round.

OnRemoveEntity()

void NSClientPlayer::OnRemoveEntity ( void  )

virtual

Handles what happens before the entity gets removed from the client game.

Reimplemented from NSClient.

OptimiseChangedFlags()

virtual float NSClientPlayer::OptimiseChangedFlags ( entity  , float    )

virtual

Helper function that will optimise the changed-flags of your player entity.

Physics_CheckJump()

void NSClientPlayer::Physics_CheckJump ( float  premove )

virtual

Physics_Crouch()

void NSClientPlayer::Physics_Crouch ( void  )

virtual

Physics_Fall()

void NSClientPlayer::Physics_Fall ( float  flDownforce )

virtual

Physics_InputPostMove()

void NSClientPlayer::Physics_InputPostMove ( void  )

virtual

Physics_InputPreMove()

void NSClientPlayer::Physics_InputPreMove ( void  )

virtual

Physics_Jump()

void NSClientPlayer::Physics_Jump ( void  )

virtual

Physics_MaxSpeed()

float NSClientPlayer::Physics_MaxSpeed ( void  )

virtual

Physics_Prone()

void NSClientPlayer::Physics_Prone ( void  )

virtual

Physics_Run()

void NSClientPlayer::Physics_Run ( void  )

virtual

Overridable: Called when the entity is ready to move.

When overridden, will no longer move until super function is called, or physics is handled within.

Reimplemented from NSNavAI.

Physics_SetViewParms()

void NSClientPlayer::Physics_SetViewParms ( void  )

virtual

Physics_WaterJump()

void NSClientPlayer::Physics_WaterJump ( void  )

virtual

Physics_WaterMove()

void NSClientPlayer::Physics_WaterMove ( void  )

virtual

postdraw()

void NSClientPlayer::postdraw ( void  )

virtual

Client: Run after the rendering of 3D world is complete.

2D calls can happen here.

Reimplemented from NSRenderableEntity.

PostFrame()

void NSClientPlayer::PostFrame ( void  )

virtual

Run once, every frame, after physics are run on the player.

Reimplemented from NSClientSpectator.

PredictPostFrame()

void NSClientPlayer::PredictPostFrame ( void  )

virtual

PredictPreFrame()

void NSClientPlayer::PredictPreFrame ( void  )

virtual

predraw()

float NSClientPlayer::predraw ( void  )

virtual

Reimplemented from NSClientSpectator.

PreFrame()

void NSClientPlayer::PreFrame ( void  )

virtual

Run once, every frame, before physics are run on the player.

Reimplemented from NSClientSpectator.

ProcessInput()

void NSClientPlayer::ProcessInput ( void  )

virtual

Called within the class to deal with the final input handling of the client.

Reimplemented from NSClientSpectator.

ReceiveEntity()

void NSClientPlayer::ReceiveEntity ( float  flNew, float  flChanged  )

virtual

Client: Handles network updates from the server for the associated entity.

Reimplemented from NSClientSpectator.

Respawn()

virtual void NSClientPlayer::Respawn ( void  )

virtual

Server: Called when the entity first spawns or when game-logic requests the entity to return to its original spawn state.

Reimplemented from NSSurfacePropEntity.

Restore()

virtual void NSClientPlayer::Restore ( string  strKey, string  strValue  )

virtual

Similar to ::SpawnKey but for save-game fields.

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

Reimplemented from NSClientSpectator.

Save()

virtual void NSClientPlayer::Save ( float  handle )

virtual

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

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

Reimplemented from NSClientSpectator.

SendEntity()

virtual float NSClientPlayer::SendEntity ( entity  , float    )

virtual

Called by the engine whenever we need to send a client an update about this entity.

Reimplemented from NSClientSpectator.

ServerInputFrame()

virtual void NSClientPlayer::ServerInputFrame ( void  )

virtual

Server: This is where the input* variables arrive after sending them out from the client (see ClientInputFrame).

This is also where we will instruct the server to run physics on the client.

Reimplemented from NSClientSpectator.

SharedInputFrame()

void NSClientPlayer::SharedInputFrame ( void  )

virtual

Like ClientInputFrame and ServerInputFrame, but run on both client and server at the same time.

It is run before ClientInputFrame and ServerInputFrame. When overriding, Make sure to call the super method to enable Nuclide to handle spectator controls properly.

Reimplemented from NSClientSpectator.

UpdateAliveCam()

void NSClientPlayer::UpdateAliveCam ( void  )

virtual

Client: Called every single client frame when this client is alive.

You are expected to manipulate the g_view global here, which is of type NSView.

Reimplemented from NSClient.

UpdatePlayerAnimation()

void NSClientPlayer::UpdatePlayerAnimation ( float  timelength )

virtual

Empty & shared between Client and Server.

This is run on every player, every frame, to update their animation cycle.

UpdatePlayerAttachments()

void NSClientPlayer::UpdatePlayerAttachments ( bool  visible )

virtual

Empty.

This is run on every player, every frame to update attachments.

UpdatePlayerJaw()

void NSClientPlayer::UpdatePlayerJaw ( float  voip_volume )

virtual

Empty.

Updates the bone controller responsible for mouth movement.

VehicleRelink()

void NSClientPlayer::VehicleRelink ( void  )

virtual

---

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

• src/shared/NSClientPlayer.h
• src/shared/NSClientPlayer.qc
• src/shared/player_pmove.qc