Nymph Game Engine
Chaiscript based Game Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Input::KeyDownEvent Class Reference

Class for key down event. More...

#include <key_down_event.h>

Inheritance diagram for Input::KeyDownEvent:
Events::Event

Public Member Functions

 KeyDownEvent (const int key)
 Constructor for KeyDownEvent. More...
 
int getKey () const noexcept
 Gets the key. More...
 
- Public Member Functions inherited from Events::Event
 Event (const EventType &type)
 Event constructor. More...
 
EventType getEventType () const
 Gets the event type. More...
 

Static Public Member Functions

static std::shared_ptr
< KeyDownEvent
create (const int key)
 Factory function. More...
 

Detailed Description

Class for key down event.

Constructor & Destructor Documentation

Input::KeyDownEvent::KeyDownEvent ( const int  key)
inline

Constructor for KeyDownEvent.

Parameters
[in]keyThe key

Member Function Documentation

static std::shared_ptr<KeyDownEvent> Input::KeyDownEvent::create ( const int  key)
inlinestatic

Factory function.

Parameters
[in]keyThe key
Returns
Newly constructed KeyDownEvent

Referenced by generated::getKeyDownEventModule(), and Input::InputSystem::pollForInput().

int Input::KeyDownEvent::getKey ( ) const
inlinenoexcept

Gets the key.

Returns
The key.

Referenced by generated::getKeyDownEventModule().


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