Skip to main content

Framework files

The tables below summarize the classes and modules in each framework file.

Tip: See Function list for member functions.

[ACTOR]

KindNameNotes
TYPEACTOR_FACTORYTYPE ACTOR_FACTORY IS FUNC(): ACTOR
CLASSACTORAnimates a sprite and enables it to think

[ART_TYPES]

KindNameNotes
CLASSCLIPSprite animation clip, collection of CLIP_FRAME
CLASSCLIP_FRAMESprite animation frame bitmap image
CLASSTILETileset bitmap image
CLASSTILESETCollection of TILE
CLASSTILEMAPRectangular grid of tile codes
CLASSTRACK_EVENTInstructions to play one musical note
CLASSTRACKCollection of TRACK_EVENT
CLASSSONG_PATTERNCollection of TRACK objects with equal length
CLASSSONGList of pointers to patterns

[CONSOLE]

KindNameNotes
MODULECONSOLEDisplays text on the screen

[ENGINE]

KindNameNotes
MODULEGAMEPADAn easier way to read the gamepad for beginners
CLASSTILE_LAYERThe engine's TILE_LAYER_A, TILE_LAYER_B, and TILE_LAYER_C
MODULEENGINEDisplays a SCENE and manages its ACTOR's

[GENERATED]

This framework file is entirely generated by the Hybrix designer. Its contents vary depending on the content that you create using the designer and the names that you give to them.

KindNameNotes
MODULEARTArt resources emitted by the Hybrix designer
MODULEID_CLIPNamed access to CLIP art
MODULEID_TILEMAPNamed access to TILEMAP art
MODULEID_TILESETNamed access to TILESET art
MODULEID_FONTNamed access to FONT art
MODULEID_SOUNDNamed access to SOUND art
MODULEID_SONGNamed access to SONG art
MODULESYMBOLSNamed access to "picks" and "queries"

[IO]

KindNameNotes
CLASSIO_THEMEMMIO object for a Palix theme
CLASSIO_SPRITEMMIO object for a sprite
CLASSIO_TILEMAPMMIO object for a tilemap
CLASSIO_INPUT_EVENTMMIO object for a keyboard event
CLASSIO_HAND_CONTROLLERMMIO object for a mouse or gamepad device
MODULEIOAll MMIO location definitions

[JAMDAC]

KindNameNotes
CLASSIO_DYNAMICA Jamdac dynamic parameter
CLASSIO_ENVELOPEConfigures an envelope component
CLASSIO_WAVEConfigures a wave component
CLASSIO_WAVE_WITH_DIGITARConfigures a digitar component
CLASSIO_CHANNEL_EFFECTConfigures a channel effect component
CLASSIO_INSTRUMENTDefines an instrument
CLASSIO_REVERBConfigures the reverb component
CLASSIO_AUDIO_EVENTA single event in the IO_AUDIO_QUEUE
CLASSIO_AUDIO_QUEUEDefines a queue of events for one Jamdac channel

[KERNEL]

KindNameNotes
TYPESTRINGTYPE STRING IS BYTE[]
CLASSCLASS_ID_BASEEnables support for class operators
MODULEMATHIntrinsics such as ABS() and BIT_AND()
CLASSARRAY_*Pseudo classes used with arrays
MODULEKERNELSystem functions such as TRACE() and MEMCPY()

[SOUND]

KindNameNotes
MODULESOUNDPlayer for sounds and songs