Documentation

Entities are the main part of Mokoi Games as they control everything. Currently Entities are written in Pawn but other languages may be added down the track.

Entity Entry Points

main()

The 'main' function is the main entry point to the entity. This is called each frame.

Init(...)

The 'Init' function is called on the entity when created. For local/map entities this is also called each loading of the map.

Close()

The 'Close' function is called on the entity when deleted. For local/map entities this is also called each closing of the map.

UpdatePosition()

The 'UpdatePosition' function is called on Global entities when switching maps. The main use for these to change the Display Objects.

Main Entity Entry Points

The main entity is required for games to work. The main entity has a couple of entry points to allow scripting enhancements.

save()

Called before the game state is saved.

load()

Called before the game state is loaded.

dialogbox(line)

This function is called then DialogShow, so you can have a custom dialog box.

Custom Entry Points

KeyboardInput(unicode)

When KeyboardWatch is used in a entity, all keyboard input is sent to this function.