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

Class for character typed event. More...

#include <character_typed_event.h>

Inheritance diagram for Input::CharacterTypedEvent:
Events::Event

Public Member Functions

 CharacterTypedEvent (const unsigned char character)
 CharacterTypedEvent constructor. More...
 
unsigned char getCharacter () const noexcept
 Gets the character. 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
< CharacterTypedEvent
create (const unsigned char character)
 Factory function. More...
 

Detailed Description

Class for character typed event.

Constructor & Destructor Documentation

Input::CharacterTypedEvent::CharacterTypedEvent ( const unsigned char  character)
inline

CharacterTypedEvent constructor.

Parameters
[in]characterThe character

Member Function Documentation

static std::shared_ptr<CharacterTypedEvent> Input::CharacterTypedEvent::create ( const unsigned char  character)
inlinestatic

Factory function.

Parameters
[in]characterThe character
Returns
Newly constructed CharacterTypedEvent

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

unsigned char Input::CharacterTypedEvent::getCharacter ( ) const
inlinenoexcept

Gets the character.

Returns
The character.

Referenced by generated::getCharacterTypedEventModule().


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