C# Class GameCommon.GameControlsManager

Represents the player control management.
Show file Open project: DarrenHassan/GDM4242-GroupD Class Usage Examples

Public Methods

Method Description
DoJoystickEvent ( JoystickInputEvent e ) : bool
DoKeyDown ( KeyEvent e ) : bool

Sends the notice on pressing a system key.

DoKeyUp ( KeyEvent e ) : bool

Sends the notice on releasing a system key.

DoKeyUpAll ( ) : void
DoMouseDown ( EMouseButtons button ) : bool

Sends the notice on pressing a mouse button.

DoMouseMoveRelative ( Vec2 mouseOffset ) : void

Sends the notice on cursor moved.

DoMouseUp ( EMouseButtons button ) : bool

Sends the notice on releasing a mouse button.

DoTick ( float delta ) : void
GetItemByControlKey ( GameControlKeys controlKey ) : GameControlItem
Init ( ) : bool

Initialization the class.

Shutdown ( ) : void

Shutdown the class.

Private Methods

Method Description
InitInternal ( ) : bool
ShutdownInternal ( ) : void

Method Details

DoJoystickEvent() public method

public DoJoystickEvent ( JoystickInputEvent e ) : bool
e JoystickInputEvent
return bool

DoKeyDown() public method

Sends the notice on pressing a system key.
public DoKeyDown ( KeyEvent e ) : bool
e KeyEvent Key event arguments.
return bool

DoKeyUp() public method

Sends the notice on releasing a system key.
public DoKeyUp ( KeyEvent e ) : bool
e KeyEvent Key event arguments.
return bool

DoKeyUpAll() public method

public DoKeyUpAll ( ) : void
return void

DoMouseDown() public method

Sends the notice on pressing a mouse button.
public DoMouseDown ( EMouseButtons button ) : bool
button EMouseButtons A value indicating which button was clicked.
return bool

DoMouseMoveRelative() public method

Sends the notice on cursor moved.
public DoMouseMoveRelative ( Vec2 mouseOffset ) : void
mouseOffset Vec2 Current mouse position.
return void

DoMouseUp() public method

Sends the notice on releasing a mouse button.
public DoMouseUp ( EMouseButtons button ) : bool
button EMouseButtons A value indicating which button was clicked.
return bool

DoTick() public method

public DoTick ( float delta ) : void
delta float
return void

GetItemByControlKey() public method

public GetItemByControlKey ( GameControlKeys controlKey ) : GameControlItem
controlKey GameControlKeys
return GameControlItem

Init() public static method

Initialization the class.
public static Init ( ) : bool
return bool

Shutdown() public static method

Shutdown the class.
public static Shutdown ( ) : void
return void