Event Queue

Event Queue

Event Structure:

table Event
{
    EventType m_type        // Always populated, specifies type of event.
    int m_oldPlayerID = {},
    int m_playerID = {}
    ComplexColor m_playerNameColor = {},
    ComplexColor m_oldPlayerNameColor = {},
    string m_playerName = {},
    string m_playerName2 = {},          // Player name with color embedded
    string m_oldPlayerName = {},
    string m_oldPlayerName2 = {},       // Player name with color embedded
    string m_cmd = {},
    int m_unitID = {},
    int m_soundID = {},
    string m_location = {},
    Vec2 m_pos = {},
    float m_radius = {},
    bool m_bVal = {},
    ExplosionEventType m_explosionEventType = {}
}

• Look at the comments in the definition of EventType to see which fields each EventType populates.
• TODO: Better explain which fields are populated depending on m_type

Example of reading events from queue

function gx_sim_update()
{
    while (!gx_is_event_queue_empty())
    {
        local ev = gx_pop_event_from_queue()
        if (ev.m_type == EventType.PlayerLeftGame)
        {
            gx_print("Player " + ev.m_playerID + " has left the game!")
        }
        else if (ev.m_type == EventType.PlayerNameChanged)
        {
            gx_print(ev.m_oldPlayerName + " changed name to " + ev.m_playerName)
        }
    }

    // do rest of game logic
}

Functions that operate on event queue:

• gx_is_event_queue_empty
• gx_pop_event_from_queue

Note:

• Any unpopped events are automatically popped off of queue after each gx_sim_update call.