SCR_CharacterHelper Interface Reference

Static Public Member Functions
static IEntity	GetPlayer ()
	Return the player-controlled entity See EntityUtils.GetPlayer()
static bool	IsPlayer (IEntity entity)
	Check if the provided entity is the local player See EntityUtils.GetPlayer()
static SCR_ECharacterControlType	GetPlayerControlType (int playerID)
	Checks player control type based on admin list, GM status, admin status.
static SCR_ECharacterControlType	GetCharacterControlType (IEntity entity)
	Determines entity control type based on player ownership, admin status, or AI control.
static bool	IsAPlayer (IEntity entity)
	Check if the provided entity is -a- player - a human-controlled entity See EntityUtils.IsPlayer()
static bool	IsPlayerOrAIOwner (notnull ChimeraCharacter character, out bool isAi=false)
	Checks if provided client is in control of provided character or if it is an AI then is this client the owner of it.

Member Function Documentation

GetCharacterControlType()

static SCR_ECharacterControlType SCR_CharacterHelper.GetCharacterControlType ( IEntity entity )

static

Determines entity control type based on player ownership, admin status, or AI control.

Parameters

[in]

entity

Represents an in-game character entity, used to determine its control type (player, AI, admin, or game master)

Returns

character control type: PLAYER, POSSESSED_AI, AI or GM/Admin

GetPlayer()

static IEntity SCR_CharacterHelper.GetPlayer ( )

static

Return the player-controlled entity See EntityUtils.GetPlayer()

GetPlayerControlType()

static SCR_ECharacterControlType SCR_CharacterHelper.GetPlayerControlType ( int playerID )

static

Checks player control type based on admin list, GM status, admin status.

It does not check if player is possessing an AI, use GetCharacterControlType() instead

Parameters

[in]

playerID

Player ID represents the unique identifier for a player in the game.

Returns

the character control type for the specified player ID, indicating if they are a player, admin and/or game master.

IsAPlayer()

static bool SCR_CharacterHelper.IsAPlayer ( IEntity entity )

static

Check if the provided entity is -a- player - a human-controlled entity See EntityUtils.IsPlayer()

Parameters

[in]

entity

IsPlayer()

static bool SCR_CharacterHelper.IsPlayer ( IEntity entity )

static

Check if the provided entity is the local player See EntityUtils.GetPlayer()

Parameters

[in]

entity

IsPlayerOrAIOwner()

static bool SCR_CharacterHelper.IsPlayerOrAIOwner ( notnull ChimeraCharacter character, out bool isAi = false )

static

Checks if provided client is in control of provided character or if it is an AI then is this client the owner of it.

Parameters

[in]	character	to check
[out]	isAi

Returns

true when this client has the authority over provided character

---

The documentation for this interface was generated from the following file:

• Game/Helpers/SCR_CharacterHelper.c