CPlayerFuncs - Revision history

Outerbeast: /* Methods */

2025-02-22T17:40:18Z

Methods

← Older revision		Revision as of 19:40, 22 February 2025
Line 38:		Line 38:
	\|-		\|-
	\| <code>int GetAmmoIndex(const string& in szAmmoName)		\| <code>int GetAmmoIndex(const string& in szAmmoName)
	\| Gets the index of the given ammo, or -1 if it is invalid		\| Gets the index of the given ammo, or -1 if it is invalid. <code>szAmmoName</code> corresponds to a weapon's <code>pszAmmo1</code>/<code>pszAmmo2</code> value.
	\|-		\|-
	\| <code>bool GetNextBestWeapon(CBasePlayer@ pPlayer, CBasePlayerItem@ pCurrentWeapon)		\| <code>bool GetNextBestWeapon(CBasePlayer@ pPlayer, CBasePlayerItem@ pCurrentWeapon)

Outerbeast at 13:19, 17 February 2025

2025-02-17T13:19:50Z

@@ Line 4: / Line 4: @@
 This class only contains methods.
 == Methods ==
 These are the main player methods that are most commonly used

Outerbeast: /* ClientPrint */

2025-02-17T13:06:19Z

ClientPrint

Outerbeast: /* ClientPrint */

2025-02-17T13:05:44Z

ClientPrint

← Older revision		Revision as of 15:05, 17 February 2025
Line 114:		Line 114:

	=== ClientPrint ===		=== ClientPrint ===
			'''Note: The szLine parameters below are not required and can be ignored when doing a message using this functionality.'''

			{\| class="wikitable" style="vertical-align:middle;"
			\|- style="font-weight:bold; text-align:center;"
			! Methods
			! Description
			\|-
			\| void CenterPrintAll(const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")
			\| Prints one or more messages centered on the HUD of all players. Parameters: Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).
			\|-
			\| void ClientPrint(CBasePlayer@ pTargetPlayer, HUD iMsgDest, const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")
			\| Prints one or more messages on the HUD of the given player. Parameters: Target Player Handle, Message Destination (See HUD enum), Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).
			\|-
			\| void ClientPrintAll(HUD iMsgDest, const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")
			\| Prints one or more messages on the HUD of all players. Parameters: Message Destination (See HUD enum), Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).
			\|}

	'''Obs: To make full use of the szLine parameters, use <code>%s</code> on the szMessage line to use the rest of the lines parameters (one <code>%s</code> for each line).'''<br />		'''Obs: To make full use of the szLine parameters, use <code>%s</code> on the szMessage line to use the rest of the lines parameters (one <code>%s</code> for each line).'''<br />
	Example:		Example:

	<~~syntaxhighlight lang="cpp"~~>g_PlayerFuncs.ClientPrintAll( HUD_PRINTCENTER, "this %s %s %s %s", "is", "a", "test", "message" );</~~syntaxhighlight~~>		<pre>g_PlayerFuncs.ClientPrintAll( HUD_PRINTCENTER, "this %s %s %s %s", "is", "a", "test", "message" );</pre>
	Which becomes in game: <code>this is a test message</code>.		Which becomes in game: <code>this is a test message</code>.

	~~<span id="showmessage"></span>~~
	=== ShowMessage ===		=== ShowMessage ===

Outerbeast: /* Methods */

2025-02-14T18:16:50Z

Methods

← Older revision		Revision as of 20:16, 14 February 2025
Line 25:		Line 25:
	\| <code>int GetAmmoIndex(const string& in szAmmoName)		\| <code>int GetAmmoIndex(const string& in szAmmoName)
	\| Gets the index of the given ammo, or -1 if it is invalid		\| Gets the index of the given ammo, or -1 if it is invalid
			\|-
			\| <code>bool GetNextBestWeapon(CBasePlayer@ pPlayer, CBasePlayerItem@ pCurrentWeapon)
			\| Makes the given player select the next best weapon available, based on the current weapon.
	\|-		\|-
	\| <code>bool CheatsAllowed(CBasePlayer@ pPlayer, const string& in szCheatName, bool fMustBeAlive = true) const		\| <code>bool CheatsAllowed(CBasePlayer@ pPlayer, const string& in szCheatName, bool fMustBeAlive = true) const
	\|		\| Returns whether cheats are enabled for the given player.
	\|-
	~~\| <code>bool GetNextBestWeapon(CBasePlayer@ pPlayer, CBasePlayerItem@ pCurrentWeapon)~~
	\|
	\|-		\|-
	\| <code>int SharedRandomLong(uint iRandomSeed, int iLow, int iHigh)		\| <code>int SharedRandomLong(uint iRandomSeed, int iLow, int iHigh)

Outerbeast: /* Methods */

2025-02-14T18:15:56Z

Methods

← Older revision		Revision as of 20:15, 14 February 2025
Line 10:		Line 10:
	! Methods		! Methods
	! Description		! Description
	\|-
	~~\| <code>bool CheatsAllowed(CBasePlayer@ pPlayer, const string& in szCheatName, bool fMustBeAlive = true) const~~
	\|
	\|-
	~~\| <code>bool GetNextBestWeapon(CBasePlayer@ pPlayer, CBasePlayerItem@ pCurrentWeapon)~~
	\|
	\|-		\|-
	\| <code>CBasePlayer@ FindPlayerByIndex(int index)		\| <code>CBasePlayer@ FindPlayerByIndex(int index)
Line 21:		Line 15:
	\|-		\|-
	\| <code>CBasePlayer@ FindPlayerByName(const string& in szName, bool bCaseSensitive = true)		\| <code>CBasePlayer@ FindPlayerByName(const string& in szName, bool bCaseSensitive = true)
	\|		\| Finds a player by name
			\|-
			\| <code>int GetNumPlayers() const
			\| Gets the number of players that are currently connected to the server.
	\|-		\|-
	\| <code>~~float SharedRandomFloat~~(~~uint iRandomSeed~~, ~~float iLow, float iHigh~~)		\| <code>void ApplyMapCfgToPlayer(CBasePlayer@ pPlayer, bool fReEquip = false)
	\|		\| Applies the map configuration on the given player.<br>Will stack if called multiple times, unless fReEquip is true, in which case the player is stripped of all weapons and ammo first.
	\|-		\|-
	\| <code>int GetAmmoIndex(const string& in szAmmoName)		\| <code>int GetAmmoIndex(const string& in szAmmoName)
			\| Gets the index of the given ammo, or -1 if it is invalid
			\|-
			\| <code>bool CheatsAllowed(CBasePlayer@ pPlayer, const string& in szCheatName, bool fMustBeAlive = true) const
	\|		\|
	\|-		\|-
	\| <code>~~int GetNumPlayers~~() ~~const~~		\| <code>bool GetNextBestWeapon(CBasePlayer@ pPlayer, CBasePlayerItem@ pCurrentWeapon)
	\|		\|
	\|-		\|-
	\| <code>int SharedRandomLong(uint iRandomSeed, int iLow, int iHigh)		\| <code>int SharedRandomLong(uint iRandomSeed, int iLow, int iHigh)
	\|		\| Gets a random long whose value is the same on both the client and server.
	\|-		\|-
	\| <code>~~void ApplyMapCfgToPlayer~~(~~CBasePlayer@ pPlayer~~, ~~bool fReEquip = false~~)		\| <code>float SharedRandomFloat(uint iRandomSeed, float iLow, float iHigh)
	\|		\| Gets a random float whose value is the same on both the client and server.
	\|}		\|}

Outerbeast at 18:10, 14 February 2025

2025-02-14T18:10:58Z

← Older revision		Revision as of 20:10, 14 February 2025
Line 1:		Line 1:
	The <code>CPlayerFuncs</code> class contains global player related functionality.		The <code>CPlayerFuncs</code> class contains global player related functionality.

	A single global Instance exists with the following declaration:		A single global Instance exists with the following declaration: <code>const CPlayerFuncs g_PlayerFuncs;</code>

	~~<code>const CPlayerFuncs g_PlayerFuncs;</code>~~
	This class only contains methods.		This class only contains methods.
	== Methods ==		== Methods ==

Outerbeast at 18:10, 14 February 2025

2025-02-14T18:10:34Z

Show changes

Outerbeast: Outerbeast moved page Player to CPlayerFuncs: just because

2025-02-14T16:59:50Z

Outerbeast moved page Player to CPlayerFuncs: just because

← Older revision		Revision as of 18:59, 14 February 2025
(No difference)

Outerbeast: Created page with "The `CPlayerFuncs` class contains global player related functionality. A single global Instance exists with the following declaration: `const CPlayerFuncs g_..."`


2025-02-14T16:54:57Z
Created page with "The <code>CPlayerFuncs</code> class contains global player related functionality.  A single global Instance exists with the following declaration:  <code>const CPlayerFuncs g_..."
New page
The <code>CPlayerFuncs</code> class contains global player related functionality.



A single global Instance exists with the following declaration:



<code>const CPlayerFuncs g_PlayerFuncs;</code>

This class only contains methods.

== Methods ==

These are the main player methods that are most commonly used

{| class="wikitable"

|-

! Methods

! Description

|-

| bool CheatsAllowed(CBasePlayer@ pPlayer, const string&amp; in szCheatName, bool fMustBeAlive = true) const

|

|-

| bool GetNextBestWeapon(CBasePlayer@ pPlayer, CBasePlayerItem@ pCurrentWeapon)

|

|-

| CBasePlayer@ FindPlayerByIndex(int index)

| Finds a player by index. Parameters: Index Integer

|-

| CBasePlayer@ FindPlayerByName(const string&amp; in szName, bool bCaseSensitive = true)

|

|-

| float SharedRandomFloat(uint iRandomSeed, float iLow, float iHigh)

|

|-

| int GetAmmoIndex(const string&amp; in szAmmoName)

|

|-

| int GetNumPlayers() const

|

|-

| int SharedRandomLong(uint iRandomSeed, int iLow, int iHigh)

|

|-

| void ApplyMapCfgToPlayer(CBasePlayer@ pPlayer, bool fReEquip = false)

|

|}



=== Respawn ===



{| class="wikitable"

|-

! Methods

! Description

|-

| void RespawnAllPlayers(bool fMoveLivingPlayers = true, bool fRespawnDeadPlayers = false)

| Relocates all players to active spawn points. If a player is dead and fRespawnDeadPlayers is true, the player is respawned.

|-

| void RespawnPlayer(CBasePlayer@ pPlayer, bool fMoveLivingPlayers = true, bool fRespawnDeadPlayers = false)

| Relocates the given player to an active spawn point. If the player is dead and fRespawnDeadPlayers is true, the player is respawned.

|}



=== SpawnPoint ===



{| class="wikitable"

|-

! Methods

! Description

|-

| bool IsSpawnPointOccupied(CBaseEntity@ pSpawnEnt)

| Returns whether the given spawn point entity is occupied.

|-

| bool IsSpawnPointValid(CBaseEntity@ pSpawnEnt, CBaseEntity@ pPlayer)

| Returns whether the given spawn point is valid for the given player.

|-

| bool SpawnPointFilterPasses(CBaseEntity@ pSpawnEnt, CBaseEntity@ pPlayer)

| Returns whether the given player passes the given spawn pointÔÇÖs filter.

|}

=== Bots ===



{| class="wikitable"

|-

! Methods

! Description

|-

| CBasePlayer@ CreateBot(const string&amp; in szName)

| Creates a bot with the given name. Parameters: Name String.

|-

| void BotDisconnect(CBasePlayer@ pBot)

| Disconnects the bot. This will call ClientDisconnect and removes the entity. Do not use the entity after this call. Parameters: Bot Player Handle.

|}



=== Admin Level ===

{| class="wikitable"

|-

! Methods

! Description

|-

| AdminLevel_t AdminLevel(CBasePlayer@ pPlayer) const

| Returns the admin level for a given player. Parameters: Player Handle.

|-

| AdminLevel_t StringToAdminLevel(const string&amp; in szString) const

| Converts a string containing one of AdminLevelToStringÔÇÖs return values to an admin level. Returns ADMIN_NO if the string cannot be converted to a suitable constant. Parameters: String.

|-

| string AdminLevelToString(const AdminLevel_t adminLevel) const

| Converts the admin level to a string. If the level is an invalid value, an empty string is returned. Parameters: Admin Level (See [https://baso88.github.io/SC_AngelScript/docs/AdminLevel_t.htm Admin Level] enum).

|}



=== SayText ===



{| class="wikitable"

|-

! Methods

! Description

|-

| void SayText(CBasePlayer@ pTargetPlayer, const string&amp; in szText)

| Says text to a specific player. Parameters: Player Handle, Text String.

|-

| void SayTextAll(CBasePlayer@ pOriginatingPlayer, const string&amp; in szText)

| Says text to all players. Parameters: Originating Player Handle, Text String.

|}



=== ClientPrint ===



'''Obs: To make full use of the szLine parameters, use <code>%s</code> on the szMessage line to use the rest of the lines parameters (one <code>%s</code> for each line).'''<br />

Example:



<syntaxhighlight lang="cpp">g_PlayerFuncs.ClientPrintAll( HUD_PRINTCENTER, "this %s %s %s %s", "is", "a", "test", "message" );</syntaxhighlight>

Which becomes in game: <code>this is a test message</code>.



<span id="showmessage"></span>

=== ShowMessage ===



{| class="wikitable"

|-

! Methods

! Description

|-

| void ShowMessage(CBasePlayer@ pTargetPlayer, const string&amp; in szString)

| Shows a message to the given player.

|-

| void ShowMessageAll(const string&amp; in szString)

| Shows a message to all players.

|}



=== HudElements ===



{| class="wikitable"

|-

! Methods

! Description

|-

| void HudCustomSprite(CBasePlayer@ pTargetPlayer, const HUDSpriteParams&amp; in params)

| Shows a custom HUD sprite to a given player or to all players if pTargetPlayer is not specified. Parameters: Target Player Handle, HUD Sprite Params (See [https://baso88.github.io/SC_AngelScript/docs/HUDSpriteParams.htm HUDSpriteParams] class).

|-

| void HudMessage(CBasePlayer@ pTargetPlayer, const HUDTextParams&amp; in textParams, const string&amp; in szMessage)

| Shows a HUD message to a given player. Parameters: Target Player Handle, HUD Text Params (See [https://baso88.github.io/SC_AngelScript/docs/HUDTextParams.htm HUDTextParams] class), Message String.

|-

| void HudMessageAll(const HUDTextParams&amp; in textParams, const string&amp; in szMessage)

| Shows a HUD message to all players. Parameters: HUD Text Params (See [https://baso88.github.io/SC_AngelScript/docs/HUDTextParams.htm HUDTextParams] class), Message String.

|-

| void HudNumDisplay(CBasePlayer@ pTargetPlayer, const HUDNumDisplayParams&amp; in params)

| Shows a custom numeric display to a given player or to all players if pTargetPlayer is not specified. Parameters: Target Player Handle, HUD Numerical Display Params (See [https://baso88.github.io/SC_AngelScript/docs/HUDNumDisplayParams.htm HUDNumDisplayParams] class)

|-

| void HudTimeDisplay(CBasePlayer@ pTargetPlayer, const HUDNumDisplayParams&amp; in params)

| Shows a custom time display to a given player or to all players if pTargetPlayer is not specified. Parameters: Target Player Handle, HUD Numerical Display Params (See [https://baso88.github.io/SC_AngelScript/docs/HUDNumDisplayParams.htm HUDNumDisplayParams] class)

|-

| void HudToggleElement(CBasePlayer@ pTargetPlayer, uint8 iChannel, bool fVisible)

| Shows or hides HUD element occupying a given channel. Parameters: Target Player Handle, Channel Integer, Visible Bool.

|-

| void HudUpdateNum(CBasePlayer@ pTargetPlayer, uint8 iChannel, float flValue)

| Updates value of a custom numeric display. Parameters: Target Player Handle, Channel Integer, Value Float.

|-

| void HudUpdateTime(CBasePlayer@ pTargetPlayer, uint8 iChannel, float flTime)

| Updates value of a custom time display. Parameters: Target Player Handle, Channel Integer, Time Float.

|}



=== Player Screen Effects ===



{| class="wikitable"

|-

! Methods

! Description

|-

| void ConcussionEffect(CBaseEntity@ pEntity, float amplitude, float frequency, float fadeTime)

| Applies concussion effect to a given player. Parameters: Player Entity Handle, Amplitude Float, Frequency Float, Fade Out Time Float.

|-

| void ScreenFade(CBaseEntity@ pEntity, const Vector&amp; in color, float fadeTime, float fadeHold, int alpha, int flags)

| Fades the screen of a given player to a given color. Parameters: Player Entity Handle, Color Vector, Fade Out Time Float, Fade Hold Time, Color Brightness Alpha Integer, Flags Integer (See [https://baso88.github.io/SC_AngelScript/docs/FFADE.htm FFade] enum).

|-

| void ScreenFadeAll(const Vector&amp; in color, float fadeTime, float fadeHold, int alpha, int flags)

| Fades the screen of all players to a given color. Parameters: Color Vector, Fade Out Time Float, Fade Hold Time, Color Brightness Alpha Integer, Flags Integer (See [https://baso88.github.io/SC_AngelScript/docs/FFADE.htm FFade] enum).

|-

| void ScreenShake(const Vector&amp; in center, float amplitude, float frequency, float duration, float radius)

| Shakes the screen for players near a certain location. Parameters: Center Vector, Amplitude Float, Frequency Float, Duration Float, Radius Float.

|-

| void ScreenShakeAll(const Vector&amp; in center, float amplitude, float frequency, float duration)

| Shakes the screen for all players. Parameters: Center Vector, Amplitude Float, Frequency Float, Duration Float, Radius Float.

|}



=== PrintKeyBindingString ===



{| class="wikitable"

|-

! Methods

! Description

|-

| void PrintKeyBindingString(CBasePlayer@ pPlayer, const string&amp; in szString)

| Prints a string containing key bindings to the screen of the given player.

|-

| void PrintKeyBindingStringAll(const string&amp; in szString)

| Prints a string containing key bindings to the screen of all players.

|}



[[Category:Scripting]]

← Older revision		Revision as of 15:06, 17 February 2025
Line 114:		Line 114:

	=== ClientPrint ===		=== ClientPrint ===
	'''Note: The szLine parameters below are not required and can be ignored when doing a message using this functionality.'''		'''Note: The <code>szLine</code> parameters below are not required and can be ignored when doing a message using this functionality.'''

	{\| class="wikitable" style="vertical-align:middle;"		{\| class="wikitable" style="vertical-align:middle;"
Line 121:		Line 121:
	! Description		! Description
	\|-		\|-
	\| void CenterPrintAll(const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")		\| <code>void CenterPrintAll(const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")
	\| Prints one or more messages centered on the HUD of all players. Parameters: Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).		\| Prints one or more messages centered on the HUD of all players. Parameters: Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).
	\|-		\|-
	\| void ClientPrint(CBasePlayer@ pTargetPlayer, HUD iMsgDest, const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")		\| <code>void ClientPrint(CBasePlayer@ pTargetPlayer, HUD iMsgDest, const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")
	\| Prints one or more messages on the HUD of the given player. Parameters: Target Player Handle, Message Destination (See HUD enum), Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).		\| Prints one or more messages on the HUD of the given player. Parameters: Target Player Handle, Message Destination (See HUD enum), Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).
	\|-		\|-
	\| void ClientPrintAll(HUD iMsgDest, const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")		\| <code>void ClientPrintAll(HUD iMsgDest, const string& in szMessage, const string& in szLine2 = "", const string& in szLine3 = "", const string& in szLine4 = "", const string& in szLine5 = "")
	\| Prints one or more messages on the HUD of all players. Parameters: Message Destination (See HUD enum), Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).		\| Prints one or more messages on the HUD of all players. Parameters: Message Destination (See HUD enum), Main Message String, Message String (2nd Line), Message String (3rd Line), Message String (4th Line), Message String (5th Line).
	\|}		\|}

	'''Obs: To make full use of the szLine parameters, use <code>%s</code> on the szMessage line to use the rest of the lines parameters (one <code>%s</code> for each line).'''<br />		'''Obs: To make full use of the szLine parameters, use <code>%s</code> on the <code>szMessage</code> line to use the rest of the lines parameters (one <code>%s</code> for each line).'''<br />
	Example:		Example:

CPlayerFuncs - Revision history

Outerbeast: /* Methods */

Outerbeast at 13:19, 17 February 2025

Outerbeast: /* ClientPrint */

Outerbeast: /* ClientPrint */

Outerbeast: /* Methods */

Outerbeast: /* Methods */

Outerbeast at 18:10, 14 February 2025

Outerbeast at 18:10, 14 February 2025

Outerbeast: Outerbeast moved page Player to CPlayerFuncs: just because

Outerbeast: Created page with "The CPlayerFuncs class contains global player related functionality. A single global Instance exists with the following declaration: const CPlayerFuncs g_..."

Outerbeast: Created page with "The `CPlayerFuncs` class contains global player related functionality. A single global Instance exists with the following declaration: `const CPlayerFuncs g_..."`