system

base

class fireform.system.base

Base class for systems to inherit from.

motion

class fireform.system.motion(collision_mode='normal', ignore_masks=False)

Moves entities around, handling velocity acceleration and friction.

Is also resposible for detecting collisions.

Parameters:
collision_mode : string
  • If 'disabled', collisions will not be checked.
  • If 'normal', collisions will be checked.
  • If 'split', motion will occur on each axis sperately. Collision events will have the direction attribute set either 'horisontal' or 'vertical'.
ignore_masks : bool

If enabled, all entities will be treated as if they had rectangular collision masks. Defaults to False.

image

class fireform.system.image

This system draws images for you.

camera

class fireform.system.camera(letterbox=False)

Shove this in your world for cameras to work.

You probably want cameras to work.

debug

class fireform.system.debug(**kwargs)

Usefull for debugging.

Draws boxes around objects that have a position and size.

Parameters:
text_colour : tuple

Colour used to render text. Defaults to black.

outline_colour : tuple

Outline used for normal entities. Defaults to green.

outline_colour_solid : tuple

Outline used for solid entities. Defaults to bright green.

outline_colour_hover : tuple

Colour used to outline the entity the mouse is hovering over. Defaults to cyan.

outline_colour_hover : tuple

Colour used to outline errored entities. Defaults to red.

allow_edit : bool

Setting to True will allow entities to be inspected, moved and resized using the mouse. Defaults to False.

display : bool

Setting to True will display information about the state of the program. Defaults to True.