Skip to content
Rescript Kaplay bindings

Kaplay.GameObjRaw

Modules

Comp

Values

addChild

Add a game object from an array of components.

Caution: child positions are relative to the parent! If you use addPos inside the child, it will be relative to the parent.

let addChild: (T.t, array<Kaplay.Types.comp>) => 't
Parameters
T.t
Return type
array < Kaplay.Types.comp >
destroy
let destroy: T.t => unit
Parameters
T.t
Return type
unit
get
let get: (T.t, 'tag) => array<'t>
Parameters
T.t
Return type
array
getChildren

Get all children game objects. Be careful with the generic type you use.

let getChildren: T.t => array<'child>
Parameters
T.t
Return type
array
getId
let getId: T.t => int
Parameters
T.t
Return type
int
has

Check if game object has a certain component.

let has: (T.t, string) => bool
Parameters
T.t
string
Return type
bool
onDestroy
let onDestroy: (T.t, unit => unit) => Kaplay.KEventController.t
Parameters
T.t
unit
unit
Return type
Kaplay.KEventController.t
onKeyDown

Holding the key down

let onKeyDown: (T.t, Kaplay.Types.key => unit) => Kaplay.KEventController.t
Parameters
T.t
Kaplay.Types.key
unit
Return type
Kaplay.KEventController.t
onKeyPress

Hitting the key

let onKeyPress: (T.t, Kaplay.Types.key => unit) => Kaplay.KEventController.t
Parameters
T.t
Kaplay.Types.key
unit
Return type
Kaplay.KEventController.t
onKeyRelease

Lifting the key up

let onKeyRelease: (T.t, Kaplay.Types.key => unit) => Kaplay.KEventController.t
Parameters
T.t
Kaplay.Types.key
unit
Return type
Kaplay.KEventController.t
onUpdate
let onUpdate: (T.t, unit => unit) => unit
Parameters
T.t
unit
unit
Return type
unit
onUpdateWithController
let onUpdateWithController: (T.t, unit => unit) => Kaplay.KEventController.t
Parameters
T.t
unit
unit
Return type
Kaplay.KEventController.t
removeAll

Remove all children.

let removeAll: T.t => unit
Parameters
T.t
Return type
unit
trigger

Trigger a custom event on this game object.

let trigger: (T.t, string, 'arg) => unit
Parameters
T.t
string
Return type
unit
untag
let untag: (T.t, 'tag) => unit
Parameters
T.t
Return type
unit
unuse
let unuse: (T.t, string) => unit
Parameters
T.t
string
Return type
unit
use

use(t, comp) add a game component to this game object. Useful for adding conditional components after creation.

let use: (T.t, Kaplay.Types.comp) => unit
Parameters
T.t
Kaplay.Types.comp
Return type
unit

Unit

Types

t
type t

Values

addChild

Add a game object from an array of components.

Caution: child positions are relative to the parent! If you use addPos inside the child, it will be relative to the parent.

let addChild: (t, array<Kaplay.Types.comp>) => 't
Parameters
t
Return type
array < Kaplay.Types.comp >
destroy
let destroy: t => unit
Parameters
t
Return type
unit
get
let get: (t, 'tag) => array<'t>
Parameters
t
Return type
array
getChildren

Get all children game objects. Be careful with the generic type you use.

let getChildren: t => array<'child>
Parameters
t
Return type
array
getId
let getId: t => int
Parameters
t
Return type
int
has

Check if game object has a certain component.

let has: (t, string) => bool
Parameters
t
string
Return type
bool
onDestroy
let onDestroy: (t, unit => unit) => Kaplay.KEventController.t
Parameters
t
unit
unit
Return type
Kaplay.KEventController.t
onKeyDown

Holding the key down

let onKeyDown: (t, Kaplay.Types.key => unit) => Kaplay.KEventController.t
Parameters
t
Kaplay.Types.key
unit
Return type
Kaplay.KEventController.t
onKeyPress

Hitting the key

let onKeyPress: (t, Kaplay.Types.key => unit) => Kaplay.KEventController.t
Parameters
t
Kaplay.Types.key
unit
Return type
Kaplay.KEventController.t
onKeyRelease

Lifting the key up

let onKeyRelease: (t, Kaplay.Types.key => unit) => Kaplay.KEventController.t
Parameters
t
Kaplay.Types.key
unit
Return type
Kaplay.KEventController.t
onUpdate
let onUpdate: (t, unit => unit) => unit
Parameters
t
unit
unit
Return type
unit
onUpdateWithController
let onUpdateWithController: (t, unit => unit) => Kaplay.KEventController.t
Parameters
t
unit
unit
Return type
Kaplay.KEventController.t
removeAll

Remove all children.

let removeAll: t => unit
Parameters
t
Return type
unit
trigger

Trigger a custom event on this game object.

let trigger: (t, string, 'arg) => unit
Parameters
t
string
Return type
unit
untag
let untag: (t, 'tag) => unit
Parameters
t
Return type
unit
unuse
let unuse: (t, string) => unit
Parameters
t
string
Return type
unit
use

use(t, comp) add a game component to this game object. Useful for adding conditional components after creation.

let use: (t, Kaplay.Types.comp) => unit
Parameters
t
Kaplay.Types.comp
Return type
unit