Vertices Engine  v1.9.2.92
A Cross Platform game engine developed by Virtex Edge Design.
Loading...
Searching...
No Matches
VerticesEngine.Controllers.CharacterControllerInput Class Reference

Handles input and movement of a character in the game. Acts as a simple 'front end' for the bookkeeping and math of the character controller. More...

Public Member Functions

 CharacterControllerInput (Space owningSpace, vxCamera3D camera, vxEngine Engine)
 Constructs the character and internal physics character controller.
 
void Activate ()
 Gives the character control over the Camera and movement input.
 
void Deactivate ()
 Returns input control to the Camera.
 
void Update (float dt, KeyboardState previousKeyboardInput, KeyboardState keyboardInput, GamePadState previousGamePadInput, GamePadState gamePadInput)
 Handles the input and movement of the character.
 

Public Attributes

CharacterController CharacterController
 Physics representation of the character.
 

Properties

vxCamera3D Camera [get]
 Gets the camera to use for input.
 
CharacterCameraControlScheme CameraControlScheme [get]
 Gets the camera control scheme used by the character input.
 
bool IsActive [get]
 Gets whether the character controller's input management is being used.
 
Space Space [get]
 Owning space of the character.
 

Detailed Description

Handles input and movement of a character in the game. Acts as a simple 'front end' for the bookkeeping and math of the character controller.

Constructor & Destructor Documentation

◆ CharacterControllerInput()

VerticesEngine.Controllers.CharacterControllerInput.CharacterControllerInput ( Space owningSpace,
vxCamera3D camera,
vxEngine Engine )

Constructs the character and internal physics character controller.

Parameters
owningSpaceSpace to add the character to.
cameraCamera to attach to the character.
gameThe running game.

Member Function Documentation

◆ Update()

void VerticesEngine.Controllers.CharacterControllerInput.Update ( float dt,
KeyboardState previousKeyboardInput,
KeyboardState keyboardInput,
GamePadState previousGamePadInput,
GamePadState gamePadInput )

Handles the input and movement of the character.

Parameters
dtTime since last frame in simulation seconds.
previousKeyboardInputThe last frame's keyboard state.
keyboardInputThe current frame's keyboard state.
previousGamePadInputThe last frame's gamepad state.
gamePadInputThe current frame's keyboard state.

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