Skip to content

Commit d28f96a

Browse files
author
github-actions[bot]
committed
chore(engine): updating docs
1 parent 14b764d commit d28f96a

46 files changed

Lines changed: 637 additions & 638 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### AssetManagerLibrary
66

7-
Defined in: [asset-manager.library.ts:8](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/asset-manager/src/asset-manager.library.ts#L8)
7+
Defined in: [asset-manager.library.ts:8](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/asset-manager/src/asset-manager.library.ts#L8)
88

99
#### Extends
1010

@@ -38,7 +38,7 @@ BaseAssetManagerLibrary.constructor
3838
get __name(): string;
3939
```
4040

41-
Defined in: [asset-manager.library.ts:11](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/asset-manager/src/asset-manager.library.ts#L11)
41+
Defined in: [asset-manager.library.ts:11](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/asset-manager/src/asset-manager.library.ts#L11)
4242

4343
###### Returns
4444

@@ -52,7 +52,7 @@ Defined in: [asset-manager.library.ts:11](https://github.com/NanoForge-dev/Engin
5252
__init(context): Promise<void>;
5353
```
5454

55-
Defined in: [asset-manager.library.ts:15](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/asset-manager/src/asset-manager.library.ts#L15)
55+
Defined in: [asset-manager.library.ts:15](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/asset-manager/src/asset-manager.library.ts#L15)
5656

5757
###### Parameters
5858

@@ -70,7 +70,7 @@ Defined in: [asset-manager.library.ts:15](https://github.com/NanoForge-dev/Engin
7070
getAsset(path): NfFile;
7171
```
7272

73-
Defined in: [asset-manager.library.ts:19](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/asset-manager/src/asset-manager.library.ts#L19)
73+
Defined in: [asset-manager.library.ts:19](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/asset-manager/src/asset-manager.library.ts#L19)
7474

7575
###### Parameters
7676

File renamed without changes.
Lines changed: 231 additions & 231 deletions
Large diffs are not rendered by default.
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ If given value is not a string, then it returns false.
221221
function Default(defaultValue): PropertyDecorator;
222222
```
223223

224-
Defined in: [packages/config/src/default.ts:4](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/config/src/default.ts#L4)
224+
Defined in: [packages/config/src/default.ts:4](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/config/src/default.ts#L4)
225225

226226
#### Parameters
227227

@@ -1254,7 +1254,7 @@ If given value is not a string, then it returns false.
12541254
function IsIpOrFQDN(validationOptions?): (object, propertyName) => void;
12551255
```
12561256

1257-
Defined in: [packages/config/src/validators/is-ip-or-fqdn.validator.ts:3](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/config/src/validators/is-ip-or-fqdn.validator.ts#L3)
1257+
Defined in: [packages/config/src/validators/is-ip-or-fqdn.validator.ts:3](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/config/src/validators/is-ip-or-fqdn.validator.ts#L3)
12581258

12591259
#### Parameters
12601260

File renamed without changes.
Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### NanoforgeClient
66

7-
Defined in: [nanoforge-client.ts:9](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-client.ts#L9)
7+
Defined in: [nanoforge-client.ts:9](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-client.ts#L9)
88

99
#### Extends
1010

@@ -18,7 +18,7 @@ Defined in: [nanoforge-client.ts:9](https://github.com/NanoForge-dev/Engine/blob
1818
protected applicationConfig: ApplicationConfig;
1919
```
2020

21-
Defined in: [nanoforge-application.ts:16](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L16)
21+
Defined in: [nanoforge-application.ts:16](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L16)
2222

2323
###### Inherited from
2424

@@ -34,7 +34,7 @@ NanoforgeApplication.applicationConfig
3434
init(options): Promise<void>;
3535
```
3636

37-
Defined in: [nanoforge-application.ts:46](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L46)
37+
Defined in: [nanoforge-application.ts:46](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L46)
3838

3939
###### Parameters
4040

@@ -58,7 +58,7 @@ NanoforgeApplication.init
5858
run(): Promise<void>;
5959
```
6060

61-
Defined in: [nanoforge-application.ts:54](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L54)
61+
Defined in: [nanoforge-application.ts:54](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L54)
6262

6363
###### Returns
6464

@@ -76,7 +76,7 @@ NanoforgeApplication.run
7676
use(sym, library): void;
7777
```
7878

79-
Defined in: [nanoforge-application.ts:30](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L30)
79+
Defined in: [nanoforge-application.ts:30](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L30)
8080

8181
###### Parameters
8282

@@ -104,7 +104,7 @@ NanoforgeApplication.use
104104
useAssetManager(library): void;
105105
```
106106

107-
Defined in: [nanoforge-application.ts:42](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L42)
107+
Defined in: [nanoforge-application.ts:42](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L42)
108108

109109
###### Parameters
110110

@@ -128,7 +128,7 @@ NanoforgeApplication.useAssetManager
128128
useComponentSystem(library): void;
129129
```
130130

131-
Defined in: [nanoforge-application.ts:34](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L34)
131+
Defined in: [nanoforge-application.ts:34](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L34)
132132

133133
###### Parameters
134134

@@ -152,7 +152,7 @@ NanoforgeApplication.useComponentSystem
152152
useGraphics(library): void;
153153
```
154154

155-
Defined in: [nanoforge-client.ts:10](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-client.ts#L10)
155+
Defined in: [nanoforge-client.ts:10](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-client.ts#L10)
156156

157157
###### Parameters
158158

@@ -170,7 +170,7 @@ Defined in: [nanoforge-client.ts:10](https://github.com/NanoForge-dev/Engine/blo
170170
useInput(library): void;
171171
```
172172

173-
Defined in: [nanoforge-client.ts:14](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-client.ts#L14)
173+
Defined in: [nanoforge-client.ts:14](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-client.ts#L14)
174174

175175
###### Parameters
176176

@@ -188,7 +188,7 @@ Defined in: [nanoforge-client.ts:14](https://github.com/NanoForge-dev/Engine/blo
188188
useNetwork(library): void;
189189
```
190190

191-
Defined in: [nanoforge-application.ts:38](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L38)
191+
Defined in: [nanoforge-application.ts:38](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L38)
192192

193193
###### Parameters
194194

@@ -212,7 +212,7 @@ NanoforgeApplication.useNetwork
212212
useSound(library): void;
213213
```
214214

215-
Defined in: [nanoforge-client.ts:18](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-client.ts#L18)
215+
Defined in: [nanoforge-client.ts:18](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-client.ts#L18)
216216

217217
###### Parameters
218218

@@ -228,7 +228,7 @@ Defined in: [nanoforge-client.ts:18](https://github.com/NanoForge-dev/Engine/blo
228228

229229
### NanoforgeServer
230230

231-
Defined in: [nanoforge-server.ts:3](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-server.ts#L3)
231+
Defined in: [nanoforge-server.ts:3](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-server.ts#L3)
232232

233233
#### Extends
234234

@@ -242,7 +242,7 @@ Defined in: [nanoforge-server.ts:3](https://github.com/NanoForge-dev/Engine/blob
242242
protected applicationConfig: ApplicationConfig;
243243
```
244244

245-
Defined in: [nanoforge-application.ts:16](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L16)
245+
Defined in: [nanoforge-application.ts:16](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L16)
246246

247247
###### Inherited from
248248

@@ -258,7 +258,7 @@ NanoforgeApplication.applicationConfig
258258
init(options): Promise<void>;
259259
```
260260

261-
Defined in: [nanoforge-application.ts:46](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L46)
261+
Defined in: [nanoforge-application.ts:46](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L46)
262262

263263
###### Parameters
264264

@@ -282,7 +282,7 @@ NanoforgeApplication.init
282282
run(): Promise<void>;
283283
```
284284

285-
Defined in: [nanoforge-application.ts:54](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L54)
285+
Defined in: [nanoforge-application.ts:54](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L54)
286286

287287
###### Returns
288288

@@ -300,7 +300,7 @@ NanoforgeApplication.run
300300
use(sym, library): void;
301301
```
302302

303-
Defined in: [nanoforge-application.ts:30](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L30)
303+
Defined in: [nanoforge-application.ts:30](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L30)
304304

305305
###### Parameters
306306

@@ -328,7 +328,7 @@ NanoforgeApplication.use
328328
useAssetManager(library): void;
329329
```
330330

331-
Defined in: [nanoforge-application.ts:42](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L42)
331+
Defined in: [nanoforge-application.ts:42](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L42)
332332

333333
###### Parameters
334334

@@ -352,7 +352,7 @@ NanoforgeApplication.useAssetManager
352352
useComponentSystem(library): void;
353353
```
354354

355-
Defined in: [nanoforge-application.ts:34](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L34)
355+
Defined in: [nanoforge-application.ts:34](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L34)
356356

357357
###### Parameters
358358

@@ -376,7 +376,7 @@ NanoforgeApplication.useComponentSystem
376376
useNetwork(library): void;
377377
```
378378

379-
Defined in: [nanoforge-application.ts:38](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-application.ts#L38)
379+
Defined in: [nanoforge-application.ts:38](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-application.ts#L38)
380380

381381
###### Parameters
382382

@@ -402,4 +402,4 @@ NanoforgeApplication.useNetwork
402402
const NanoforgeFactory: NanoforgeFactoryStatic;
403403
```
404404

405-
Defined in: [nanoforge-factory.ts:15](https://github.com/NanoForge-dev/Engine/blob/d82cfcce288e03364bbf74b28cae1eb757a148cf/packages/core/src/application/nanoforge-factory.ts#L15)
405+
Defined in: [nanoforge-factory.ts:15](https://github.com/NanoForge-dev/Engine/blob/33f373db14dfd95dd6b0a1b04b8cbf8660079d3b/packages/core/src/application/nanoforge-factory.ts#L15)
File renamed without changes.

engine/docs/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.
File renamed without changes.

0 commit comments

Comments
 (0)