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

Class for key repeat event. More...

#include <key_repeat_event.h>

Inheritance diagram for Input::KeyRepeatEvent:
Events::Event

Public Member Functions

 KeyRepeatEvent (const int key)
 Constructor for KeyRepeatEvent. 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
< KeyRepeatEvent
create (const int key)
 Factory function. More...
 

Detailed Description

Class for key repeat event.

Constructor & Destructor Documentation

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

Constructor for KeyRepeatEvent.

Parameters
[in]keyThe key

Member Function Documentation

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

Factory function.

Parameters
[in]keyThe key
Returns
Newly constructed KeyRepeatEvent

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

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

Gets the key.

Returns
The key.

Referenced by generated::getKeyRepeatEventModule().


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