@kayelaa/canvas API - v0.2.15
Preparing search index...
KaylaInternals
GlobalKayla
Class GlobalKayla
Index
Constructors
constructor
Properties
current?
saves
log
Level
logger
Methods
use
Tick
use
Paint
use
Entity
use
Self
use
Initialization
use
Rect
use
Substep
use
Fiber
use
Fiber
Control
use
Current
Ticker
use
Current
Renderer
use
Current
Game
use
Current
Scene
use
State
use
Should
Refresh
use
Ref
use
Effect
use
Viewport
Effect
use
Exports
use
Global
Pointer
use
Pointer
use
Context
save
restore
Constructors
constructor
new
GlobalKayla
()
:
GlobalKayla
Returns
GlobalKayla
Properties
Optional
current
current
?:
KaylaFiber
saves
saves
:
{
current
?:
KaylaFiber
<
{}
,
Record
<
string
,
KaylaExportables
>
>
}
[]
log
Level
logLevel
:
"silent"
|
"warn"
|
"info"
|
"debug"
= "warn"
logger
logger
:
{
debug
:
(
...
args
:
any
[]
)
=>
void
;
info
:
(
...
args
:
any
[]
)
=>
void
;
warn
:
(
...
args
:
any
[]
)
=>
void
;
error
:
(
...
args
:
any
[]
)
=>
void
;
withFiber
:
(
fiber
:
KaylaFiber
<
{}
,
Record
<
string
,
KaylaExportables
>
>
,
level
:
"error"
|
"warn"
|
"info"
|
"debug"
,
msg
:
string
,
...
extra
:
any
[]
,
)
=>
void
;
}
= ...
Methods
use
Tick
useTick
(
onTick
:
(
deltaS
:
number
,
event
:
KaylaEvent
)
=>
void
,
substepper
?:
KaylaInternals
.
KaylaSubstepper
,
)
:
void
Parameters
onTick
:
(
deltaS
:
number
,
event
:
KaylaEvent
)
=>
void
substepper
:
KaylaInternals
.
KaylaSubstepper
= null
Returns
void
use
Paint
usePaint
(
onPaint
:
(
ctx
:
CanvasRenderingContext2D
,
event
:
KaylaEvent
)
=>
void
,
)
:
void
Parameters
onPaint
:
(
ctx
:
CanvasRenderingContext2D
,
event
:
KaylaEvent
)
=>
void
Returns
void
use
Entity
useEntity
()
:
KaylaElementRef
Returns
KaylaElementRef
use
Self
useSelf
<
T
>
(
init
:
()
=>
T
)
:
T
Type Parameters
T
Parameters
init
:
()
=>
T
Returns
T
use
Initialization
useInitialization
(
init
:
()
=>
void
|
(
()
=>
void
)
)
:
void
Parameters
init
:
()
=>
void
|
(
()
=>
void
)
Returns
void
use
Rect
useRect
(
type
?:
"self"
|
"parent"
|
"disposableSelf"
)
:
KaylaRect
Parameters
type
:
"self"
|
"parent"
|
"disposableSelf"
= "self"
Returns
KaylaRect
use
Substep
useSubstep
(
interval
:
number
|
"default"
)
:
KaylaInternals
.
KaylaSubstepper
Parameters
interval
:
number
|
"default"
Returns
KaylaInternals
.
KaylaSubstepper
use
Fiber
useFiber
()
:
UnsafeKaylaFiber
Returns
UnsafeKaylaFiber
use
Fiber
Control
useFiberControl
()
:
KaylaFiberControl
Returns
KaylaFiberControl
use
Current
Ticker
useCurrentTicker
()
:
LeaTickerII
Returns
LeaTickerII
use
Current
Renderer
useCurrentRenderer
()
:
KaylaInternals
.
KaylaRenderer
Returns
KaylaInternals
.
KaylaRenderer
use
Current
Game
useCurrentGame
()
:
KaylaInternals
.
KaylaGame
Returns
KaylaInternals
.
KaylaGame
use
Current
Scene
useCurrentScene
()
:
KaylaInternals
.
KaylaScene
Returns
KaylaInternals
.
KaylaScene
use
State
useState
<
T
>
(
initialValue
?:
T
,
__namedParameters
?:
{
alwaysRecall
?:
boolean
}
,
)
:
KaylaState
<
T
>
Type Parameters
T
Parameters
Optional
initialValue
:
T
__namedParameters
:
{
alwaysRecall
?:
boolean
}
= {}
Returns
KaylaState
<
T
>
use
Should
Refresh
useShouldRefresh
(
deps
:
KaylaState
<
any
>
[]
)
:
void
Parameters
deps
:
KaylaState
<
any
>
[]
Returns
void
use
Ref
useRef
(
initialValue
:
typeof
self
)
:
KaylaElementRef
Parameters
initialValue
:
typeof
self
Returns
KaylaElementRef
Deprecated
useRef
<
T
>
(
initialValue
:
T
)
:
KaylaRef
<
T
>
Type Parameters
T
Parameters
initialValue
:
T
Returns
KaylaRef
<
T
>
Deprecated
use
Effect
useEffect
(
onEffect
:
()
=>
void
|
(
()
=>
void
)
)
:
void
Parameters
onEffect
:
()
=>
void
|
(
()
=>
void
)
Returns
void
use
Viewport
Effect
useViewportEffect
(
onEffect
:
(
renderer
:
KaylaInternals
.
KaylaRenderer
,
width
:
number
,
height
:
number
,
)
=>
void
,
)
:
void
Parameters
onEffect
:
(
renderer
:
KaylaInternals
.
KaylaRenderer
,
width
:
number
,
height
:
number
)
=>
void
Returns
void
use
Exports
useExports
<
T
extends
FC
<
any
,
any
>
>
(
_fc
:
T
,
onExport
:
()
=>
KaylaExports
<
Exports
>
,
)
:
void
Type Parameters
T
extends
FC
<
any
,
any
>
Parameters
_fc
:
T
onExport
:
()
=>
KaylaExports
<
Exports
>
Returns
void
use
Global
Pointer
useGlobalPointer
(
onPointer
:
(
pos
:
Vector2
,
type
:
KaylaClickType
,
action
:
KaylaPointerAction
,
)
=>
void
,
config
?:
KaylaClickConfig
,
)
:
void
Parameters
onPointer
:
(
pos
:
Vector2
,
type
:
KaylaClickType
,
action
:
KaylaPointerAction
)
=>
void
Optional
config
:
KaylaClickConfig
Returns
void
use
Pointer
usePointer
(
onPointer
:
(
pos
:
Vector2
,
type
:
KaylaClickType
,
action
:
KaylaPointerAction
,
)
=>
void
,
config
?:
KaylaClickConfig
,
)
:
void
Parameters
onPointer
:
(
pos
:
Vector2
,
type
:
KaylaClickType
,
action
:
KaylaPointerAction
)
=>
void
Optional
config
:
KaylaClickConfig
Returns
void
use
Context
useContext
<
T
>
(
context
:
KaylaContext
<
T
>
)
:
T
Type Parameters
T
Parameters
context
:
KaylaContext
<
T
>
Returns
T
save
save
()
:
void
Returns
void
restore
restore
()
:
void
Returns
void
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
current
saves
log
Level
logger
Methods
use
Tick
use
Paint
use
Entity
use
Self
use
Initialization
use
Rect
use
Substep
use
Fiber
use
Fiber
Control
use
Current
Ticker
use
Current
Renderer
use
Current
Game
use
Current
Scene
use
State
use
Should
Refresh
use
Ref
use
Effect
use
Viewport
Effect
use
Exports
use
Global
Pointer
use
Pointer
use
Context
save
restore
@kayelaa/canvas API - v0.2.15
Loading...
Deprecated