List of classes

This sections contains every class used in the Tilengine python wrapper API, grouped by category with all methods listed.

Engine

Main object for engine creation and rendering

  • Engine.create()
  • Engine.get_num_objects()
  • Engine.get_used_memory()
  • Engine.set_background_color()
  • Engine.disable_background_color()
  • Engine.set_background_bitmap()
  • Engine.set_background_palette()
  • Engine.set_raster_callback()
  • Engine.set_frame_callback()
  • Engine.set_render_target()
  • Engine.update_frame()
  • Engine.begin_frame()
  • Engine.draw_next_scanline()
  • Engine.set_load_path()
  • Engine.set_custom_blend_function()
  • Engine.get_available_sprite()
  • Engine.get_available_animation()

Window

Built-in window manager for easy setup and testing

  • Window.create()
  • Window.create_threaded()
  • Window.process()
  • Window.is_active()
  • Window.get_input()
  • Window.enable_input()
  • Window.assign_joystick()
  • Window.define_input_key()
  • Window.define_input_button()
  • Window.wait_redraw()
  • Window.enable_crt_effect()
  • Window.disable_crt_effect()
  • Window.get_ticks()
  • Window.delay()
  • Window.begin_frame()
  • Window.end_frame()

Layer

The Layer object manages each tiled background plane

  • Layer.setup()
  • Layer.set_palette()
  • Layer.set_position()
  • Layer.set_scaling()
  • Layer.set_transform()
  • Layer.set_pixel_mapping()
  • Layer.reset_mode()
  • Layer.set_blend_mode()
  • Layer.set_column_offset()
  • Layer.set_clip()
  • Layer.disable_clip()
  • Layer.set_mosaic()
  • Layer.disable_mosaic()
  • Layer.disable()
  • Layer.get_palette()
  • Layer.get_tile()

Sprite

The Sprite object manages each moving character onscreen

  • Sprite.setup()
  • Sprite.set_spriteset()
  • Sprite.set_flags()
  • Sprite.set_position()
  • Sprite.set_picture()
  • Sprite.set_palette()
  • Sprite.set_blend_mode()
  • Sprite.set_scaling()
  • Sprite.reset_mode()
  • Sprite.get_picture()
  • Sprite.enable_collision()
  • Sprite.check_collision()
  • Sprite.disable()
  • Sprite.get_palette()

Animation

The Animation object manages each animation for the sequencer engine

  • Animation.set_palette_animation()
  • Animation.set_palette_animation_source()
  • Animation.set_tileset_animation()
  • Animation.set_sprite_animation()
  • Animation.get_state()
  • Animation.set_delay()
  • Animation.disable()

Tilemap

The Tilemap object holds the grid of tiles that define the background layout

  • Tilemap.create()
  • Tilemap.fromfile()
  • Tilemap.clone()
  • Tilemap.get_tile()
  • Tilemap.set_tile()
  • Tilemap.copy_tiles()

Tileset

The Tileset object holds the graphic tiles used to render background layers from a Tilemap

  • Tileset.create()
  • Tileset.fromfile()
  • Tileset.clone()
  • Tileset.set_pixels()
  • Tileset.copy_tile()

Spriteset

The Spriteset object holds the graphic data used to render moving objects (sprites)

  • Spriteset.create()
  • Spriteset.fromfile()
  • Spriteset.clone()
  • Spriteset.set_sprite_data()
  • Spriteset.get_info()

Bitmap

The Bitmap object holds graphic data used to build in backgrounds, Tileset and Spriteset objects

  • Bitmap.create()
  • Bitmap.fromfile()
  • Bitmap.clone()
  • Bitmap.get_data()

Palette

The Palette object holds the color tables used by tileesets and spritesets to render sprites and backgrounds

  • Palette.create()
  • Palette.fromfile()
  • Palette.clone()
  • Palette.set_color()
  • Palette.mix()
  • Palette.add_color()
  • Palette.sub_color()
  • Palette.mod_color()

SequencePack

The SequencePack object holds a collection of Sequence objects

  • SequencePack.create()
  • SequencePack.fromfile()
  • SequencePack.find_sequence()
  • SequencePack.add_sequence()

Sequence

The Sequence object holds the sequences to feed the animation engine

  • Sequence.create_sequence()
  • Sequence.create_cycle()
  • Sequence.clone()

Miscellaneous classes

The following classes are used as enumerated types and to pass data to/from some functions

  • WindowFlags: window creation flags, used by Window.create()
  • Flags: flags for tiles and sprites
  • Blend: blending modes
  • Input: inputs list
  • Overlay: predefined overlay types
  • Tile: each cell inside a Tilemap
  • ColorStrip: each frame ina color cycle sequence
  • SequenceFrame: each frame in a Tilemap/Sprite sequence
  • SpriteInfo: holds info about a sprite, filled in by Spriteset.get_info()
  • TileInfo: holds info about a tile, filled in by Layer.get_tile()
  • SpriteData: used to feed sprite data for Spriteset.create()
  • TileAttributes: used to feed tile data for Tileset.create()
  • PixelMap: distortion mapping for Layer.set_pixel_mapping()
  • Color: basic RGB color used by all color methods