Kaplay.OffScreen

Modules

Comp

Types

offscreenOptions

type offscreenOptions = {
  hide?: bool,
  pause?: bool,
  destroy?: bool,
  distance?: int,
}

Fields

hide option < bool >

pause option < bool >

destroy option < bool >

distance option < int >

Values

addOffScreenComponent

let addOffScreen: (
  Kaplay.Context.t,
  ~options: offscreenOptions=?,
) => Kaplay.Types.comp

Parameters

Kaplay.Context.t

option < offscreenOptions >

Return type

Kaplay.Types.comp

onExitScreen

onExitScreen(context, handler) register an event that runs when object goes out of view.

let onExitScreen: (T.t, unit => unit) => unit

Parameters

T.t

unit

unit

Return type

unit