shkyera.lib.events Namespace Reference

Classes
class	Event

Functions
def	add_event (Event type, list payload)
def	get ()
def	clear ()

Variables
list	events = []

Function Documentation

add_event()

def shkyera.lib.events.add_event	(	Event	type,
		list	payload
	)

Add an event to the event queue.

This function appends a new event to the event queue.

Parameters:
    type (Event): The type of the event, as defined in the Event enum.
    payload (list): A list containing additional data related to the event.

Returns:
    None

clear()

def shkyera.lib.events.clear

(

)

Clear the event queue.

This function removes all events from the event queue, effectively emptying it.

Returns:
    None

get()

def shkyera.lib.events.get

(

)

Retrieve the list of events in the event queue.

This function returns the current list of events in the event queue.

Returns:
    list: A list of events, each represented as a tuple with (type, payload).

Variable Documentation

events

list shkyera.lib.events.events = []