Class PlayerKeys

Namespace

Uncreated.Warfare.Interaction

Assembly

Uncreated.Warfare.dll

Data about replicated player keys.

public static class PlayerKeys

Inheritance

object

PlayerKeys

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

KeyCount

Total number of keys in the key array.

public static readonly int KeyCount

Field Value

int

Methods

AddPressedKeyHandler(PlayerKey, KeyDown)

Invoked when a key is pressed down.

public static void AddPressedKeyHandler(PlayerKey key, KeyDown keyDown)

Parameters

key PlayerKey

keyDown KeyDown

Exceptions

ArgumentOutOfRangeException

Invalid key.

GameThreadException

AddReleasedKeyHandler(PlayerKey, KeyUp)

Invoked when a key is released.

public static void AddReleasedKeyHandler(PlayerKey key, KeyUp keyUp)

Parameters

key PlayerKey

keyUp KeyUp

Exceptions

ArgumentOutOfRangeException

Invalid key.

GameThreadException

IsKeyDown(WarfarePlayer, PlayerKey)

Check if a key is held down by a player.

public static bool IsKeyDown(this WarfarePlayer player, PlayerKey key)

Parameters

player WarfarePlayer

key PlayerKey

Returns

bool

Exceptions

ArgumentOutOfRangeException

Invalid key.

GameThreadException

RemovePressedKeyHandler(PlayerKey, KeyDown)

Invoked when a key is pressed down.

public static void RemovePressedKeyHandler(PlayerKey key, KeyDown keyDown)

Parameters

key PlayerKey

keyDown KeyDown

Exceptions

ArgumentOutOfRangeException

Invalid key.

GameThreadException

RemoveReleasedKeyHandler(PlayerKey, KeyUp)

Invoked when a key is released.

public static void RemoveReleasedKeyHandler(PlayerKey key, KeyUp keyUp)

Parameters

key PlayerKey

keyUp KeyUp

Exceptions

ArgumentOutOfRangeException

Invalid key.

GameThreadException

Events

PressedCrouch

Invoked when 'crouch' is pressed down.

public static event KeyDown PressedCrouch

Event Type

KeyDown

Exceptions

GameThreadException

PressedJump

Invoked when 'jump' is pressed down.

public static event KeyDown PressedJump

Event Type

KeyDown

Exceptions

GameThreadException

PressedLeanLeft

Invoked when 'lean left' is pressed down.

public static event KeyDown PressedLeanLeft

Event Type

KeyDown

Exceptions

GameThreadException

PressedLeanRight

Invoked when 'lean right' is pressed down.

public static event KeyDown PressedLeanRight

Event Type

KeyDown

Exceptions

GameThreadException

PressedPluginKey1

Invoked when 'plugin key 1' is pressed down.

public static event KeyDown PressedPluginKey1

Event Type

KeyDown

Exceptions

GameThreadException

PressedPluginKey2

Invoked when 'plugin key 2' is pressed down.

public static event KeyDown PressedPluginKey2

Event Type

KeyDown

Exceptions

GameThreadException

PressedPluginKey3

Invoked when 'plugin key 3' is pressed down.

public static event KeyDown PressedPluginKey3

Event Type

KeyDown

Exceptions

GameThreadException

PressedPluginKey4

Invoked when 'plugin key 4' is pressed down.

public static event KeyDown PressedPluginKey4

Event Type

KeyDown

Exceptions

GameThreadException

PressedPluginKey5

Invoked when 'plugin key 5' is pressed down.

public static event KeyDown PressedPluginKey5

Event Type

KeyDown

Exceptions

GameThreadException

PressedProne

Invoked when 'prone' is pressed down.

public static event KeyDown PressedProne

Event Type

KeyDown

Exceptions

GameThreadException

PressedSprint

Invoked when 'sprint' is pressed down.

public static event KeyDown PressedSprint

Event Type

KeyDown

Exceptions

GameThreadException

PressedSteadyAim

Invoked when 'steady aim' is pressed down.

public static event KeyDown PressedSteadyAim

Event Type

KeyDown

Exceptions

GameThreadException

ReleasedCrouch

Invoked when 'crouch' is released.

public static event KeyUp ReleasedCrouch

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedJump

Invoked when 'jump' is released.

public static event KeyUp ReleasedJump

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedLeanLeft

Invoked when 'lean left' is released.

public static event KeyUp ReleasedLeanLeft

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedLeanRight

Invoked when 'lean right' is released.

public static event KeyUp ReleasedLeanRight

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedPluginKey1

Invoked when 'plugin key 1' is released.

public static event KeyUp ReleasedPluginKey1

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedPluginKey2

Invoked when 'plugin key 2' is released.

public static event KeyUp ReleasedPluginKey2

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedPluginKey3

Invoked when 'plugin key 3' is released.

public static event KeyUp ReleasedPluginKey3

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedPluginKey4

Invoked when 'plugin key 4' is released.

public static event KeyUp ReleasedPluginKey4

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedPluginKey5

Invoked when 'plugin key 5' is released.

public static event KeyUp ReleasedPluginKey5

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedProne

Invoked when 'prone' is released.

public static event KeyUp ReleasedProne

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedSprint

Invoked when 'sprint' is released.

public static event KeyUp ReleasedSprint

Event Type

KeyUp

Exceptions

GameThreadException

ReleasedSteadyAim

Invoked when 'steady aim' is released.

public static event KeyUp ReleasedSteadyAim

Event Type

KeyUp

Exceptions

GameThreadException