Messaging: GUI Events

This page lists all outgoing messages from the GUI subsystem to the Game. These messages are sent using the GUI_EVENT channel. Every message has a variable "EventType" specifying the type of the occured event.

Key pressed

This message is sent when a key is pressed. Note that this message is only sent every 300 milli seconds to prevent window flickering.

    <table>
    <tr>
            <th>Variable</th>
            <th>Value/Range</th>
            <th>Description</th>
    </tr>
    <tr>
                    <td>EventType</td>
                    <td>i6e::modules::GUIConfig::GUI_EVENT_KEY_DOWN </td>
                    <td></td>
            </tr>
            <tr>
                    <td>Keycode</td>
                    <td>int</td>
                    <td>The keycode containing the information which key was pressed</td>
            </tr>
    </table>

Key released

 This message is sent when a key is released. Note that this message is only sent every 300 milli seconds to prevent window flickering.

Variable	Value/Range	Description
EventType	i6e::modules::GUIConfig::GUI_EVENT_KEY_UP
Keycode	int	The keycode containing the information which key was released

Char injected

 This message is sent when a char is injected. Note that this message is only sent every 300 milli seconds to prevent window flickering.

  <table>
    <tr>
            <th>Variable</th>
            <th>Value/Range</th>
            <th>Description</th>
    </tr>
    <tr>
                    <td>EventType</td>
                    <td>i6e::modules::GUIConfig::GUI_EVENT_CHAR_INJECT </td>
                    <td></td>
            </tr>
            <tr>
                    <td>TextInt</td>
                    <td>int</td>
                    <td>Specified the char being injected.</td>
            </tr>
    </table>

Event occured

 This message is sent when someone has subscribed for an event (e.g. a button was clicked) using the GUIFacade::SubscribeEvent method

  <table>
    <tr>
            <th>Variable</th>
            <th>Value/Range</th>
            <th>Description</th>
    </tr>
    <tr>
                    <td>EventType</td>
                    <td>i6e::modules::GUIConfig::GUI_SUBSCRIBED_EVENT_OCCURED </td>
                    <td></td>
            </tr>
            <tr>
                    <td>Name</td>
                    <td>std::string</td>
                    <td>The name of the window firing the event.</td>
            </tr>
            <tr>
                    <td>Type</td>
                    <td>"Clicked", ...</td>
                    <td>Type of the fired event. (At the moment only "Clicked" available)</td>
            </tr>
    </table>