Skip to main content

Function list

The tables below summarize the functions in each framework file.

Tip: See Framework files for a listing of classes and modules.

[actor]​

ScopeMember
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]​

ScopeMember
tilemap.copy_from(source: tilemap)

[console]​

ScopeMember
console::init(io_tilemap: io_tilemap)
console::set_color(color: int)
console::print(s: string)
console::print_text(text: text)
console::print_int(n: int)
console::print_char(c: pair)
console::read_key(): byte
console::get_bookmark(): pair
console::goto_bookmark(bookmark: pair)
console::think()

[engine]​

ScopeMember
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
ScopeMember
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]​

ScopeMember
array_*.copy_from(target_index: int, source: array_*,
source_index: int, num_elements: int
ScopeMember
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
ScopeMember
kernel::trace_num(id: byte)
kernel::trace(message: string)
kernel::fail(message: string)
kernel::sleep()
kernel::copy_memory_bytes(target: int, source: int, num_bytes: int)
kernel::set_memory_bytes(target: int, value: byte, num_bytes: int)
kernel::set_memory_pairs(target: int, value: pair, num_pairs: int)
kernel::collect_garbage()

[list]​

ScopeMember
list<t>clear()
list<t>get[](i: int): t
list<t>set[](i: int, value: t)
list<t>append(item: t)
list_intclear()
list_intget[](i: int): int
list_intset[](i: int, value: int)
list_intappend(item: int)

[sound]​

ScopeMember
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()

[text]​

ScopeMember
text.clear()
text.get[](i: int): char]
text.set[](i: int, value: char)
text.write(s: string)
text.write_text(text: text)
text.write_int(n: int)
text.write_char(c: char)
text.to_string(): string
text.compare_string(s: string): int
text.compare_text(text: text): int
text::compare(a: string, b: string): int
text::index_of(string: string, substring: string): int