Function list
The tables below summarize the functions in each framework file.
Tip: See Framework files for a listing of classes and modules.
[ACTOR]
| Scope | Member |
|---|---|
ACTOR. | APPLY_SPOT(SPOT: ACTOR_SPOT) |
ACTOR. | ON_ADDED() NEW HOOK |
ACTOR. | THINK() NEW HOOK |
ACTOR. | ON_REMOVED() NEW HOOK |
ACTOR. | IS_ADDED(): BOOL |
ACTOR. | SET_DEPTH(DEPTH: BYTE) |
ACTOR. | START_CLIP_FRAME(FRAME_INDEX: BYTE) |
ACTOR. | FREEZE_CLIP_FRAME(FRAME_INDEX: BYTE) |
ACTOR. | RENDER(SPRITE_INDEX: INT, FRAME_DELTA: PAIR) |
[ART_TYPES]
| Scope | Member |
|---|---|
TILEMAP. | COPY_FROM(SOURCE: TILEMAP) |
[CONSOLE]
| Scope | Member |
|---|---|
CONSOLE:: | INIT() |
CONSOLE:: | SET_COLOR(COLOR: INT) |
CONSOLE:: | PRINT(TEXT: STRING) |
CONSOLE:: | PRINT_INT(N: INT) |
CONSOLE:: | PRINT_CHAR(C: PAIR) |
CONSOLE:: | READ_KEY(): BYTE |
CONSOLE:: | CHECK_KEY(): BYTE |
CONSOLE:: | GET_BOOKMARK(): PAIR |
CONSOLE:: | GOTO_BOOKMARK(BOOKMARK: PAIR) |
CONSOLE:: | THINK() |
[ENGINE]
| Scope | Member |
|---|---|
TILE_LAYER. | LOAD_TILESET(TILESET: TILESET) |
TILE_LAYER. | LOAD_TILEMAP(TILEMAP: TILEMAP) |
TILE_LAYER. | GET_TILE_AT_COLROW(COL: INT, ROW: INT): PAIR |
TILE_LAYER. | SET_TILE_AT_COLROW(COL: INT, ROW: INT, TILE_CODES: PAIR) |
TILE_LAYER. | GET_TILE_AT_XY(X: INT, Y: INT): PAIR |
TILE_LAYER. | SET_TILE_AT_XY(X: INT, Y: INT, TILE_CODES: PAIR) |
TILE_LAYER. | GET_COLOR_AT_XY(X: INT, Y:INT): BYTE |
| Scope | Member |
|---|---|
ENGINE:: | INIT() |
ENGINE:: | LOAD_ACTOR_SPOT(SPOT: ACTOR_SPOT): ACTOR |
ENGINE:: | LOAD_ACTOR_SPOTS(SPOTS: ACTOR_SPOT[]) |
ENGINE:: | CLEAR_ACTORS() |
ENGINE:: | ADD_ACTOR(ACTOR: ACTOR) |
ENGINE:: | ADD_ACTOR_BEHIND(ACTOR: ACTOR) |
ENGINE:: | REMOVE_ACTOR(ACTOR: ACTOR) |
ENGINE:: | GET_FIRST_ACTOR(): ACTOR |
ENGINE:: | GET_NEXT_ACTOR(CURRENT: ACTOR): ACTOR |
ENGINE:: | GET_CAMERA_CX(): INT |
ENGINE:: | SET_CAMERA_CX(VALUE: INT) |
ENGINE:: | GET_CAMERA_CY(): INT |
ENGINE:: | SET_CAMERA_CY(VALUE: INT) |
ENGINE:: | RENDER() |
ENGINE:: | WAIT_FOR_PAINT() |
ENGINE:: | THINK() |
[KERNEL]
| Scope | Member |
|---|---|
ARRAY_*. | RESIZE(NEW_SIZE: INT) |
ARRAY_*. | COPY_FROM(SOURCE: ARRAY_P) |
| Scope | Member |
|---|---|
MATH:: | ABS(X: INT): INT |
MATH:: | SIGN(X: INT): INT |
MATH:: | BIT_AND(X: INT, Y: INT): INT |
MATH:: | BIT_OR(X: INT, Y: INT): INT |
MATH:: | BIT_XOR(X: INT, Y: INT): INT |
MATH:: | BIT_NOT(X: INT): INT |
MATH:: | SHIFT_LEFT(VALUE: INT, SHIFT_AMOUNT: INT): INT |
MATH:: | SHIFT_RIGHT_SIGNED(VALUE: INT, SHIFT_AMOUNT: INT): INT |
MATH:: | SHIFT_RIGHT_UNSIGNED(VALUE: INT, SHIFT_AMOUNT: INT): INT |
| Scope | Member |
|---|---|
KERNEL:: | TRACE_NUM(ID: BYTE) |
KERNEL:: | TRACE(MESSAGE: STRING) |
KERNEL:: | FAIL(MESSAGE: STRING) |
KERNEL:: | SLEEP() |
KERNEL:: | MEMCPY(TARGET: INT, SOURCE: INT, NUM_BYTES: INT) |
KERNEL:: | MEMSET_BYTE(TARGET: INT, VALUE: BYTE, NUM_BYTES: INT) |
KERNEL:: | MEMSET_PAIR(TARGET: INT, VALUE: PAIR, NUM_PAIRS: INT) |
KERNEL:: | COLLECT_GARBAGE() |
[SOUND]
| Scope | Member |
|---|---|
SOUND:: | INIT() |
SOUND:: | PLAY_TRACK(TRACK: TRACK, CHANNEL_INDEX: INT) |
SOUND:: | LOOP_TRACK(TRACK: TRACK, CHANNEL_INDEX: INT) |
SOUND:: | STOP_CHANNEL(CHANNEL_INDEX: INT) |
SOUND:: | PLAY_SONG(SONG: SONG) |
SOUND:: | LOOP_SONG(SONG: SONG) |
SOUND:: | IS_PLAYING(CHANNEL_INDEX: INT): BOOL |
SOUND:: | THINK() |