Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_PlayerController Class Reference
Inheritance diagram for SCR_PlayerController:

Protected Member Functions

OnOwnershipChangedInvoker GetOnOwnershipChangedInvoker ()
override void OnOwnershipChanged (bool changing, bool becameOwner)
void OnInit (IEntity owner)
void OnPlayerRegistered (SCR_EditorManagerEntity managerEntity)
void OnBlockedListUpdated (bool success)
void OnAuthorsRequestFinished (set< SCR_EditableEntityAuthor > activeUGCAuthors)
void OnPlayerNameCacheUpdate (bool success)
void DisconnectFromGame ()
void OnBlockedPlayerJoined (int playerID)
override void OnControlledEntityChanged (IEntity from, IEntity to)
void UpdateTurretFireModeControlls (IEntity from, IEntity to)
void SetPossessedEntity (IEntity entity)
void SetInitialMainEntity (notnull IEntity entity)
bool IsPossessing ()
IEntity GetMainEntity ()
void OnRplMainEntityFromID ()
void SetAIActivation (IEntity entity, bool activate)
override void OnDestroyed (notnull Instigator killer)
override void OnUpdate (float timeSlice)
void UpdateLocalPlayerController ()
 Find if this is local player controller. We assume that this never changes during scenario.
void UpdateControls ()
 Update disabling of character controls in menus.
void UpdateUI ()
void ChangeMagnification (float value)
void ChangeWeaponOptics ()
SCR_CharacterControllerComponent GetCharacterController ()
void SetPlatformImagePSN (PlatformKind targetPlatformKind, notnull ImageWidget image, ImageWidget glow=null, bool setVisible=true)
void SetPlatformImagePC (PlatformKind targetPlatformKind, notnull ImageWidget image, ImageWidget glow=null, bool setVisible=true)
void SetPlatformImageXbox (PlatformKind targetPlatformKind, notnull ImageWidget image, ImageWidget glow=null, bool setVisible=true)

Static Protected Member Functions

static void SetGameUserSettings ()
static int GetLocalPlayerId ()
 Returns either a valid ID of local player or 0.
static IEntity GetLocalControlledEntity ()
static IEntity GetLocalMainEntity ()
static Faction GetLocalControlledEntityFaction ()
static Faction GetLocalMainEntityFaction ()

Protected Attributes

CharacterControllerComponent m_CharacterController
bool m_bIsLocalPlayerController
bool m_bIsPaused
bool m_bIsBinocularsZoomed
bool m_bRetain3PV
bool m_bGadgetFocus
SCR_EFocusToggleMode m_eFocusToggle
float m_fCharacterSpeed
RplId m_MainEntityID
IEntity m_MainEntity
bool m_bIsPossessing
ref OnBeforePossessedInvoker m_OnBeforePossess = new OnBeforePossessedInvoker()
ref OnPossessedInvoker m_OnPossessed = new OnPossessedInvoker()
ref OnControlledEntityChangedPlayerControllerInvoker m_OnControlledEntityChanged = new OnControlledEntityChangedPlayerControllerInvoker()
ref OnDestroyedPlayerControllerInvoker m_OnDestroyed = new OnDestroyedPlayerControllerInvoker()
ref OnOwnershipChangedInvoker m_OnOwnershipChangedInvoker = new OnOwnershipChangedInvoker()

Static Protected Attributes

static const float WALK_SPEED = 0.5
static const float FOCUS_ACTIVATION = 0.1
static const float FOCUS_DEACTIVATION = 0.05
static const float FOCUS_TIMEOUT = 0.3
static const float FOCUS_TOLERANCE = 0.005
static const float FOCUS_ANALOGUE_SCALE = 3.0
static float s_fADSFocus = 0.5
static float s_fPIPFocus = 1
static float s_fFocusTimeout
static float s_fFocusAnalogue
static bool s_bWasADS

Detailed Description

Definition at line 30 of file SCR_PlayerController.c.

Member Function Documentation

◆ ChangeMagnification()

void SCR_PlayerController::ChangeMagnification ( float value)
inlineprotected

Definition at line 656 of file SCR_PlayerController.c.

◆ ChangeWeaponOptics()

void SCR_PlayerController::ChangeWeaponOptics ( )
inlineprotected

Definition at line 664 of file SCR_PlayerController.c.

◆ DisconnectFromGame()

void SCR_PlayerController::DisconnectFromGame ( )
inlineprotected

Definition at line 209 of file SCR_PlayerController.c.

◆ GetCharacterController()

SCR_CharacterControllerComponent SCR_PlayerController::GetCharacterController ( )
inlineprotected

Definition at line 672 of file SCR_PlayerController.c.

◆ GetLocalControlledEntity()

IEntity SCR_PlayerController::GetLocalControlledEntity ( )
inlinestaticprotected

Get entity controlled by player on this machine.

Returns
Controlled entity

Definition at line 495 of file SCR_PlayerController.c.

◆ GetLocalControlledEntityFaction()

Faction SCR_PlayerController::GetLocalControlledEntityFaction ( )
inlinestaticprotected

Get faction of currently controlled local player entity.

Returns
Faction

Definition at line 527 of file SCR_PlayerController.c.

◆ GetLocalMainEntity()

IEntity SCR_PlayerController::GetLocalMainEntity ( )
inlinestaticprotected

Get player's main entity on this machine. When not possessing, this will be the same as GetControlledEntity() When possessing, this will be player's main entity which was controlled before possessing started

Returns
Main player entity

Definition at line 511 of file SCR_PlayerController.c.

◆ GetLocalMainEntityFaction()

Faction SCR_PlayerController::GetLocalMainEntityFaction ( )
inlinestaticprotected

Get faction of local player's main entity. When not possessing, the entity will be the same as GetControlledEntity() When possessing, the entity will be player's main entity which was controlled before possessing started

Returns
Faction

Definition at line 551 of file SCR_PlayerController.c.

◆ GetLocalPlayerId()

int SCR_PlayerController::GetLocalPlayerId ( )
inlinestaticprotected

Returns either a valid ID of local player or 0.

Definition at line 481 of file SCR_PlayerController.c.

◆ GetMainEntity()

IEntity SCR_PlayerController::GetMainEntity ( )
inlineprotected

Get player's main entity. When not possessing, this will be the same as GetControlledEntity() When possessing, this will be player's main entity which was controlled before possessing started

Returns
Main player entity

Definition at line 446 of file SCR_PlayerController.c.

◆ GetOnOwnershipChangedInvoker()

OnOwnershipChangedInvoker SCR_PlayerController::GetOnOwnershipChangedInvoker ( )
inlineprotected
See also
PlayerController.OnOwnershipChanged for more information.

Definition at line 71 of file SCR_PlayerController.c.

◆ IsPossessing()

bool SCR_PlayerController::IsPossessing ( )
inlineprotected

Check if player is currently possessing an entity.

Returns
True when possessing
Examples
F:/Games/AReforger/scripts/Game/GameMode/SCR_GameModeEditor.c.

Definition at line 434 of file SCR_PlayerController.c.

◆ OnAuthorsRequestFinished()

void SCR_PlayerController::OnAuthorsRequestFinished ( set< SCR_EditableEntityAuthor > activeUGCAuthors)
inlineprotected

Definition at line 156 of file SCR_PlayerController.c.

◆ OnBlockedListUpdated()

void SCR_PlayerController::OnBlockedListUpdated ( bool success)
inlineprotected

Definition at line 134 of file SCR_PlayerController.c.

◆ OnBlockedPlayerJoined()

void SCR_PlayerController::OnBlockedPlayerJoined ( int playerID)
inlineprotected

Definition at line 218 of file SCR_PlayerController.c.

◆ OnControlledEntityChanged()

override void SCR_PlayerController::OnControlledEntityChanged ( IEntity from,
IEntity to )
inlineprotected

Definition at line 224 of file SCR_PlayerController.c.

◆ OnDestroyed()

override void SCR_PlayerController::OnDestroyed ( notnull Instigator killer)
inlineprotected

Definition at line 570 of file SCR_PlayerController.c.

◆ OnInit()

void SCR_PlayerController::OnInit ( IEntity owner)
inlineprotected

Definition at line 112 of file SCR_PlayerController.c.

◆ OnOwnershipChanged()

override void SCR_PlayerController::OnOwnershipChanged ( bool changing,
bool becameOwner )
inlineprotected
See also
PlayerController.OnOwnershipChanged for more information.

Definition at line 80 of file SCR_PlayerController.c.

◆ OnPlayerNameCacheUpdate()

void SCR_PlayerController::OnPlayerNameCacheUpdate ( bool success)
inlineprotected

Definition at line 202 of file SCR_PlayerController.c.

◆ OnPlayerRegistered()

void SCR_PlayerController::OnPlayerRegistered ( SCR_EditorManagerEntity managerEntity)
inlineprotected

Definition at line 122 of file SCR_PlayerController.c.

◆ OnRplMainEntityFromID()

void SCR_PlayerController::OnRplMainEntityFromID ( )
inlineprotected

Definition at line 455 of file SCR_PlayerController.c.

◆ OnUpdate()

override void SCR_PlayerController::OnUpdate ( float timeSlice)
inlineprotected

Definition at line 578 of file SCR_PlayerController.c.

◆ SetAIActivation()

void SCR_PlayerController::SetAIActivation ( IEntity entity,
bool activate )
inlineprotected

Definition at line 464 of file SCR_PlayerController.c.

◆ SetGameUserSettings()

void SCR_PlayerController::SetGameUserSettings ( )
inlinestaticprotected

Definition at line 266 of file SCR_PlayerController.c.

◆ SetInitialMainEntity()

void SCR_PlayerController::SetInitialMainEntity ( notnull IEntity entity)
inlineprotected

Set intial main entity of a player, for a case where an existing entity should be assigned instead of spawning a new one

Parameters
entityis the subject entity

Definition at line 408 of file SCR_PlayerController.c.

◆ SetPlatformImagePC()

void SCR_PlayerController::SetPlatformImagePC ( PlatformKind targetPlatformKind,
notnull ImageWidget image,
ImageWidget glow = null,
bool setVisible = true )
inlineprotected

Definition at line 1114 of file SCR_PlayerController.c.

◆ SetPlatformImagePSN()

void SCR_PlayerController::SetPlatformImagePSN ( PlatformKind targetPlatformKind,
notnull ImageWidget image,
ImageWidget glow = null,
bool setVisible = true )
inlineprotected

Definition at line 1088 of file SCR_PlayerController.c.

◆ SetPlatformImageXbox()

void SCR_PlayerController::SetPlatformImageXbox ( PlatformKind targetPlatformKind,
notnull ImageWidget image,
ImageWidget glow = null,
bool setVisible = true )
inlineprotected

Definition at line 1146 of file SCR_PlayerController.c.

◆ SetPossessedEntity()

void SCR_PlayerController::SetPossessedEntity ( IEntity entity)
inlineprotected

Set entity which will be possessed by player. Possed entity is controlled by player, but it's not the player.

Parameters
entityEntity to be possessed, or null to return control back to the original player

Definition at line 312 of file SCR_PlayerController.c.

◆ UpdateControls()

void SCR_PlayerController::UpdateControls ( )
inlineprotected

Update disabling of character controls in menus.

Definition at line 618 of file SCR_PlayerController.c.

◆ UpdateLocalPlayerController()

void SCR_PlayerController::UpdateLocalPlayerController ( )
inlineprotected

Find if this is local player controller. We assume that this never changes during scenario.

Definition at line 592 of file SCR_PlayerController.c.

◆ UpdateTurretFireModeControlls()

void SCR_PlayerController::UpdateTurretFireModeControlls ( IEntity from,
IEntity to )
inlineprotected

Definition at line 242 of file SCR_PlayerController.c.

◆ UpdateUI()

void SCR_PlayerController::UpdateUI ( )
inlineprotected

Definition at line 631 of file SCR_PlayerController.c.

Member Data Documentation

◆ FOCUS_ACTIVATION

const float SCR_PlayerController::FOCUS_ACTIVATION = 0.1
staticprotected

Definition at line 34 of file SCR_PlayerController.c.

◆ FOCUS_ANALOGUE_SCALE

const float SCR_PlayerController::FOCUS_ANALOGUE_SCALE = 3.0
staticprotected

Definition at line 38 of file SCR_PlayerController.c.

◆ FOCUS_DEACTIVATION

const float SCR_PlayerController::FOCUS_DEACTIVATION = 0.05
staticprotected

Definition at line 35 of file SCR_PlayerController.c.

◆ FOCUS_TIMEOUT

const float SCR_PlayerController::FOCUS_TIMEOUT = 0.3
staticprotected

Definition at line 36 of file SCR_PlayerController.c.

◆ FOCUS_TOLERANCE

const float SCR_PlayerController::FOCUS_TOLERANCE = 0.005
staticprotected

Definition at line 37 of file SCR_PlayerController.c.

◆ m_bGadgetFocus

bool SCR_PlayerController::m_bGadgetFocus
protected

Definition at line 50 of file SCR_PlayerController.c.

◆ m_bIsBinocularsZoomed

bool SCR_PlayerController::m_bIsBinocularsZoomed
protected

Definition at line 48 of file SCR_PlayerController.c.

◆ m_bIsLocalPlayerController

bool SCR_PlayerController::m_bIsLocalPlayerController
protected

Definition at line 46 of file SCR_PlayerController.c.

◆ m_bIsPaused

bool SCR_PlayerController::m_bIsPaused
protected

Definition at line 47 of file SCR_PlayerController.c.

◆ m_bIsPossessing

bool SCR_PlayerController::m_bIsPossessing
protected

Definition at line 60 of file SCR_PlayerController.c.

◆ m_bRetain3PV

bool SCR_PlayerController::m_bRetain3PV
protected

Definition at line 49 of file SCR_PlayerController.c.

◆ m_CharacterController

CharacterControllerComponent SCR_PlayerController::m_CharacterController
protected

Definition at line 45 of file SCR_PlayerController.c.

◆ m_eFocusToggle

SCR_EFocusToggleMode SCR_PlayerController::m_eFocusToggle
protected

Definition at line 51 of file SCR_PlayerController.c.

◆ m_fCharacterSpeed

float SCR_PlayerController::m_fCharacterSpeed
protected

Definition at line 52 of file SCR_PlayerController.c.

◆ m_MainEntity

IEntity SCR_PlayerController::m_MainEntity
protected

Definition at line 57 of file SCR_PlayerController.c.

◆ m_MainEntityID

RplId SCR_PlayerController::m_MainEntityID
protected

Definition at line 56 of file SCR_PlayerController.c.

◆ m_OnBeforePossess

ref OnBeforePossessedInvoker SCR_PlayerController::m_OnBeforePossess = new OnBeforePossessedInvoker()
protected

Definition at line 62 of file SCR_PlayerController.c.

◆ m_OnControlledEntityChanged

ref OnControlledEntityChangedPlayerControllerInvoker SCR_PlayerController::m_OnControlledEntityChanged = new OnControlledEntityChangedPlayerControllerInvoker()
protected

Definition at line 64 of file SCR_PlayerController.c.

◆ m_OnDestroyed

ref OnDestroyedPlayerControllerInvoker SCR_PlayerController::m_OnDestroyed = new OnDestroyedPlayerControllerInvoker()
protected

Definition at line 65 of file SCR_PlayerController.c.

◆ m_OnOwnershipChangedInvoker

ref OnOwnershipChangedInvoker SCR_PlayerController::m_OnOwnershipChangedInvoker = new OnOwnershipChangedInvoker()
protected

Definition at line 66 of file SCR_PlayerController.c.

◆ m_OnPossessed

ref OnPossessedInvoker SCR_PlayerController::m_OnPossessed = new OnPossessedInvoker()
protected

Definition at line 63 of file SCR_PlayerController.c.

◆ s_bWasADS

bool SCR_PlayerController::s_bWasADS
staticprotected

Definition at line 43 of file SCR_PlayerController.c.

◆ s_fADSFocus

float SCR_PlayerController::s_fADSFocus = 0.5
staticprotected

Definition at line 39 of file SCR_PlayerController.c.

◆ s_fFocusAnalogue

float SCR_PlayerController::s_fFocusAnalogue
staticprotected

Definition at line 42 of file SCR_PlayerController.c.

◆ s_fFocusTimeout

float SCR_PlayerController::s_fFocusTimeout
staticprotected

Definition at line 41 of file SCR_PlayerController.c.

◆ s_fPIPFocus

float SCR_PlayerController::s_fPIPFocus = 1
staticprotected

Definition at line 40 of file SCR_PlayerController.c.

◆ WALK_SPEED

const float SCR_PlayerController::WALK_SPEED = 0.5
staticprotected

Definition at line 33 of file SCR_PlayerController.c.

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