Provides functionality for wheeled vehicles.

class: CharacterControllerComponent

Parent Class: PrimaryControllerComponent

Location: scripts/Game/generated/Components/CharacterControllerComponent.c

—

wip

GetAnimationComponent();

Return type: CharacterAnimationComponent

GetWeaponManagerComponent();

Return type: BaseWeaponManagerComponent

GetCameraHandlerComponent();

Return type: CameraHandlerComponent

GetInventoryStorageManager();

Return type: InventoryStorageManagerComponent

GetVONComponent();

Return type: VoNComponent

GetInputContext();

Return type: CharacterInputContext

GetMovementType();

Return type: float

SetMovement(float type, vector movementDirLocal);

Update animation about state of movement, define speed and direction in local space of character

Return type: void

SetHeadingAngle(float newHeadingAngle, bool adjustAimingYaw = false);

set heading angle in radians

Return type: void

GetHeadingAngle();

Return type: float

SetAimingAngles(float yaw, float pitch);

set aiming angles in radians

Return type: void

GetStance();

Returns the current stance of the character.

Return type: ECharacterStance

GetCharacter();

Returns the current controlled character.

Return type: SCR_ChimeraCharacter

SetFireWeaponWanted(bool val);

Set wanted input action values

Return type: void

Set wanted input action values

SetThrow(bool val, bool cancelThrow);

Return type: void

Update simulation state with difference of world position

SetMovementDirWorld(vector movementDirWorld);

Return type: void

GetMovementDirWorld();

Return type: vector

Set the current weapon-raised state.

SetWeaponRaised(bool val);

Return type: void

Set the current weapon ADS state.

SetWeaponADS(bool val);

Return type: void

Set the current play gesture state.

SetPlayGesture(bool val);

Return type: void

SetFreeLook(bool val);

Return type: void

ResetPersistentStates(bool resetADSState = true, bool resetGadgetState = true);

Return type: void

Sets dynamic speed of this character. param value Desired speed as percentage <0,1>.

SetDynamicSpeed(float value);

Return type: void

Returns dynamic speed value. return Dynamic speed value as <0, 1>.

GetDynamicSpeed();

Return type: float

Sets dynamic stance of this character. param value Desired stance height as percentage of full erect <0,1>.

SetDynamicStance(float value);

Return type: void

Returns whether provided dynamic stance can be set for this character. see CharacterControllerComponent::SetDynamicStance(float value) param value Desired stance height as percentage of full erect <0,1>.

CanSetDynamicStance(float value);

Return type: bool

Returns current dynamic stance value. return Dynamic stance value as <0,1>.

GetDynamicStance();

Return type: float

Enables or disables inspection mode. param state Desired state true=enabled, disabled otherwise.

SetInspectionMode(bool state);

Return type: void

Returns whether inspection mode can be set. return True in case inspection mode can be set, false otherwise.

CanSetInspectionMode();

Return type: bool

Returns whether character is in inspection mode. return True in case character is in inspection mode, false otherwise.

GetIsInspectionMode();

Return type: bool

Sets inspection state if inspection state is enabled. param state Desired state.

SetInspectionState(float state);

Return type: void

Returns inspection state if inspection state is enabled. return Returns desired state.

GetInspectionState();

Return type: float

CharacterStanceChange STANCECHANGE_NONE = 0, STANCECHANGE_TOERECTED = 1, STANCECHANGE_TOCROUCH = 2, STANCECHANGE_TOPRONE = 3

SetStanceChange(int stance);

Return type: void

CharacterStanceChange STANCECHANGE_NONE = 0, STANCECHANGE_TOERECTED = 1, STANCECHANGE_TOCROUCH = 2, STANCECHANGE_TOPRONE = 3

CanChangeStance(int stance);

Return type: bool

ForceStance(int stance);

Return type: void

ForceStanceUp(int stance);

Return type: void

2 - right, 1 - left

SetRoll(int val);

Return type: void

SetJump(float val);

Return type: void

SetWantedLeaning(float val);

Return type: void

SetBanking(float val);

Return type: void

SetMeleeAttack(bool val);

Return type: void

Either character wants to lean

GetLeaning();

Return type: float

GetWantedLeaning();

Return type: float

IsAdjustingLeaning();

Return type: bool

Returns current amount of leaning applied

GetCurrentLeanAmount();

Return type: float

IsLeaning();

Return type: bool

GetADSTime();

Return type: float

IsWeaponRaised();

Return type: bool

IsWeaponObstructed();

Return type: bool

GetObstructionAlpha();

Return type: float

IsClimbing();

Return type: bool

IsSwimming();

Return type: bool

IsSprinting();

Return type: bool

IsChangingStance();

Return type: bool

IsWeaponADS();

Return type: bool

IsChangingFireMode();

Return type: bool

IsPlayingGesture();

Return type: bool

IsFreeLookEnabled();

Return type: bool

IsTrackIREnabled();

Return type: bool

IsFocusMode();

Return type: bool

GetWeaponADSInput();

Return type: bool

IsChangingItem();

Return type: bool

IsFalling();

Return type: bool

IsReloading();

Return type: bool

CanFire();

Return type: bool

IsDead();

Return type: bool

IsUsingItem();

Return type: bool

IsMeleeAttack();

Return type: bool

CanEngageChangeItem();

Return type: bool

Set weapon on character with switching animations. If true, the request was successful

SelectWeapon(BaseWeaponComponent newWeapon);

Return type: bool

SetMuzzle(int index);

Return type: bool

SetFireMode(int index);

Return type: bool

SetSightsRange(int index);

Return type: void

SetWeaponADSInput(bool val);

Return type: void

Set the safety of the current weapon. param safety True to set the weapon safety. param automatic True to set the automatic safety otherwise false to set manual safety. return Returns true if the action has been successfull otherwise false.

SetSafety(bool safety, bool automatic);

Return type: bool

Returns the current stamina value in <0, 1>. -1 if there is no stamina component attached to the current owner.

GetStamina();

Return type: float

Request weapon reload. If true, request was sucessful

ReloadWeapon();

Return type: bool

mag or projectile

ReloadWeaponWith(IEntity ammunitionEntity);

Return type: bool

Dying

Ragdoll();

Return type: void

Kills the character. Skips invincibility checks.

ForceDeath();

Return type: void

/* @NOTE(Leo): Temp solution, eventually will be solved by setting respective gadget graph attachments, unfortunately current state of Enf animation system is not allowing it and will be solved not earlier then 10.07 by @Michal Žák from conversation with @Théo Escamez: so heres how it works : for now we have 4 items> compass adrianov, compass SY183, Radio ANPRC68 and Radio R148 …where they are triggered respectively by integers 1 2 3 and 4…

TakeGadgetInLeftHand(IEntity gadget, int gadgetType, bool autoFocus = false, bool skipAnimations = false);

Return type: void

Performs gadget equip validation

CanEquipGadget(IEntity gadget);

Return type: bool

GetAttachedGadgetAtLeftHandSlot();

Return type: IEntity

Try to use bandage on specified body part for a specific duration. param bandage Bandage entity used for bandage action. param bodyPart Body part where the bandage will be applied. param duration Duration of the bandage in seconds. param bandageSelf True if the player is bandaging himself.

TryUseBandage(IEntity bandage, int bodyPart, float duration = 4.0, bool bandageSelf = true);

Return type: bool

Remove held gadget

RemoveGadgetFromHand(bool skipAnimations = false);

Return type: void

Put held gadget on hold

RecoverHiddenGadget(bool respectSettings, bool skipAnims);

Return type: void

Returns true if there is a gadget in hands.

IsGadgetInHands();

Return type: bool

Returns true if focus will be changed to requested

SetGadgetRaisedModeWanted(bool newRaised);

Return type: bool

Returns true if character will be (or is) using gadget in raised mode

IsGadgetRaisedModeWanted();

Return type: bool

Generic item Equippes an item in right hand, if swap is true then action performed without animations, accepts optional callback that will be triggered when action is completed

TryEquipRightHandItem(IEntity item, EEquipItemType type, bool swap = false, BaseUserAction callbackAction = null);

Return type: bool

Returns generic item attached to right hand. Returns null if there's none (or if active item is weapon)

GetRightHandItem();

Return type: IEntity

Try to use equipped item. return Returns true if the equipped item has been used.

TryUseEquippedItem();

Return type: bool

Try to use the specified item. param item The item which should be used. return Returns true if the item has been used.

TryUseItem(IEntity item);

Return type: bool

Returns true if the character can use an item.

CanUseItem();

Return type: bool

Starts character gesture with specified duration in milliseconds (if duration ⇐ 0, it will be played until StopCharacterGesture is called)

TryStartCharacterGesture(int gesture, int durationMS = 0);

Return type: bool

StopCharacterGesture();

Return type: void

Try to play the specified gesture. param gesture The gesture which should be played. param callbackAction Optional UserAction as callback that will be called when target animation event is hit or gesture is complete param confirmEvent return Returns true if the gesture has been played.

TryPlayItemGesture(EItemGesture gesture, BaseUserAction callbackAction = null, string confirmEvent = "");

Return type: bool

Returns true if the character is playing a gesture.

IsPlayingItemGesture();

Return type: bool

Returns true if the character can play a gesture.

CanPlayItemGesture();

Return type: bool

Returns true if the character can use provided ladder. if optional maxTestDistance or maxEntryAngle is below 0, distance for test will be taken from character's ladder auto detection settings

CanUseLadder(LadderComponent pLadder, float maxTestDistance = -1.0, float maxEntryAngle = -1.0, bool performTraceCheck = false);

Return type: bool

Start climbing provided ladder. Returns true if request was successful.

TryUseLadder(LadderComponent pLadder, float maxTestDistance = -1.0, float maxEntryAngle = -1.0);

Return type: bool

Script

RequestActionByID(int actionID, float value);

Return type: void

Returns true if the character is partially lowered.

IsPartiallyLowered();

Return type: bool

Returns the aiming angles in radians

GetAimingAngles();

Return type: vector

Returns the weapon angles in degrees

GetWeaponAngles();

Return type: vector

Returns the camera weapon angles in degrees

GetCameraWeaponAngles();

Return type: vector

GetCameraWeaponOffset();

Return type: vector

Returns the angular velocity in degrees/s

GetLookAtAngularVelocity();

Return type: vector

GetDisableMovementControls();

Return type: bool

SetDisableMovementControls(bool other);

Return type: void

GetDisableViewControls();

Return type: bool

SetDisableViewControls(bool other);

Return type: void

SetAimingSensitivity(float mouse, float gamepad, float ads);

Return type: void

GetAimingSensivity(out float mouse, out float gamepad, out float ads);

Return type: void

Sets gadget handling into persistent mode

SetStickyGadget(bool enable);

Return type: void

Sets ads and gadget focus into persistent mode

SetStickyADS(bool enable);

Return type: void

SetMaxZoomInADS(bool enable);

Return type: void

GetMaxZoomInADS();

Return type: bool

GetDisableWeaponControls();

Return type: bool

SetDisableWeaponControls(bool other);

Return type: void

GetMovementVelocity();

Return type: vector

GetMovementInput();

Return type: vector

GetVelocity();

Return type: vector

GetIsSprintingToggle();

Return type: bool

GetLastStanceChangeDelay();

Return type: float

GetCurrentMovementPhase();

Return type: int

GetCanFireWeapon();

Return type: bool

GetCanThrow();

Return type: bool

SetWeaponNoFireTime(float t);

Return type: void

IsInThirdPersonView();

Return type: bool

SetInThirdPersonView(bool state);

Caching third person view since profiling showed minor impact on cpu time when calling in to scripted method

Return type: void

GetStanceChangeDelayTime();

Return type: float

GetJumpSpeed();

Return type: float

GetMeleeAttackInput();

Return type: bool

GetPositionInView(vector pos, float angMax);

Returns whether a position is in the character's view param pos World Position to check is within view param angMax Maximum(exclusive) angular offset in Degrees to consider the position within view

Return type: bool

GetWeaponModifiers(float baseScale, float moveScale, out vector scaleA, out vector scaleB);

Returns modifiers for weapon sway/recoil based on movement, stance, etc Fills scaleA and scaleB with following modifier values: scaleA.x - modifier scaleX scaleA.y - modifier scaleY scaleB.x - speed scale scaleB.y - translation scale

[Obsolete(“This method will be removed soon!”)]

Return type: void

Returns locally cached stamina component or null if none.

GetStaminaComponent();

Return type: CharacterStaminaComponent

Check if character is not moving and not any other locomotion related action is being performed
IsCharacterStationary();

Return type: bool

OnInit(IEntity owner);

Called during EOnInit. param owner Entity this component is attached to.

Return type: void

OnDiag(IEntity owner, float timeslice);

Called during EOnDiag. Param owner Entity this component is attached to. param timeSlice Delta time since last update.

Return type: void

OnReloaded(IEntity owner, BaseWeaponComponent weapon);

Return type: void

OnPrepareControls(IEntity owner, ActionManager am, float dt, bool player);

Return type: void

OnApplyControls(IEntity owner, float timeSlice);

Return type: void

OnMeleeDamage(bool started);

Handling of melee events. Sends true if melee started, false, when melee ends

GetCanMeleeAttack();

Return type: bool

OnPerformAction();

Override to handle what happens after pressing F button, return false to use default cpp behavior

Return type: bool

CanGetOutVehicleScript();

Override to handle whether character can get out of vehicle via GetOut input action

Return type: bool

Handling of death

OnDeath(IEntity instigator);

Return type: void

OnGadgetStateChanged(IEntity gadget, bool isInHand, bool isOnGround);

Will be called when gadget taken/removed from hand

Return type: void

OnGadgetFocusStateChanged(IEntity gadget, bool isFocused);

Will be called when gadget fully transitioned to or canceled focus mode

Return type: void

OnItemUseBegan(IEntity item);

Will be called when item use action is started

Return type: void

OnItemUseComplete(IEntity item);

Will be called when item use action is complete

Return type: void

OnAnimationEvent(AnimationEventID animEventType, AnimationEventID animUserString, int intParam, float timeFromStart, float timeToEnd);

Return type: void

OnControlledByPlayer(IEntity owner, bool controlled);

Called when a player has been assigned to this controller

Return type: void