@kayelaa/canvas 0.1.13 → 0.1.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +2 -3
- package/docs/@kayelaa/namespaces/Kayla/README.md +0 -67
- package/docs/@kayelaa/namespaces/Kayla/functions/createElement.md +0 -51
- package/docs/@kayelaa/namespaces/Kayla/functions/createGame.md +0 -55
- package/docs/@kayelaa/namespaces/Kayla/functions/createReassignableObject.md +0 -27
- package/docs/@kayelaa/namespaces/Kayla/functions/createRenderer.md +0 -38
- package/docs/@kayelaa/namespaces/Kayla/functions/createScene.md +0 -37
- package/docs/@kayelaa/namespaces/Kayla/functions/createUseHook.md +0 -83
- package/docs/@kayelaa/namespaces/Kayla/functions/setLogLevel.md +0 -21
- package/docs/@kayelaa/namespaces/Kayla/functions/useDisposableRef.md +0 -45
- package/docs/@kayelaa/namespaces/Kayla/functions/useNextStack.md +0 -28
- package/docs/@kayelaa/namespaces/Kayla/interfaces/FC.md +0 -41
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaCustomHookConfig.md +0 -86
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaElement.md +0 -31
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaFiberControl.md +0 -102
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaGame.md +0 -369
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaRect.md +0 -308
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaRef.md +0 -68
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaRenderer.md +0 -948
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaScene.md +0 -105
- package/docs/@kayelaa/namespaces/Kayla/interfaces/KaylaState.md +0 -266
- package/docs/@kayelaa/namespaces/Kayla/interfaces/UnsafeKaylaFiber.md +0 -618
- package/docs/@kayelaa/namespaces/Kayla/namespaces/JSX/README.md +0 -16
- package/docs/@kayelaa/namespaces/Kayla/namespaces/JSX/interfaces/IntrinsicElements.md +0 -9
- package/docs/@kayelaa/namespaces/Kayla/namespaces/JSX/type-aliases/Element.md +0 -11
- package/docs/@kayelaa/namespaces/Kayla/namespaces/JSX/type-aliases/ElementType.md +0 -11
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/README.md +0 -35
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/GlobalKayla.md +0 -425
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaEvent.md +0 -43
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaFiber.md +0 -526
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaGame.md +0 -391
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaInternalRef.md +0 -94
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaInternalState.md +0 -258
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaRect.md +0 -298
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaRectEntity.md +0 -1034
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaRenderer.md +0 -934
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaScene.md +0 -105
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/functions/createReassignableRef.md +0 -27
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/interfaces/KaylaFiberControl.md +0 -86
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/interfaces/KaylaInternalRefIm.md +0 -64
- package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/variables/singleGlobalInstance.md +0 -11
- package/docs/@kayelaa/namespaces/Kayla/type-aliases/ExportsOfFC.md +0 -17
- package/docs/@kayelaa/namespaces/Kayla/type-aliases/FCExports.md +0 -11
- package/docs/@kayelaa/namespaces/Kayla/type-aliases/FCProps.md +0 -39
- package/docs/@kayelaa/namespaces/Kayla/type-aliases/KaylaElementRef.md +0 -15
- package/docs/@kayelaa/namespaces/Kayla/type-aliases/KaylaExportables.md +0 -15
- package/docs/@kayelaa/namespaces/Kayla/type-aliases/KaylaExports.md +0 -21
- package/docs/@kayelaa/namespaces/Kayla/type-aliases/PropOfFC.md +0 -17
- package/docs/@kayelaa/namespaces/Kayla/type-aliases/Reassignable.md +0 -33
- package/docs/@kayelaa/namespaces/Kayla/variables/KaylaFragment.md +0 -35
- package/docs/@kayelaa/namespaces/Kayla/variables/self.md +0 -24
- package/docs/@kayelaa/namespaces/Kayla/variables/useEffect.md +0 -40
- package/docs/@kayelaa/namespaces/Kayla/variables/useEntity.md +0 -52
- package/docs/@kayelaa/namespaces/Kayla/variables/useExports.md +0 -52
- package/docs/@kayelaa/namespaces/Kayla/variables/useFiber.md +0 -31
- package/docs/@kayelaa/namespaces/Kayla/variables/useFiberControl.md +0 -45
- package/docs/@kayelaa/namespaces/Kayla/variables/useInitialization.md +0 -49
- package/docs/@kayelaa/namespaces/Kayla/variables/usePaint.md +0 -31
- package/docs/@kayelaa/namespaces/Kayla/variables/useRect.md +0 -38
- package/docs/@kayelaa/namespaces/Kayla/variables/useRef.md +0 -83
- package/docs/@kayelaa/namespaces/Kayla/variables/useSelf.md +0 -55
- package/docs/@kayelaa/namespaces/Kayla/variables/useShouldRefresh.md +0 -41
- package/docs/@kayelaa/namespaces/Kayla/variables/useState.md +0 -70
- package/docs/@kayelaa/namespaces/Kayla/variables/useTick.md +0 -31
- package/docs/@kayelaa/namespaces/LEA/README.md +0 -79
- package/docs/@kayelaa/namespaces/LEA/classes/DeltaTweenII.md +0 -372
- package/docs/@kayelaa/namespaces/LEA/classes/GEmitterMemory.md +0 -189
- package/docs/@kayelaa/namespaces/LEA/classes/LeaEntityII.md +0 -634
- package/docs/@kayelaa/namespaces/LEA/classes/LeaEventEmitter.md +0 -273
- package/docs/@kayelaa/namespaces/LEA/classes/LeaGameII.md +0 -261
- package/docs/@kayelaa/namespaces/LEA/classes/LeaRendererII.md +0 -705
- package/docs/@kayelaa/namespaces/LEA/classes/LeaSceneII.md +0 -428
- package/docs/@kayelaa/namespaces/LEA/classes/LeaTickerII.md +0 -488
- package/docs/@kayelaa/namespaces/LEA/classes/LeaTimeout.md +0 -490
- package/docs/@kayelaa/namespaces/LEA/classes/LiaAudio.md +0 -425
- package/docs/@kayelaa/namespaces/LEA/classes/LiaAudioSrc.md +0 -423
- package/docs/@kayelaa/namespaces/LEA/classes/LiaOscSFX.md +0 -403
- package/docs/@kayelaa/namespaces/LEA/classes/RectLeaEntity.md +0 -992
- package/docs/@kayelaa/namespaces/LEA/classes/Vector2.md +0 -501
- package/docs/@kayelaa/namespaces/LEA/functions/colToRGBA.md +0 -35
- package/docs/@kayelaa/namespaces/LEA/functions/editRGBA.md +0 -39
- package/docs/@kayelaa/namespaces/LEA/functions/generateUUID.md +0 -17
- package/docs/@kayelaa/namespaces/LEA/functions/getAvoidAngle.md +0 -25
- package/docs/@kayelaa/namespaces/LEA/functions/getEnvironment.md +0 -15
- package/docs/@kayelaa/namespaces/LEA/functions/getNormalizedColor.md +0 -37
- package/docs/@kayelaa/namespaces/LEA/functions/getRayHit.md +0 -39
- package/docs/@kayelaa/namespaces/LEA/functions/isMobile.md +0 -15
- package/docs/@kayelaa/namespaces/LEA/functions/isNote.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/functions/parseFillStyle.md +0 -40
- package/docs/@kayelaa/namespaces/LEA/functions/raycastAvoid.md +0 -39
- package/docs/@kayelaa/namespaces/LEA/functions/scaleCoord.md +0 -39
- package/docs/@kayelaa/namespaces/LEA/functions/setAnimInterval.md +0 -29
- package/docs/@kayelaa/namespaces/LEA/functions/shortUID.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/functions/tinyUID.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/interfaces/RayHit.md +0 -29
- package/docs/@kayelaa/namespaces/LEA/interfaces/RaycastResult.md +0 -45
- package/docs/@kayelaa/namespaces/LEA/interfaces/SFXConfig.md +0 -157
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/README.md +0 -27
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/booleanExport.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/booleanImport.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/createLookup.md +0 -55
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/createLowPrecision.md +0 -49
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/createLowPrecisionRadToDeg.md +0 -49
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/createPercent.md +0 -49
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/createRounder.md +0 -31
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/degToRad.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/lightWeightRounder.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/radToDeg.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/vec2Export.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/functions/vec2Import.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/variables/angleRadToDeg.md +0 -41
- package/docs/@kayelaa/namespaces/LEA/namespaces/LeaSerializers/variables/booleanMap.md +0 -41
- package/docs/@kayelaa/namespaces/LEA/type-aliases/DefaultWSE.md +0 -67
- package/docs/@kayelaa/namespaces/LEA/type-aliases/LeaEntitySerializer.md +0 -17
- package/docs/@kayelaa/namespaces/LEA/type-aliases/LeaEntitySerializerArray.md +0 -17
- package/docs/@kayelaa/namespaces/LEA/type-aliases/LeaEntitySerializerEach.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/type-aliases/Listener.md +0 -31
- package/docs/@kayelaa/namespaces/LEA/type-aliases/NOTE_NAME.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/type-aliases/OrderedLeaEntitySerializer.md +0 -21
- package/docs/@kayelaa/namespaces/LEA/type-aliases/Side.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/ENVIRONMENT.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/LeaUtilsII.md +0 -445
- package/docs/@kayelaa/namespaces/LEA/variables/LiaSFXMap.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/NOTE_NAMES.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/defaultSFXConfig.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/isInitiallyMobile.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/isNode.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/isWeb.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/sfxHit.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/sfxJump.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/sfxLaser.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/sfxUIClick.md +0 -11
- package/docs/@kayelaa/namespaces/LEA/variables/sfxUIHover.md +0 -11
- package/docs/README.md +0 -14
- package/docs/variables/default.md +0 -25
|
@@ -1,391 +0,0 @@
|
|
|
1
|
-
[**@kayelaa/canvas**](../../../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@kayelaa/canvas](../../../../../../README.md) / [Kayla](../../../README.md) / [KaylaInternals](../README.md) / KaylaGame
|
|
6
|
-
|
|
7
|
-
# Class: KaylaGame
|
|
8
|
-
|
|
9
|
-
Defined in: [kayla-internals.ts:214](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L214)
|
|
10
|
-
|
|
11
|
-
Game instance that coordinates scenes, renderers, and the shared ticker.
|
|
12
|
-
|
|
13
|
-
## Extends
|
|
14
|
-
|
|
15
|
-
- [`LeaGameII`](../../../../LEA/classes/LeaGameII.md)
|
|
16
|
-
|
|
17
|
-
## Extended by
|
|
18
|
-
|
|
19
|
-
- [`KaylaGame`](../../../interfaces/KaylaGame.md)
|
|
20
|
-
|
|
21
|
-
## Constructors
|
|
22
|
-
|
|
23
|
-
### Constructor
|
|
24
|
-
|
|
25
|
-
> **new KaylaGame**(`width`, `height`, `hz`): `KaylaGame`
|
|
26
|
-
|
|
27
|
-
Defined in: [kayla-internals.ts:217](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L217)
|
|
28
|
-
|
|
29
|
-
#### Parameters
|
|
30
|
-
|
|
31
|
-
##### width
|
|
32
|
-
|
|
33
|
-
`number`
|
|
34
|
-
|
|
35
|
-
##### height
|
|
36
|
-
|
|
37
|
-
`number`
|
|
38
|
-
|
|
39
|
-
##### hz
|
|
40
|
-
|
|
41
|
-
`number`
|
|
42
|
-
|
|
43
|
-
#### Returns
|
|
44
|
-
|
|
45
|
-
`KaylaGame`
|
|
46
|
-
|
|
47
|
-
#### Overrides
|
|
48
|
-
|
|
49
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`constructor`](../../../../LEA/classes/LeaGameII.md#constructor)
|
|
50
|
-
|
|
51
|
-
## Properties
|
|
52
|
-
|
|
53
|
-
### scenes
|
|
54
|
-
|
|
55
|
-
> **scenes**: `Map`\<`string`, [`LeaSceneII`](../../../../LEA/classes/LeaSceneII.md)\>
|
|
56
|
-
|
|
57
|
-
Defined in: [lea.ts:1024](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1024)
|
|
58
|
-
|
|
59
|
-
Map of scenes by name.
|
|
60
|
-
|
|
61
|
-
#### Inherited from
|
|
62
|
-
|
|
63
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`scenes`](../../../../LEA/classes/LeaGameII.md#scenes)
|
|
64
|
-
|
|
65
|
-
***
|
|
66
|
-
|
|
67
|
-
### ticker
|
|
68
|
-
|
|
69
|
-
> **ticker**: [`LeaTickerII`](../../../../LEA/classes/LeaTickerII.md)
|
|
70
|
-
|
|
71
|
-
Defined in: [lea.ts:1028](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1028)
|
|
72
|
-
|
|
73
|
-
The shared ticker driving updates.
|
|
74
|
-
|
|
75
|
-
#### Inherited from
|
|
76
|
-
|
|
77
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`ticker`](../../../../LEA/classes/LeaGameII.md#ticker)
|
|
78
|
-
|
|
79
|
-
***
|
|
80
|
-
|
|
81
|
-
### width
|
|
82
|
-
|
|
83
|
-
> **width**: `number`
|
|
84
|
-
|
|
85
|
-
Defined in: [lea.ts:1058](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1058)
|
|
86
|
-
|
|
87
|
-
Logical viewport width.
|
|
88
|
-
|
|
89
|
-
#### Inherited from
|
|
90
|
-
|
|
91
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`width`](../../../../LEA/classes/LeaGameII.md#width)
|
|
92
|
-
|
|
93
|
-
***
|
|
94
|
-
|
|
95
|
-
### height
|
|
96
|
-
|
|
97
|
-
> **height**: `number`
|
|
98
|
-
|
|
99
|
-
Defined in: [lea.ts:1063](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1063)
|
|
100
|
-
|
|
101
|
-
Logical viewport height.
|
|
102
|
-
|
|
103
|
-
#### Inherited from
|
|
104
|
-
|
|
105
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`height`](../../../../LEA/classes/LeaGameII.md#height)
|
|
106
|
-
|
|
107
|
-
## Accessors
|
|
108
|
-
|
|
109
|
-
### started
|
|
110
|
-
|
|
111
|
-
#### Get Signature
|
|
112
|
-
|
|
113
|
-
> **get** **started**(): `boolean`
|
|
114
|
-
|
|
115
|
-
Defined in: [kayla-internals.ts:226](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L226)
|
|
116
|
-
|
|
117
|
-
Whether the game has been started.
|
|
118
|
-
|
|
119
|
-
##### Returns
|
|
120
|
-
|
|
121
|
-
`boolean`
|
|
122
|
-
|
|
123
|
-
***
|
|
124
|
-
|
|
125
|
-
### centerX
|
|
126
|
-
|
|
127
|
-
#### Get Signature
|
|
128
|
-
|
|
129
|
-
> **get** **centerX**(): `number`
|
|
130
|
-
|
|
131
|
-
Defined in: [lea.ts:1033](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1033)
|
|
132
|
-
|
|
133
|
-
Center X of the viewport (width / 2).
|
|
134
|
-
|
|
135
|
-
##### Returns
|
|
136
|
-
|
|
137
|
-
`number`
|
|
138
|
-
|
|
139
|
-
#### Inherited from
|
|
140
|
-
|
|
141
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`centerX`](../../../../LEA/classes/LeaGameII.md#centerx)
|
|
142
|
-
|
|
143
|
-
***
|
|
144
|
-
|
|
145
|
-
### centerY
|
|
146
|
-
|
|
147
|
-
#### Get Signature
|
|
148
|
-
|
|
149
|
-
> **get** **centerY**(): `number`
|
|
150
|
-
|
|
151
|
-
Defined in: [lea.ts:1039](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1039)
|
|
152
|
-
|
|
153
|
-
Center Y of the viewport (height / 2).
|
|
154
|
-
|
|
155
|
-
##### Returns
|
|
156
|
-
|
|
157
|
-
`number`
|
|
158
|
-
|
|
159
|
-
#### Inherited from
|
|
160
|
-
|
|
161
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`centerY`](../../../../LEA/classes/LeaGameII.md#centery)
|
|
162
|
-
|
|
163
|
-
***
|
|
164
|
-
|
|
165
|
-
### left
|
|
166
|
-
|
|
167
|
-
#### Get Signature
|
|
168
|
-
|
|
169
|
-
> **get** **left**(): `number`
|
|
170
|
-
|
|
171
|
-
Defined in: [lea.ts:1042](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1042)
|
|
172
|
-
|
|
173
|
-
##### Returns
|
|
174
|
-
|
|
175
|
-
`number`
|
|
176
|
-
|
|
177
|
-
#### Inherited from
|
|
178
|
-
|
|
179
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`left`](../../../../LEA/classes/LeaGameII.md#left)
|
|
180
|
-
|
|
181
|
-
***
|
|
182
|
-
|
|
183
|
-
### top
|
|
184
|
-
|
|
185
|
-
#### Get Signature
|
|
186
|
-
|
|
187
|
-
> **get** **top**(): `number`
|
|
188
|
-
|
|
189
|
-
Defined in: [lea.ts:1045](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1045)
|
|
190
|
-
|
|
191
|
-
##### Returns
|
|
192
|
-
|
|
193
|
-
`number`
|
|
194
|
-
|
|
195
|
-
#### Inherited from
|
|
196
|
-
|
|
197
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`top`](../../../../LEA/classes/LeaGameII.md#top)
|
|
198
|
-
|
|
199
|
-
***
|
|
200
|
-
|
|
201
|
-
### right
|
|
202
|
-
|
|
203
|
-
#### Get Signature
|
|
204
|
-
|
|
205
|
-
> **get** **right**(): `number`
|
|
206
|
-
|
|
207
|
-
Defined in: [lea.ts:1048](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1048)
|
|
208
|
-
|
|
209
|
-
##### Returns
|
|
210
|
-
|
|
211
|
-
`number`
|
|
212
|
-
|
|
213
|
-
#### Inherited from
|
|
214
|
-
|
|
215
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`right`](../../../../LEA/classes/LeaGameII.md#right)
|
|
216
|
-
|
|
217
|
-
***
|
|
218
|
-
|
|
219
|
-
### bottom
|
|
220
|
-
|
|
221
|
-
#### Get Signature
|
|
222
|
-
|
|
223
|
-
> **get** **bottom**(): `number`
|
|
224
|
-
|
|
225
|
-
Defined in: [lea.ts:1051](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1051)
|
|
226
|
-
|
|
227
|
-
##### Returns
|
|
228
|
-
|
|
229
|
-
`number`
|
|
230
|
-
|
|
231
|
-
#### Inherited from
|
|
232
|
-
|
|
233
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`bottom`](../../../../LEA/classes/LeaGameII.md#bottom)
|
|
234
|
-
|
|
235
|
-
## Methods
|
|
236
|
-
|
|
237
|
-
### start()
|
|
238
|
-
|
|
239
|
-
> **start**(): `void`
|
|
240
|
-
|
|
241
|
-
Defined in: [kayla-internals.ts:233](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L233)
|
|
242
|
-
|
|
243
|
-
Starts the game: starts all attached renderers and the ticker.
|
|
244
|
-
|
|
245
|
-
#### Returns
|
|
246
|
-
|
|
247
|
-
`void`
|
|
248
|
-
|
|
249
|
-
#### Overrides
|
|
250
|
-
|
|
251
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`start`](../../../../LEA/classes/LeaGameII.md#start)
|
|
252
|
-
|
|
253
|
-
***
|
|
254
|
-
|
|
255
|
-
### stop()
|
|
256
|
-
|
|
257
|
-
> **stop**(): `void`
|
|
258
|
-
|
|
259
|
-
Defined in: [kayla-internals.ts:245](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L245)
|
|
260
|
-
|
|
261
|
-
Stops the game: stops all attached renderers and the ticker.
|
|
262
|
-
|
|
263
|
-
#### Returns
|
|
264
|
-
|
|
265
|
-
`void`
|
|
266
|
-
|
|
267
|
-
#### Overrides
|
|
268
|
-
|
|
269
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`stop`](../../../../LEA/classes/LeaGameII.md#stop)
|
|
270
|
-
|
|
271
|
-
***
|
|
272
|
-
|
|
273
|
-
### addRenderer()
|
|
274
|
-
|
|
275
|
-
> **addRenderer**(`renderer`): `void`
|
|
276
|
-
|
|
277
|
-
Defined in: [kayla-internals.ts:261](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L261)
|
|
278
|
-
|
|
279
|
-
Attaches a renderer to the game.
|
|
280
|
-
|
|
281
|
-
If the game is already started, the renderer is started immediately.
|
|
282
|
-
|
|
283
|
-
#### Parameters
|
|
284
|
-
|
|
285
|
-
##### renderer
|
|
286
|
-
|
|
287
|
-
[`KaylaRenderer`](KaylaRenderer.md)
|
|
288
|
-
|
|
289
|
-
The renderer to attach
|
|
290
|
-
|
|
291
|
-
#### Returns
|
|
292
|
-
|
|
293
|
-
`void`
|
|
294
|
-
|
|
295
|
-
***
|
|
296
|
-
|
|
297
|
-
### deleteRenderer()
|
|
298
|
-
|
|
299
|
-
> **deleteRenderer**(`renderer`): `void`
|
|
300
|
-
|
|
301
|
-
Defined in: [kayla-internals.ts:277](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L277)
|
|
302
|
-
|
|
303
|
-
Detaches a renderer from the game.
|
|
304
|
-
|
|
305
|
-
If the game is running, the renderer is stopped.
|
|
306
|
-
|
|
307
|
-
#### Parameters
|
|
308
|
-
|
|
309
|
-
##### renderer
|
|
310
|
-
|
|
311
|
-
[`KaylaRenderer`](KaylaRenderer.md)
|
|
312
|
-
|
|
313
|
-
The renderer to detach
|
|
314
|
-
|
|
315
|
-
#### Returns
|
|
316
|
-
|
|
317
|
-
`void`
|
|
318
|
-
|
|
319
|
-
***
|
|
320
|
-
|
|
321
|
-
### addScene()
|
|
322
|
-
|
|
323
|
-
> **addScene**(`scene`): `void`
|
|
324
|
-
|
|
325
|
-
Defined in: [lea.ts:1091](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1091)
|
|
326
|
-
|
|
327
|
-
Adds a scene to the game.
|
|
328
|
-
|
|
329
|
-
#### Parameters
|
|
330
|
-
|
|
331
|
-
##### scene
|
|
332
|
-
|
|
333
|
-
[`LeaSceneII`](../../../../LEA/classes/LeaSceneII.md)
|
|
334
|
-
|
|
335
|
-
The scene to add
|
|
336
|
-
|
|
337
|
-
#### Returns
|
|
338
|
-
|
|
339
|
-
`void`
|
|
340
|
-
|
|
341
|
-
#### Throws
|
|
342
|
-
|
|
343
|
-
If the scene has no name
|
|
344
|
-
|
|
345
|
-
#### Inherited from
|
|
346
|
-
|
|
347
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`addScene`](../../../../LEA/classes/LeaGameII.md#addscene)
|
|
348
|
-
|
|
349
|
-
***
|
|
350
|
-
|
|
351
|
-
### removeScene()
|
|
352
|
-
|
|
353
|
-
> **removeScene**(`scene`): `void`
|
|
354
|
-
|
|
355
|
-
Defined in: [lea.ts:1102](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1102)
|
|
356
|
-
|
|
357
|
-
Removes a scene from the game.
|
|
358
|
-
|
|
359
|
-
#### Parameters
|
|
360
|
-
|
|
361
|
-
##### scene
|
|
362
|
-
|
|
363
|
-
[`LeaSceneII`](../../../../LEA/classes/LeaSceneII.md)
|
|
364
|
-
|
|
365
|
-
The scene to remove
|
|
366
|
-
|
|
367
|
-
#### Returns
|
|
368
|
-
|
|
369
|
-
`void`
|
|
370
|
-
|
|
371
|
-
#### Inherited from
|
|
372
|
-
|
|
373
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`removeScene`](../../../../LEA/classes/LeaGameII.md#removescene)
|
|
374
|
-
|
|
375
|
-
***
|
|
376
|
-
|
|
377
|
-
### now()
|
|
378
|
-
|
|
379
|
-
> **now**(): `number`
|
|
380
|
-
|
|
381
|
-
Defined in: [lea.ts:1110](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/lea.ts#L1110)
|
|
382
|
-
|
|
383
|
-
Current time in milliseconds (from ticker).
|
|
384
|
-
|
|
385
|
-
#### Returns
|
|
386
|
-
|
|
387
|
-
`number`
|
|
388
|
-
|
|
389
|
-
#### Inherited from
|
|
390
|
-
|
|
391
|
-
[`LeaGameII`](../../../../LEA/classes/LeaGameII.md).[`now`](../../../../LEA/classes/LeaGameII.md#now)
|
package/docs/@kayelaa/namespaces/Kayla/namespaces/KaylaInternals/classes/KaylaInternalRef.md
DELETED
|
@@ -1,94 +0,0 @@
|
|
|
1
|
-
[**@kayelaa/canvas**](../../../../../../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@kayelaa/canvas](../../../../../../README.md) / [Kayla](../../../README.md) / [KaylaInternals](../README.md) / KaylaInternalRef
|
|
6
|
-
|
|
7
|
-
# Class: KaylaInternalRef\<T\>
|
|
8
|
-
|
|
9
|
-
Defined in: [kayla-internals.ts:793](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L793)
|
|
10
|
-
|
|
11
|
-
Mutable reference object whose `.current` property persists across component refreshes.
|
|
12
|
-
|
|
13
|
-
Returned by `useRef` and `useSelf`. Changes to `.current` **never** trigger refresh,
|
|
14
|
-
making it safe for hot mutable data (position, velocity, timers, DOM nodes, etc.).
|
|
15
|
-
|
|
16
|
-
## Type Parameters
|
|
17
|
-
|
|
18
|
-
### T
|
|
19
|
-
|
|
20
|
-
`T`
|
|
21
|
-
|
|
22
|
-
Type of the referenced value
|
|
23
|
-
|
|
24
|
-
## Implements
|
|
25
|
-
|
|
26
|
-
- [`KaylaInternalRefIm`](../interfaces/KaylaInternalRefIm.md)\<`T`\>
|
|
27
|
-
|
|
28
|
-
## Constructors
|
|
29
|
-
|
|
30
|
-
### Constructor
|
|
31
|
-
|
|
32
|
-
> **new KaylaInternalRef**\<`T`\>(`initialValue?`): `KaylaInternalRef`\<`T`\>
|
|
33
|
-
|
|
34
|
-
Defined in: [kayla-internals.ts:795](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L795)
|
|
35
|
-
|
|
36
|
-
#### Parameters
|
|
37
|
-
|
|
38
|
-
##### initialValue?
|
|
39
|
-
|
|
40
|
-
`T`
|
|
41
|
-
|
|
42
|
-
#### Returns
|
|
43
|
-
|
|
44
|
-
`KaylaInternalRef`\<`T`\>
|
|
45
|
-
|
|
46
|
-
## Accessors
|
|
47
|
-
|
|
48
|
-
### current
|
|
49
|
-
|
|
50
|
-
#### Get Signature
|
|
51
|
-
|
|
52
|
-
> **get** **current**(): `T`
|
|
53
|
-
|
|
54
|
-
Defined in: [kayla-internals.ts:805](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L805)
|
|
55
|
-
|
|
56
|
-
The mutable value held by the ref.
|
|
57
|
-
|
|
58
|
-
Reading or writing this property has **no side effects** — it does **not** trigger
|
|
59
|
-
component refresh, re-render, or hook re-registration.
|
|
60
|
-
|
|
61
|
-
When initialized with the `self` symbol via `useRef(self)`, this becomes a reference
|
|
62
|
-
to the underlying `KaylaRectEntity`.
|
|
63
|
-
|
|
64
|
-
##### Returns
|
|
65
|
-
|
|
66
|
-
`T`
|
|
67
|
-
|
|
68
|
-
#### Set Signature
|
|
69
|
-
|
|
70
|
-
> **set** **current**(`s`): `void`
|
|
71
|
-
|
|
72
|
-
Defined in: [kayla-internals.ts:809](https://github.com/lianecagara/kaye-tanks-v2/blob/4a28d0500ea6e343627b34fac908efa8113674cc/kayla/src/kayla-internals.ts#L809)
|
|
73
|
-
|
|
74
|
-
The mutable value held by the ref.
|
|
75
|
-
|
|
76
|
-
Reading or writing this property has **no side effects** — it does **not** trigger
|
|
77
|
-
component refresh, re-render, or hook re-registration.
|
|
78
|
-
|
|
79
|
-
When initialized with the `self` symbol via `useRef(self)`, this becomes a reference
|
|
80
|
-
to the underlying `KaylaRectEntity`.
|
|
81
|
-
|
|
82
|
-
##### Parameters
|
|
83
|
-
|
|
84
|
-
###### s
|
|
85
|
-
|
|
86
|
-
`T`
|
|
87
|
-
|
|
88
|
-
##### Returns
|
|
89
|
-
|
|
90
|
-
`void`
|
|
91
|
-
|
|
92
|
-
#### Implementation of
|
|
93
|
-
|
|
94
|
-
[`KaylaInternalRefIm`](../interfaces/KaylaInternalRefIm.md).[`current`](../interfaces/KaylaInternalRefIm.md#current)
|