W3Class CPlayerInput

Not Stable Yet!

This article is part of the Witcher 3 scripting community documentation, which is considered to be UNSTABLE until after the release of the Blood and Wine DLC. Edits to these pages may be overwritten without notice!

CPlayerInput
Signature	class CPlayerInput
Sub-classes	W3PlayerTutorialInput
Version	1.12
Path	/game/player/playerInput.ws

Public Functions

BlockAction

public function BlockAction(action : EInputActionBlock, sourceName : name, lock : bool, optional keepOnSpawn : bool, optional onSpawnedNullPointerHackFix : CPlayer, optional isFromQuest : bool, optional isFromPlace : bool)

Parameters:

action : EInputActionBlock

sourceName : name

lock : bool

optional keepOnSpawn : bool

optional onSpawnedNullPointerHackFix : CPlayer

optional isFromQuest : bool

optional isFromPlace : bool

Location:

starts @ line 193, ends @ line 231

BlockAllActions

public function BlockAllActions(sourceName : name, lock : bool, optional exceptions : array<EInputActionBlock>, optional saveLock : bool, optional onSpawnedNullPointerHackFix : CPlayer, optional isFromQuest : bool, optional isFromPlace : bool)

Parameters:

sourceName : name

lock : bool

optional exceptions : array<EInputActionBlock>

optional saveLock : bool

optional onSpawnedNullPointerHackFix : CPlayer

optional isFromQuest : bool

optional isFromPlace : bool

Location:

starts @ line 347, ends @ line 359

BlockAllQuestActions

public final function BlockAllQuestActions(sourceName : name, lock : bool)

Parameters:

sourceName : name

lock : bool

Location:

starts @ line 362, ends @ line 397

BlockAllUIQuestActions

public function BlockAllUIQuestActions(sourceName : name, lock : bool)

Parameters:

sourceName : name

lock : bool

Location:

starts @ line 400, ends @ line 454

CbSpecialAttackPC

function CbSpecialAttackPC(action : SInputAction, isHeavy : bool)

Parameters:

action : SInputAction

isHeavy : bool

Location:

starts @ line 1742, ends @ line 1785

CbtAttackPC

function CbtAttackPC(action : SInputAction, isHeavy : bool)

Parameters:

action : SInputAction

isHeavy : bool

Location:

starts @ line 1555, ends @ line 1588

ClearLocksForNGP

public final function ClearLocksForNGP()

Location:

starts @ line 2629, ends @ line 2638

Dbg_UnlockAllActions

public function Dbg_UnlockAllActions()

Location:

starts @ line 2644, ends @ line 2658

Debug_ClearAllActionLocks

public final function Debug_ClearAllActionLocks(optional action : EInputActionBlock, optional all : bool)

Parameters:

optional action : EInputActionBlock

optional all : bool

Location:

starts @ line 2907, ends @ line 2920

Destroy

function Destroy()

Location:

starts @ line 173, ends @ line 175

FindActionLockIndex

public function FindActionLockIndex(action : EInputActionBlock, sourceName : name) : int

Parameters:

action : EInputActionBlock

sourceName : name

Returns:

int

Location:

starts @ line 181, ends @ line 190

ForceUnlockAllInputActions

public function ForceUnlockAllInputActions(alsoQuestLocks : bool)

Parameters:

alsoQuestLocks : bool

Location:

starts @ line 457, ends @ line 480

GetActionBlockedHudLockType

public final function GetActionBlockedHudLockType(action : EInputActionBlock) : name

Parameters:

action : EInputActionBlock

Returns:

name

Location:

starts @ line 520, ends @ line 537

GetActionLocks

public function GetActionLocks(action : EInputActionBlock) : array<SInputActionLock>

Parameters:

action : EInputActionBlock

Returns:

array<SInputActionLock>

Location:

starts @ line 498, ends @ line 501

GetAllActionLocks

public function GetAllActionLocks() : array<array<SInputActionLock>>

Returns:

array<array<SInputActionLock>>

Location:

starts @ line 503, ends @ line 506

Initialize

public function Initialize(isFromLoad : bool, optional previousInput : CPlayerInput)

Parameters:

isFromLoad : bool

optional previousInput : CPlayerInput

Location:

starts @ line 23, ends @ line 170

IsActionAllowed

public function IsActionAllowed(action : EInputActionBlock) : bool

Parameters:

action : EInputActionBlock

Returns:

bool

Location:

starts @ line 508, ends @ line 513

IsActionBlockedBy

public function IsActionBlockedBy(action : EInputActionBlock, sourceName : name) : bool

Parameters:

action : EInputActionBlock

sourceName : name

Returns:

bool

Location:

starts @ line 515, ends @ line 518

PotDrinkTimer

public function PotDrinkTimer(isDoubleTapped : bool)

Parameters:

isDoubleTapped : bool

Location:

starts @ line 1085, ends @ line 1094

PushAlchemyScreen

final function PushAlchemyScreen()

Location:

starts @ line 897, ends @ line 911

PushBestiaryScreen

final function PushBestiaryScreen()

Location:

starts @ line 874, ends @ line 888

PushCharacterScreen

final function PushCharacterScreen()

Location:

starts @ line 694, ends @ line 701

PushCraftingScreen

final function PushCraftingScreen()

Location:

starts @ line 855, ends @ line 863

PushGlossaryScreen

final function PushGlossaryScreen()

Location:

starts @ line 920, ends @ line 934

PushInventoryScreen

final function PushInventoryScreen()

Location:

starts @ line 712, ends @ line 726

PushJournalScreen

final function PushJournalScreen()

Location:

starts @ line 806, ends @ line 821

PushMapScreen

final function PushMapScreen()

Location:

starts @ line 782, ends @ line 796

PushMeditationScreen

final function PushMeditationScreen()

Location:

starts @ line 831, ends @ line 845

PushMenuHub

final function PushMenuHub()

Location:

starts @ line 676, ends @ line 683

RemoveLocksOnSpawn

public function RemoveLocksOnSpawn()

Location:

starts @ line 482, ends @ line 496

SetPotionSelectionMode

public final function SetPotionSelectionMode(b : bool)

Parameters:

b : bool

Location:

starts @ line 1223, ends @ line 1226

TutorialForceRestoreRadialLocks

public final function TutorialForceRestoreRadialLocks(radialLocks : array<SInputActionLock>)

Parameters:

radialLocks : array<SInputActionLock>

Location:

starts @ line 250, ends @ line 254

TutorialForceUnblockRadial

public final function TutorialForceUnblockRadial() : array<SInputActionLock>

Returns:

array<SInputActionLock>

Location:

starts @ line 234, ends @ line 247

Public Vars

lastMovementDoubleTapName

var lastMovementDoubleTapName : name

Location:

defined @ line 2041

Event Handlers

OnBoatDismount

event OnBoatDismount(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2765

OnCastSign

event OnCastSign(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2062

OnCbtAttackHeavy

event OnCbtAttackHeavy(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1634

OnCbtAttackLight

event OnCbtAttackLight(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1590

OnCbtAttackWithAlternateHeavy

event OnCbtAttackWithAlternateHeavy(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1550

OnCbtAttackWithAlternateLight

event OnCbtAttackWithAlternateLight(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1545

OnCbtCameraLock

event OnCbtCameraLock(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2559

OnCbtCameraLockOrSpawnHorse

event OnCbtCameraLockOrSpawnHorse(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2548

OnCbtCiriAttackHeavy

event OnCbtCiriAttackHeavy(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1875

OnCbtCiriDash

event OnCbtCiriDash(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1960

OnCbtCiriDodge

event OnCbtCiriDodge(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1924

OnCbtCiriSpecialAttack

event OnCbtCiriSpecialAttack(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1855

OnCbtCiriSpecialAttackHeavy

event OnCbtCiriSpecialAttackHeavy(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1904

OnCbtComboDigitLeft

event OnCbtComboDigitLeft(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1099

OnCbtComboDigitRight

event OnCbtComboDigitRight(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1107

OnCbtDodge

event OnCbtDodge(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2006

OnCbtLockAndGuard

event OnCbtLockAndGuard(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2504

OnCbtRoll

event OnCbtRoll(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2012

OnCbtSelectLockTarget

event OnCbtSelectLockTarget(inputVector : Vector)

Parameters:

inputVector : Vector

Location:

starts @ line 2482

OnCbtSpecialAttackHeavy

event OnCbtSpecialAttackHeavy(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1817

OnCbtSpecialAttackLight

event OnCbtSpecialAttackLight(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1787

OnCbtSpecialAttackWithAlternateHeavy

event OnCbtSpecialAttackWithAlternateHeavy(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1737

OnCbtSpecialAttackWithAlternateLight

event OnCbtSpecialAttackWithAlternateLight(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1732

OnCbtThrowCastAbort

event OnCbtThrowCastAbort(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2445

OnCbtThrowItem

event OnCbtThrowItem(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2269

OnCbtThrowItemHold

event OnCbtThrowItemHold(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2373

OnChangeCameraPreset

event OnChangeCameraPreset(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2582

OnChangeCameraPresetByMouseWheel

event OnChangeCameraPresetByMouseWheel(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2590

OnCiriDrawWeapon

event OnCiriDrawWeapon(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2790

OnCiriHolsterWeapon

event OnCiriHolsterWeapon(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2811

OnCommDeckEditor

event OnCommDeckEditor(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 729

OnCommDrinkPot

event OnCommDrinkPot(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1067

OnCommDrinkPotion1

event OnCommDrinkPotion1(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1264

OnCommDrinkPotion2

event OnCommDrinkPotion2(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1291

OnCommDrinkPotion3

event OnCommDrinkPotion3(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1320

OnCommDrinkPotion4

event OnCommDrinkPotion4(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1342

OnCommDrinkpotionLowerHeld

event OnCommDrinkpotionLowerHeld(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1207

OnCommDrinkpotionUpperHeld

event OnCommDrinkpotionUpperHeld(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1191

OnCommGuard

event OnCommGuard(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 578

OnCommHoldFastMenu

event OnCommHoldFastMenu(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2837

OnCommMenuHub

event OnCommMenuHub(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 668

OnCommPanelAlch

event OnCommPanelAlch(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 890

OnCommPanelBestiary

event OnCommPanelBestiary(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 866

OnCommPanelChar

event OnCommPanelChar(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 687

OnCommPanelCrafting

event OnCommPanelCrafting(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 847

OnCommPanelFakeHud

event OnCommPanelFakeHud(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 961

OnCommPanelGlossary

event OnCommPanelGlossary(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 913

OnCommPanelInv

event OnCommPanelInv(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 704

OnCommPanelJour

event OnCommPanelJour(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 799

OnCommPanelMap

event OnCommPanelMap(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 775

OnCommPanelMapPC

event OnCommPanelMapPC(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 767

OnCommPanelMed

event OnCommPanelMed(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 752

OnCommPanelMeditation

event OnCommPanelMeditation(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 823

OnCommPanelUIResize

event OnCommPanelUIResize(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 949

OnCommSheatheAny

event OnCommSheatheAny(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1033

OnCommSheatheSilver

event OnCommSheatheSilver(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1059

OnCommSheatheSteel

event OnCommSheatheSteel(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1051

OnCommSilverSword

event OnCommSilverSword(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1005

OnCommSpawnHorse

event OnCommSpawnHorse(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 616

OnCommSprint

event OnCommSprint(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 542

OnCommSprintToggle

event OnCommSprintToggle(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 555

OnCommSteelSword

event OnCommSteelSword(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 978

OnCommWalkToggle

event OnCommWalkToggle(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 566

OnDbgHit

event OnDbgHit(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2677

OnDbgKillAll

event OnDbgKillAll(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2717

OnDbgKillAllTargetingPlayer

event OnDbgKillAllTargetingPlayer(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2742

OnDbgKillTarget

event OnDbgKillTarget(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2700

OnDbgResurrectPlayer

event OnDbgResurrectPlayer(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2728

OnDbgSpeedUp

event OnDbgSpeedUp(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2660

OnDiving

event OnDiving(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1369

OnDivingDodge

event OnDivingDodge(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1420

OnExpFistFightHeavy

event OnExpFistFightHeavy(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1472

OnExpFistFightLight

event OnExpFistFightLight(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1450

OnExpFocus

event OnExpFocus(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1496

OnFastMenu

event OnFastMenu(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2846

OnIngameMenu

event OnIngameMenu(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2878

OnMeditationAbort

event OnMeditationAbort(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2613

OnMovementDoubleTap

event OnMovementDoubleTap(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2043

OnSelectSign

event OnSelectSign(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1116

OnShowControlsHelp

event OnShowControlsHelp(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 936

OnThrowBomb

event OnThrowBomb(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2114

OnThrowBombAbort

event OnThrowBombAbort(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2257

OnThrowBombHold

event OnThrowBombHold(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2191

OnToggleHud

event OnToggleHud(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 2894

OnToggleItem

event OnToggleItem(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1172

OnToggleNextSign

event OnToggleNextSign(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1157

OnTogglePreviousSign

event OnTogglePreviousSign(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1164

OnToggleSigns

event OnToggleSigns(action : SInputAction)

Parameters:

action : SInputAction

Location:

starts @ line 1143