rui API

rui.rui module

class rui.rui.Component

Bases: object

class rui.rui.Entity(tag='')

Bases: object

Instances of Entity are unique IDs that hold Components. (optionally) tag is a string that refers to the entity

add_component(*args, **kwargs)

Checks if alive before doing something

check_alive(function)

get_component(*args, **kwargs)

Checks if alive before doing something

get_components(*args, **kwargs)

Checks if alive before doing something

get_tag(*args, **kwargs)

Checks if alive before doing something

get_uuid(*args, **kwargs)

Checks if alive before doing something

kill(*args, **kwargs)

Checks if alive before doing something

set_tag(*args, **kwargs)

Checks if alive before doing something

set_world(*args, **kwargs)

Checks if alive before doing something

class rui.rui.System

Bases: object

process(delta)

Update the system

set_world(world)

Sets the world this system belongs to

class rui.rui.World(delta=1)

Bases: object

A World holds all entities, groups, and systems

add_entities(*entities)

Add multiple entities to world All members of entities are of type Entity

add_entity(entity, second=False)

Add entity to world. entity is of type Entity

add_system(system)

Add system to the world. All systems will be processed on World.process() system is of type System

create_entity(tag='')

Creates Entity (optionally) tag is a string that is the tag of the Entity.

deregister_entity_from_group(entity, group)

Removes entity from group

get_delta()

Returns delta

get_entities()

Gets all entities

get_entities_by_components(*components)

Get entity by list of components All members of components must be of type Component

get_entity_by_tag(tag)

Get entity by tag tag is a string that is the tag of the Entity.

get_group(group)

Gets a specific group group is the string of a Group

process()

Processes entire world and all systems in it

register_entity_to_group(entity, group)

Add entity to a group. If group does not exist, entity will be added as first member entity is of type Entity group is a string that is the name of the group

remove_entity(entity, second=False)

Removes entity from world and kills entity

remove_system(system)

Removes system from world and kills system

set_delta(delta)

Sets delta

rui.exceptions module

exception rui.exceptions.DeadEntityError

Bases: exceptions.Exception

exception rui.exceptions.DuplicateEntityError(entity)

Bases: exceptions.Exception

exception rui.exceptions.DuplicateSystemError(system)

Bases: exceptions.Exception

exception rui.exceptions.NonUniqueTagError(tag)

Bases: exceptions.Exception

exception rui.exceptions.UnmanagedEntityError(entity)

Bases: exceptions.Exception

exception rui.exceptions.UnmanagedSystemError(system)

Bases: exceptions.Exception