From a9add10f30045d0ba3326a187bc959a9cb64af6f Mon Sep 17 00:00:00 2001 From: Exelo Date: Sat, 7 Nov 2026 00:39:37 +0100 Subject: [PATCH 01/11] docs: write docs.json by hand with a $ref to each repository's navigation --- .prettierignore | 4 + docs.json | 2903 ++--------------- docs/cli/commands/1-overview.mdx | 51 - docs/cli/commands/2-commands/1-new.mdx | 54 - docs/cli/commands/2-commands/2-dev.mdx | 30 - docs/cli/commands/2-commands/3-build.mdx | 45 - docs/cli/commands/2-commands/4-start.mdx | 51 - docs/cli/commands/2-commands/5-create.mdx | 42 - docs/cli/commands/2-commands/6-install.mdx | 46 - docs/cli/commands/2-commands/7-editor.mdx | 39 - docs/cli/commands/2-commands/7-install.mdx | 46 - docs/cli/commands/2-commands/8-editor.mdx | 39 - docs/cli/commands/2-commands/8-registry.mdx | 65 - docs/cli/commands/2-commands/9-registry.mdx | 65 - .../configuration/1-configuration-file.mdx | 140 - .../configuration/2-environment-variables.mdx | 35 - docs/cli/getting-started/1-introduction.mdx | 40 - docs/cli/getting-started/2-installation.mdx | 40 - docs/cli/getting-started/3-quickstart.mdx | 63 - docs/cli/getting-started/index.mdx | 15 - docs/cli/getting-started/usage.mdx | 179 - docs/cli/loader/1-overview.mdx | 57 - docs/cli/loader/2-client.mdx | 82 - docs/cli/loader/3-website.mdx | 64 - docs/cli/loader/4-server.mdx | 93 - docs/cli/schematics/1-overview.mdx | 52 - .../schematics/2-schematics/1-application.mdx | 80 - .../schematics/2-schematics/1-workspace.mdx | 69 - .../2-schematics/2-configuration.mdx | 50 - .../cli/schematics/2-schematics/2-project.mdx | 100 - .../schematics/2-schematics/3-component.mdx | 120 - .../schematics/2-schematics/3-part-base.mdx | 115 - .../schematics/2-schematics/4-part-main.mdx | 77 - docs/cli/schematics/2-schematics/4-system.mdx | 105 - docs/cli/schematics/2-schematics/5-docker.mdx | 70 - .../schematics/2-schematics/6-component.mdx | 120 - docs/cli/schematics/2-schematics/7-system.mdx | 105 - docs/engine/getting-started/1-index.mdx | 19 - docs/engine/getting-started/documentation.mdx | 11 - docs/engine/getting-started/how_to_use.mdx | 17 - docs/engine/network/index.mdx | 23 - docs/engine/network/network-client-api.mdx | 63 - docs/engine/network/network-client.mdx | 59 - docs/engine/network/network-server-api.mdx | 83 - docs/engine/network/network-server.mdx | 44 - docs/engine/network/packet-framing.mdx | 34 - docs/engine/registry/index.mdx | 21 - docs/engine/registry/writing_web_assembly.mdx | 21 - guides/cli/cli/1-overview.mdx | 28 - guides/cli/cli/2-create-a-project.mdx | 51 - guides/cli/cli/3-develop-locally.mdx | 34 - guides/cli/cli/4-build-and-deploy.mdx | 54 - guides/cli/cli/5-components-and-systems.mdx | 52 - guides/cli/cli/6-publish-a-package.mdx | 43 - index.mdx | 29 + references/1.3.0/.tsdocs/client/ValidRefs.js | 22 - .../1.3.0/.tsdocs/client/tsdocs-config.js | 28 - .../1.3.0/.tsdocs/client/tsdocs-styles.css | 65 - references/1.3.0/.tsdocs/global.d.ts | 138 - .../1.3.0/asset-manager/asset-manager.mdx | 56 - .../asset-manager/AssetManagerLibrary.mdx | 42 - .../AssetManagerLibrary/__init.mdx | 26 - .../AssetManagerLibrary/__name.mdx | 12 - .../AssetManagerLibrary/getAsset.mdx | 26 - references/1.3.0/asset-manager/index.mdx | 13 - references/1.3.0/common/common.mdx | 56 - .../common/common/ASSET_MANAGER_LIBRARY.mdx | 29 - .../common/common/ApplicationContext.mdx | 57 - .../common/ApplicationContext/_delta.mdx | 12 - .../common/ApplicationContext/delta.mdx | 12 - .../common/ApplicationContext/isRunning.mdx | 12 - .../ApplicationContext/muteSoundLibraries.mdx | 23 - .../ApplicationContext/setIsRunning.mdx | 26 - .../common/common/BaseAssetManagerLibrary.mdx | 39 - .../common/BaseAssetManagerLibrary/__init.mdx | 26 - .../BaseAssetManagerLibrary/getAsset.mdx | 26 - .../common/BaseComponentSystemLibrary.mdx | 34 - .../BaseComponentSystemLibrary/__run.mdx | 26 - .../common/common/BaseGraphicsLibrary.mdx | 34 - .../common/BaseGraphicsLibrary/__run.mdx | 26 - .../1.3.0/common/common/BaseInputLibrary.mdx | 34 - .../common/common/BaseInputLibrary/__run.mdx | 26 - .../1.3.0/common/common/BaseMusicLibrary.mdx | 44 - .../common/common/BaseMusicLibrary/__init.mdx | 26 - .../common/common/BaseMusicLibrary/mute.mdx | 29 - .../common/common/BaseMusicLibrary/play.mdx | 26 - .../common/common/BaseNetworkLibrary.mdx | 31 - .../1.3.0/common/common/BaseSoundLibrary.mdx | 44 - .../common/common/BaseSoundLibrary/__init.mdx | 26 - .../common/common/BaseSoundLibrary/mute.mdx | 29 - .../common/common/BaseSoundLibrary/play.mdx | 26 - .../common/COMPONENT_SYSTEM_LIBRARY.mdx | 29 - .../1.3.0/common/common/ClearContext.mdx | 31 - .../common/common/ClientLibraryManager.mdx | 63 - .../ClientLibraryManager/constructor.mdx | 24 - .../common/ClientLibraryManager/get.mdx | 26 - .../ClientLibraryManager/getAssetManager.mdx | 23 - .../getComponentSystem.mdx | 23 - .../ClientLibraryManager/getGraphics.mdx | 23 - .../common/ClientLibraryManager/getInput.mdx | 23 - .../common/ClientLibraryManager/getMusic.mdx | 23 - .../ClientLibraryManager/getNetwork.mdx | 23 - .../common/ClientLibraryManager/getSound.mdx | 23 - references/1.3.0/common/common/Context.mdx | 45 - .../1.3.0/common/common/Context/app.mdx | 12 - .../common/common/Context/constructor.mdx | 29 - .../1.3.0/common/common/Context/libs.mdx | 12 - .../common/common/DefaultLibrariesEnum.mdx | 21 - .../1.3.0/common/common/ExecutionContext.mdx | 31 - .../1.3.0/common/common/GRAPHICS_LIBRARY.mdx | 29 - .../common/common/IAssetManagerLibrary.mdx | 27 - .../common/IAssetManagerLibrary/getAsset.mdx | 12 - .../common/common/IComponentSystemLibrary.mdx | 27 - .../1.3.0/common/common/IConfigRegistry.mdx | 27 - .../common/IConfigRegistry/registerConfig.mdx | 12 - .../1.3.0/common/common/IExposedLibrary.mdx | 27 - .../1.3.0/common/common/IGraphicsLibrary.mdx | 27 - .../1.3.0/common/common/IInputLibrary.mdx | 27 - references/1.3.0/common/common/ILibrary.mdx | 37 - .../1.3.0/common/common/ILibrary/__clear.mdx | 12 - .../1.3.0/common/common/ILibrary/__init.mdx | 12 - .../1.3.0/common/common/ILibrary/__name.mdx | 12 - .../common/common/ILibrary/__relationship.mdx | 12 - .../1.3.0/common/common/IMusicLibrary.mdx | 27 - .../1.3.0/common/common/IMutableLibrary.mdx | 27 - .../common/common/IMutableLibrary/mute.mdx | 18 - .../1.3.0/common/common/INPUT_LIBRARY.mdx | 29 - .../1.3.0/common/common/INetworkLibrary.mdx | 27 - .../1.3.0/common/common/IRunClientOptions.mdx | 27 - .../common/IRunClientOptions/container.mdx | 12 - .../common/common/IRunClientOptions/env.mdx | 12 - .../common/common/IRunClientOptions/files.mdx | 12 - .../1.3.0/common/common/IRunOptions.mdx | 29 - .../1.3.0/common/common/IRunServerOptions.mdx | 27 - .../common/common/IRunServerOptions/env.mdx | 12 - .../common/common/IRunServerOptions/files.mdx | 12 - .../1.3.0/common/common/IRunnerLibrary.mdx | 27 - .../common/common/IRunnerLibrary/__run.mdx | 12 - .../1.3.0/common/common/ISoundLibrary.mdx | 27 - .../1.3.0/common/common/InitContext.mdx | 59 - .../common/common/InitContext/config.mdx | 12 - .../common/common/InitContext/constructor.mdx | 39 - .../common/common/InitContext/container.mdx | 12 - .../1.3.0/common/common/InitContext/env.mdx | 12 - .../1.3.0/common/common/InitContext/files.mdx | 12 - .../1.3.0/common/common/LibraryContext.mdx | 43 - .../common/common/LibraryContext/_status.mdx | 12 - .../common/common/LibraryContext/status.mdx | 12 - .../1.3.0/common/common/LibraryHandle.mdx | 52 - .../common/LibraryHandle/constructor.mdx | 34 - .../common/common/LibraryHandle/context.mdx | 12 - .../common/common/LibraryHandle/library.mdx | 12 - .../common/common/LibraryHandle/symbol.mdx | 12 - .../1.3.0/common/common/LibraryManager.mdx | 59 - .../common/LibraryManager/constructor.mdx | 21 - .../common/LibraryManager/getAssetManager.mdx | 23 - .../LibraryManager/getComponentSystem.mdx | 23 - .../common/LibraryManager/getGraphics.mdx | 23 - .../common/common/LibraryManager/getInput.mdx | 23 - .../common/common/LibraryManager/getMusic.mdx | 23 - .../common/LibraryManager/getNetwork.mdx | 23 - .../common/common/LibraryManager/getSound.mdx | 23 - .../1.3.0/common/common/LibraryStatusEnum.mdx | 17 - .../1.3.0/common/common/MUSIC_LIBRARY.mdx | 29 - .../1.3.0/common/common/NETWORK_LIBRARY.mdx | 29 - .../1.3.0/common/common/NfConfigException.mdx | 38 - .../common/common/NfConfigException/code.mdx | 12 - .../common/NfConfigException/constructor.mdx | 30 - .../1.3.0/common/common/NfFetchException.mdx | 38 - .../common/common/NfFetchException/code.mdx | 12 - .../common/NfFetchException/constructor.mdx | 29 - references/1.3.0/common/common/NfFile.mdx | 60 - .../common/common/NfFile/arrayBuffer.mdx | 23 - .../1.3.0/common/common/NfFile/blob.mdx | 23 - .../1.3.0/common/common/NfFile/bytes.mdx | 23 - .../common/common/NfFile/constructor.mdx | 24 - .../1.3.0/common/common/NfFile/formData.mdx | 23 - .../1.3.0/common/common/NfFile/json.mdx | 23 - .../1.3.0/common/common/NfFile/path.mdx | 12 - .../1.3.0/common/common/NfFile/text.mdx | 23 - references/1.3.0/common/common/NfNotFound.mdx | 38 - .../1.3.0/common/common/NfNotFound/code.mdx | 12 - .../common/common/NfNotFound/constructor.mdx | 30 - .../common/NfNotInitializedException.mdx | 38 - .../common/NfNotInitializedException/code.mdx | 12 - .../NfNotInitializedException/constructor.mdx | 30 - .../1.3.0/common/common/SOUND_LIBRARY.mdx | 29 - references/1.3.0/common/index.mdx | 13 - references/1.3.0/config/config.mdx | 56 - references/1.3.0/config/config/Default.mdx | 45 - references/1.3.0/config/config/IsIpOrFQDN.mdx | 47 - .../config/config/TransformToBoolean.mdx | 30 - references/1.3.0/config/index.mdx | 13 - references/1.3.0/core-editor/core-editor.mdx | 56 - .../core-editor/NanoforgeClient.mdx | 41 - .../NanoforgeClient/useGraphics.mdx | 26 - .../core-editor/NanoforgeClient/useInput.mdx | 26 - .../core-editor/NanoforgeClient/useSound.mdx | 26 - .../core-editor/NanoforgeFactory.mdx | 29 - .../core-editor/NanoforgeServer.mdx | 31 - references/1.3.0/core-editor/index.mdx | 13 - references/1.3.0/core/core.mdx | 56 - .../1.3.0/core/core/NanoforgeClient.mdx | 41 - .../core/core/NanoforgeClient/useGraphics.mdx | 26 - .../core/core/NanoforgeClient/useInput.mdx | 26 - .../core/core/NanoforgeClient/useSound.mdx | 26 - .../1.3.0/core/core/NanoforgeFactory.mdx | 29 - .../1.3.0/core/core/NanoforgeServer.mdx | 31 - references/1.3.0/core/index.mdx | 13 - references/1.3.0/ecs-client/ecs-client.mdx | 56 - .../ecs-client/ECSClientLibrary.mdx | 40 - .../ecs-client/ECSClientLibrary/__init.mdx | 26 - .../ecs-client/ECSClientLibrary/__name.mdx | 12 - .../ECSClientLibrary/constructor.mdx | 21 - references/1.3.0/ecs-client/index.mdx | 13 - references/1.3.0/ecs-lib/ecs-lib.mdx | 56 - .../ecs-lib/ecs-lib/AbstractECSLibrary.mdx | 75 - .../ecs-lib/AbstractECSLibrary/__name.mdx | 12 - .../ecs-lib/AbstractECSLibrary/__run.mdx | 32 - .../ecs-lib/AbstractECSLibrary/_registry.mdx | 12 - .../AbstractECSLibrary/constructor.mdx | 21 - .../ecs-lib/AbstractECSLibrary/module.mdx | 12 - .../ecs-lib/AbstractECSLibrary/path.mdx | 12 - .../ecs-lib/AbstractECSLibrary/registry.mdx | 16 - .../1.3.0/ecs-lib/ecs-lib/Component.mdx | 32 - .../ecs-lib/EditorComponentManifest.mdx | 37 - .../ecs-lib/ecs-lib/EditorSystemManifest.mdx | 37 - references/1.3.0/ecs-lib/ecs-lib/Entity.mdx | 27 - .../1.3.0/ecs-lib/ecs-lib/Entity/getId.mdx | 12 - references/1.3.0/ecs-lib/ecs-lib/Registry.mdx | 27 - .../ecs-lib/ecs-lib/Registry/addComponent.mdx | 12 - .../ecs-lib/ecs-lib/Registry/addSystem.mdx | 12 - .../ecs-lib/Registry/clearEntities.mdx | 12 - .../ecs-lib/ecs-lib/Registry/clearSystems.mdx | 12 - .../ecs-lib/Registry/entityFromIndex.mdx | 12 - .../ecs-lib/Registry/getComponents.mdx | 12 - .../ecs-lib/Registry/getComponentsConst.mdx | 12 - .../ecs-lib/Registry/getEntityComponent.mdx | 12 - .../Registry/getEntityComponentConst.mdx | 12 - .../ecs-lib/ecs-lib/Registry/getZipper.mdx | 12 - .../ecs-lib/ecs-lib/Registry/killEntity.mdx | 12 - .../ecs-lib/ecs-lib/Registry/maxEntities.mdx | 12 - .../ecs-lib/Registry/registerComponent.mdx | 12 - .../ecs-lib/Registry/removeComponent.mdx | 12 - .../ecs-lib/ecs-lib/Registry/removeSystem.mdx | 12 - .../ecs-lib/ecs-lib/Registry/runSystems.mdx | 12 - .../ecs-lib/ecs-lib/Registry/spawnEntity.mdx | 12 - .../1.3.0/ecs-lib/ecs-lib/SparseArray.mdx | 27 - .../ecs-lib/ecs-lib/SparseArray/clear.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/empty.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/erase.mdx | 12 - .../1.3.0/ecs-lib/ecs-lib/SparseArray/get.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/getConst.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/getIndex.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/insertAt.mdx | 12 - .../ecs-lib/SparseArray/insertAt_1.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/resize.mdx | 12 - .../1.3.0/ecs-lib/ecs-lib/SparseArray/set.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/setByCopy.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/setByMove.mdx | 12 - .../ecs-lib/ecs-lib/SparseArray/size.mdx | 12 - references/1.3.0/ecs-lib/ecs-lib/System.mdx | 29 - references/1.3.0/ecs-lib/index.mdx | 13 - references/1.3.0/ecs-server/ecs-server.mdx | 56 - .../ecs-server/ECSServerLibrary.mdx | 40 - .../ecs-server/ECSServerLibrary/__init.mdx | 26 - .../ecs-server/ECSServerLibrary/__name.mdx | 12 - .../ECSServerLibrary/constructor.mdx | 21 - .../1.3.0/ecs-server/ecs-server/Module.mdx | 29 - references/1.3.0/ecs-server/index.mdx | 13 - references/1.3.0/graphics-2d/graphics-2d.mdx | 56 - .../graphics-2d/graphics-2d/Animation_2.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Arc.mdx | 29 - .../graphics-2d/graphics-2d/ArcConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Arrow.mdx | 29 - .../graphics-2d/graphics-2d/ArrowConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Canvas.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Circle.mdx | 29 - .../graphics-2d/graphics-2d/CircleConfig.mdx | 29 - .../graphics-2d/graphics-2d/Container.mdx | 29 - .../graphics-2d/ContainerConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Context.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/DD.mdx | 44 - .../1.3.0/graphics-2d/graphics-2d/Easings.mdx | 46 - .../1.3.0/graphics-2d/graphics-2d/Ellipse.mdx | 29 - .../graphics-2d/graphics-2d/EllipseConfig.mdx | 29 - .../graphics-2d/graphics-2d/FastLayer.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Filters.mdx | 50 - .../graphics-2d/Graphics2DLibrary.mdx | 56 - .../graphics-2d/Graphics2DLibrary/__init.mdx | 26 - .../graphics-2d/Graphics2DLibrary/__name.mdx | 12 - .../graphics-2d/Graphics2DLibrary/__run.mdx | 23 - .../Graphics2DLibrary/baseLayer.mdx | 12 - .../graphics-2d/Graphics2DLibrary/stage.mdx | 12 - .../1.3.0/graphics-2d/graphics-2d/Group.mdx | 29 - .../graphics-2d/graphics-2d/GroupConfig.mdx | 29 - .../graphics-2d/graphics-2d/ImageConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Image_2.mdx | 29 - .../graphics-2d/KonvaEventListener.mdx | 29 - .../graphics-2d/KonvaEventObject.mdx | 29 - .../graphics-2d/KonvaPointerEvent.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Label.mdx | 29 - .../graphics-2d/graphics-2d/LabelConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Layer.mdx | 29 - .../graphics-2d/graphics-2d/LayerConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Line.mdx | 29 - .../graphics-2d/graphics-2d/LineConfig.mdx | 29 - .../graphics-2d/graphics-2d/NodeConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Node_2.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Path.mdx | 29 - .../graphics-2d/graphics-2d/PathConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Rect.mdx | 29 - .../graphics-2d/graphics-2d/RectConfig.mdx | 29 - .../graphics-2d/RegularPolygon.mdx | 29 - .../graphics-2d/RegularPolygonConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Ring.mdx | 29 - .../graphics-2d/graphics-2d/RingConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Shape.mdx | 29 - .../graphics-2d/graphics-2d/ShapeConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Sprite.mdx | 29 - .../graphics-2d/graphics-2d/SpriteConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Stage.mdx | 29 - .../graphics-2d/graphics-2d/StageConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Star.mdx | 29 - .../graphics-2d/graphics-2d/StarConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Tag.mdx | 29 - .../graphics-2d/graphics-2d/TagConfig.mdx | 29 - .../graphics-2d/graphics-2d/TextConfig.mdx | 29 - .../graphics-2d/graphics-2d/TextPath.mdx | 29 - .../graphics-2d/TextPathConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Text_2.mdx | 29 - .../graphics-2d/graphics-2d/Transform.mdx | 29 - .../graphics-2d/TransformerConfig.mdx | 29 - .../graphics-2d/graphics-2d/Transformer_2.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Tween.mdx | 29 - .../graphics-2d/graphics-2d/TweenConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Util.mdx | 130 - .../graphics-2d/graphics-2d/Vector2d.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/Wedge.mdx | 29 - .../graphics-2d/graphics-2d/WedgeConfig.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/_global.mdx | 29 - .../graphics-2d/graphics-2d/_injectGlobal.mdx | 45 - .../graphics-2d/_mouseDblClickPointerId.mdx | 29 - .../graphics-2d/_mouseInDblClickWindow.mdx | 29 - .../graphics-2d/_mouseListenClick.mdx | 29 - .../graphics-2d/_pointerDblClickPointerId.mdx | 29 - .../graphics-2d/_pointerInDblClickWindow.mdx | 29 - .../graphics-2d/_pointerListenClick.mdx | 29 - .../graphics-2d/_renderBackend.mdx | 29 - .../graphics-2d/_touchDblClickPointerId.mdx | 29 - .../graphics-2d/_touchInDblClickWindow.mdx | 29 - .../graphics-2d/_touchListenClick.mdx | 29 - .../graphics-2d/graphics-2d/angleDeg.mdx | 29 - .../graphics-2d/autoDrawEnabled.mdx | 29 - .../capturePointerEventsEnabled.mdx | 29 - .../graphics-2d/dblClickWindow.mdx | 29 - .../graphics-2d/graphics-2d/document_2.mdx | 29 - .../graphics-2d/graphics-2d/dragButtons.mdx | 29 - .../graphics-2d/graphics-2d/dragDistance.mdx | 29 - .../graphics-2d/graphics-2d/enableTrace.mdx | 29 - .../graphics-2d/graphics-2d/getAngle.mdx | 45 - .../graphics-2d/hitOnDragEnabled.mdx | 29 - .../graphics-2d/graphics-2d/isBrowser.mdx | 29 - .../graphics-2d/graphics-2d/isDragReady.mdx | 30 - .../graphics-2d/graphics-2d/isDragging.mdx | 30 - .../graphics-2d/isTransforming.mdx | 30 - .../graphics-2d/graphics-2d/isUnminified.mdx | 29 - .../graphics-2d/legacyTextRendering.mdx | 29 - .../graphics-2d/graphics-2d/pixelRatio.mdx | 29 - .../graphics-2d/pointerEventsEnabled.mdx | 29 - .../graphics-2d/releaseCanvasOnDestroy.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/shapes.mdx | 31 - .../graphics-2d/graphics-2d/showWarnings.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/stages.mdx | 29 - .../1.3.0/graphics-2d/graphics-2d/version.mdx | 29 - references/1.3.0/graphics-2d/index.mdx | 13 - references/1.3.0/input/index.mdx | 13 - references/1.3.0/input/input.mdx | 56 - references/1.3.0/input/input/InputEnum.mdx | 161 - references/1.3.0/input/input/InputLibrary.mdx | 72 - .../1.3.0/input/input/InputLibrary/__init.mdx | 23 - .../1.3.0/input/input/InputLibrary/__name.mdx | 12 - .../1.3.0/input/input/InputLibrary/__run.mdx | 23 - .../input/input/InputLibrary/constructor.mdx | 21 - .../input/input/InputLibrary/getDragState.mdx | 23 - .../input/InputLibrary/getMousePosition.mdx | 33 - .../input/InputLibrary/getMouseState.mdx | 23 - .../input/InputLibrary/getPressedKeys.mdx | 23 - .../input/InputLibrary/getWheelState.mdx | 23 - .../input/input/InputLibrary/isDragging.mdx | 27 - .../input/input/InputLibrary/isKeyPressed.mdx | 26 - references/1.3.0/music/index.mdx | 13 - references/1.3.0/music/music.mdx | 56 - references/1.3.0/music/music/MusicLibrary.mdx | 50 - .../1.3.0/music/music/MusicLibrary/__init.mdx | 23 - .../1.3.0/music/music/MusicLibrary/__name.mdx | 12 - .../1.3.0/music/music/MusicLibrary/load.mdx | 31 - .../1.3.0/music/music/MusicLibrary/mute.mdx | 23 - .../1.3.0/music/music/MusicLibrary/play.mdx | 26 - references/1.3.0/network-client/index.mdx | 13 - .../1.3.0/network-client/network-client.mdx | 56 - .../network-client/NetworkClientLibrary.mdx | 50 - .../NetworkClientLibrary/__init.mdx | 26 - .../NetworkClientLibrary/__name.mdx | 12 - .../NetworkClientLibrary/tcp.mdx | 12 - .../NetworkClientLibrary/udp.mdx | 12 - .../network-client/TCPClient.mdx | 51 - .../network-client/TCPClient/connect.mdx | 29 - .../network-client/TCPClient/constructor.mdx | 39 - .../TCPClient/getReceivedPackets.mdx | 29 - .../network-client/TCPClient/isConnected.mdx | 29 - .../network-client/TCPClient/sendData.mdx | 32 - .../network-client/UDPClient.mdx | 51 - .../network-client/UDPClient/connect.mdx | 29 - .../network-client/UDPClient/constructor.mdx | 39 - .../UDPClient/getReceivedPackets.mdx | 29 - .../network-client/UDPClient/isConnected.mdx | 29 - .../network-client/UDPClient/sendData.mdx | 32 - references/1.3.0/network-server/index.mdx | 13 - .../1.3.0/network-server/network-server.mdx | 56 - .../network-server/NetworkServerLibrary.mdx | 50 - .../NetworkServerLibrary/__init.mdx | 26 - .../NetworkServerLibrary/__name.mdx | 12 - .../NetworkServerLibrary/tcp.mdx | 12 - .../NetworkServerLibrary/udp.mdx | 12 - .../network-server/TCPServer.mdx | 55 - .../network-server/TCPServer/constructor.mdx | 46 - .../TCPServer/getConnectedClients.mdx | 29 - .../TCPServer/getReceivedPackets.mdx | 29 - .../network-server/TCPServer/listen.mdx | 29 - .../network-server/TCPServer/sendToClient.mdx | 37 - .../TCPServer/sendToEverybody.mdx | 32 - .../network-server/UDPServer.mdx | 55 - .../network-server/UDPServer/constructor.mdx | 46 - .../UDPServer/getConnectedClients.mdx | 29 - .../UDPServer/getReceivedPackets.mdx | 29 - .../network-server/UDPServer/listen.mdx | 29 - .../network-server/UDPServer/sendToClient.mdx | 37 - .../UDPServer/sendToEverybody.mdx | 32 - references/1.3.0/sound/index.mdx | 13 - references/1.3.0/sound/sound.mdx | 56 - references/1.3.0/sound/sound/SoundLibrary.mdx | 50 - .../1.3.0/sound/sound/SoundLibrary/__init.mdx | 23 - .../1.3.0/sound/sound/SoundLibrary/__name.mdx | 12 - .../1.3.0/sound/sound/SoundLibrary/load.mdx | 31 - .../1.3.0/sound/sound/SoundLibrary/mute.mdx | 23 - .../1.3.0/sound/sound/SoundLibrary/play.mdx | 26 - references/1.4.0/.tsdocs/client/ValidRefs.js | 29 - .../1.4.0/.tsdocs/client/tsdocs-config.js | 28 - .../1.4.0/.tsdocs/client/tsdocs-styles.css | 65 - references/1.4.0/.tsdocs/global.d.ts | 145 - references/1.4.0/asset-manager/0-index.mdx | 89 - .../asset-manager/AssetManagerLibrary.mdx | 33 - .../AssetManagerLibrary/getAsset.mdx | 36 - .../AssetManagerLibrary/getAsset_1.mdx | 26 - references/1.4.0/common/0-index.mdx | 54 - .../1.4.0/common/ASSET_MANAGER_LIBRARY.mdx | 23 - .../1.4.0/common/ApplicationContext.mdx | 37 - .../1.4.0/common/ApplicationContext/delta.mdx | 14 - .../common/ApplicationContext/isRunning.mdx | 14 - .../1.4.0/common/BaseAssetManagerLibrary.mdx | 35 - .../BaseAssetManagerLibrary/getAsset.mdx | 32 - .../BaseAssetManagerLibrary/getAsset_1.mdx | 26 - .../common/BaseComponentSystemLibrary.mdx | 23 - .../1.4.0/common/BaseGraphicsLibrary.mdx | 23 - references/1.4.0/common/BaseInputLibrary.mdx | 23 - references/1.4.0/common/BaseMusicLibrary.mdx | 35 - .../1.4.0/common/BaseMusicLibrary/mute.mdx | 29 - .../1.4.0/common/BaseMusicLibrary/play.mdx | 32 - .../1.4.0/common/BaseNetworkLibrary.mdx | 23 - references/1.4.0/common/BaseSoundLibrary.mdx | 35 - .../1.4.0/common/BaseSoundLibrary/mute.mdx | 29 - .../1.4.0/common/BaseSoundLibrary/play.mdx | 32 - .../1.4.0/common/COMPONENT_SYSTEM_LIBRARY.mdx | 23 - references/1.4.0/common/ClearContext.mdx | 23 - .../1.4.0/common/ClientLibraryManager.mdx | 63 - .../ClientLibraryManager/constructor.mdx | 26 - .../1.4.0/common/ClientLibraryManager/get.mdx | 32 - .../ClientLibraryManager/getAssetManager.mdx | 29 - .../getComponentSystem.mdx | 29 - .../ClientLibraryManager/getGraphics.mdx | 29 - .../common/ClientLibraryManager/getInput.mdx | 29 - .../common/ClientLibraryManager/getMusic.mdx | 29 - .../ClientLibraryManager/getNetwork.mdx | 29 - .../common/ClientLibraryManager/getSound.mdx | 29 - references/1.4.0/common/Context.mdx | 33 - references/1.4.0/common/Context/app.mdx | 10 - .../1.4.0/common/Context/constructor.mdx | 29 - references/1.4.0/common/Context/libs.mdx | 10 - .../1.4.0/common/DefaultLibrariesEnum.mdx | 29 - references/1.4.0/common/ExecutionContext.mdx | 23 - references/1.4.0/common/GRAPHICS_LIBRARY.mdx | 23 - .../1.4.0/common/IAssetManagerLibrary.mdx | 23 - .../common/IAssetManagerLibrary/getAsset.mdx | 18 - .../IAssetManagerLibrary/getAsset_1.mdx | 12 - .../1.4.0/common/IComponentSystemLibrary.mdx | 23 - references/1.4.0/common/IConfigRegistry.mdx | 31 - .../common/IConfigRegistry/registerConfig.mdx | 18 - references/1.4.0/common/IExposedLibrary.mdx | 23 - references/1.4.0/common/IGraphicsLibrary.mdx | 23 - references/1.4.0/common/IInputLibrary.mdx | 23 - references/1.4.0/common/ILibrary.mdx | 23 - references/1.4.0/common/IMusicLibrary.mdx | 23 - references/1.4.0/common/IMutableLibrary.mdx | 23 - .../1.4.0/common/IMutableLibrary/mute.mdx | 18 - references/1.4.0/common/INPUT_LIBRARY.mdx | 23 - references/1.4.0/common/INetworkLibrary.mdx | 23 - references/1.4.0/common/IRunClientOptions.mdx | 23 - .../common/IRunClientOptions/container.mdx | 22 - .../1.4.0/common/IRunClientOptions/env.mdx | 18 - .../1.4.0/common/IRunClientOptions/files.mdx | 22 - references/1.4.0/common/IRunOptions.mdx | 19 - references/1.4.0/common/IRunServerOptions.mdx | 23 - .../1.4.0/common/IRunServerOptions/env.mdx | 18 - .../1.4.0/common/IRunServerOptions/files.mdx | 22 - references/1.4.0/common/IRunnerLibrary.mdx | 23 - references/1.4.0/common/ISoundLibrary.mdx | 23 - references/1.4.0/common/InitContext.mdx | 55 - .../1.4.0/common/InitContext/config.mdx | 18 - .../1.4.0/common/InitContext/constructor.mdx | 41 - .../1.4.0/common/InitContext/container.mdx | 18 - references/1.4.0/common/InitContext/env.mdx | 14 - references/1.4.0/common/InitContext/files.mdx | 14 - references/1.4.0/common/Library.mdx | 45 - .../1.4.0/common/Library/_relationship.mdx | 10 - .../1.4.0/common/Library/constructor.mdx | 27 - references/1.4.0/common/LibraryContext.mdx | 27 - .../1.4.0/common/LibraryContext/status.mdx | 14 - references/1.4.0/common/LibraryHandle.mdx | 49 - .../common/LibraryHandle/constructor.mdx | 36 - .../1.4.0/common/LibraryHandle/context.mdx | 14 - .../1.4.0/common/LibraryHandle/library.mdx | 14 - .../1.4.0/common/LibraryHandle/symbol.mdx | 14 - references/1.4.0/common/LibraryManager.mdx | 67 - .../common/LibraryManager/constructor.mdx | 19 - .../common/LibraryManager/getAssetManager.mdx | 29 - .../LibraryManager/getComponentSystem.mdx | 29 - .../common/LibraryManager/getGraphics.mdx | 29 - .../1.4.0/common/LibraryManager/getInput.mdx | 29 - .../1.4.0/common/LibraryManager/getMusic.mdx | 29 - .../common/LibraryManager/getNetwork.mdx | 29 - .../1.4.0/common/LibraryManager/getSound.mdx | 29 - references/1.4.0/common/LibraryStatusEnum.mdx | 21 - references/1.4.0/common/MUSIC_LIBRARY.mdx | 23 - references/1.4.0/common/NETWORK_LIBRARY.mdx | 23 - references/1.4.0/common/NfConfigException.mdx | 37 - .../1.4.0/common/NfConfigException/code.mdx | 14 - .../common/NfConfigException/constructor.mdx | 32 - references/1.4.0/common/NfFetchException.mdx | 37 - .../1.4.0/common/NfFetchException/code.mdx | 14 - .../common/NfFetchException/constructor.mdx | 31 - references/1.4.0/common/NfFile.mdx | 71 - .../1.4.0/common/NfFile/arrayBuffer.mdx | 29 - references/1.4.0/common/NfFile/blob.mdx | 29 - references/1.4.0/common/NfFile/bytes.mdx | 29 - .../1.4.0/common/NfFile/constructor.mdx | 26 - references/1.4.0/common/NfFile/formData.mdx | 29 - references/1.4.0/common/NfFile/json.mdx | 29 - references/1.4.0/common/NfFile/path.mdx | 14 - references/1.4.0/common/NfFile/text.mdx | 29 - references/1.4.0/common/NfNotFound.mdx | 41 - references/1.4.0/common/NfNotFound/code.mdx | 14 - .../1.4.0/common/NfNotFound/constructor.mdx | 32 - .../common/NfNotInitializedException.mdx | 37 - .../common/NfNotInitializedException/code.mdx | 14 - .../NfNotInitializedException/constructor.mdx | 32 - references/1.4.0/common/SOUND_LIBRARY.mdx | 23 - references/1.4.0/config/0-index.mdx | 159 - references/1.4.0/config/Default.mdx | 44 - references/1.4.0/config/IsIpOrFQDN.mdx | 45 - .../1.4.0/config/TransformToBoolean.mdx | 41 - references/1.4.0/core-editor/0-index.mdx | 56 - references/1.4.0/core-editor/CoreEvents.mdx | 23 - references/1.4.0/core-editor/EditorEvents.mdx | 15 - references/1.4.0/core-editor/EventEmitter.mdx | 33 - .../core-editor/EventEmitter/constructor.mdx | 24 - .../1.4.0/core-editor/EventEmitter/emit.mdx | 31 - .../1.4.0/core-editor/EventEmitter/on.mdx | 31 - .../core-editor/EventEmitter/runEvents.mdx | 23 - .../1.4.0/core-editor/NanoforgeClient.mdx | 37 - .../NanoforgeClient/useGraphics.mdx | 32 - .../core-editor/NanoforgeClient/useInput.mdx | 32 - .../core-editor/NanoforgeClient/useSound.mdx | 32 - .../1.4.0/core-editor/NanoforgeFactory.mdx | 31 - .../1.4.0/core-editor/NanoforgeServer.mdx | 23 - references/1.4.0/core/0-index.mdx | 71 - references/1.4.0/core/NanoforgeClient.mdx | 45 - .../core/NanoforgeClient/useGraphics.mdx | 32 - .../1.4.0/core/NanoforgeClient/useInput.mdx | 32 - .../1.4.0/core/NanoforgeClient/useSound.mdx | 32 - references/1.4.0/core/NanoforgeFactory.mdx | 31 - references/1.4.0/core/NanoforgeServer.mdx | 31 - references/1.4.0/ecs-client/0-index.mdx | 129 - .../1.4.0/ecs-client/ECSClientLibrary.mdx | 29 - .../ECSClientLibrary/constructor.mdx | 19 - references/1.4.0/ecs-lib/0-index.mdx | 60 - .../1.4.0/ecs-lib/AbstractECSLibrary.mdx | 66 - .../ecs-lib/AbstractECSLibrary/_registry.mdx | 10 - .../AbstractECSLibrary/constructor.mdx | 19 - .../ecs-lib/AbstractECSLibrary/module.mdx | 10 - .../1.4.0/ecs-lib/AbstractECSLibrary/path.mdx | 10 - .../ecs-lib/AbstractECSLibrary/registry.mdx | 18 - references/1.4.0/ecs-lib/Component.mdx | 18 - .../1.4.0/ecs-lib/EditorComponentManifest.mdx | 23 - .../1.4.0/ecs-lib/EditorSystemManifest.mdx | 23 - references/1.4.0/ecs-lib/Entity.mdx | 15 - references/1.4.0/ecs-lib/Entity/getId.mdx | 12 - references/1.4.0/ecs-lib/Registry.mdx | 15 - .../1.4.0/ecs-lib/Registry/addComponent.mdx | 12 - .../1.4.0/ecs-lib/Registry/addSystem.mdx | 12 - .../1.4.0/ecs-lib/Registry/clearEntities.mdx | 12 - .../1.4.0/ecs-lib/Registry/clearSystems.mdx | 12 - .../ecs-lib/Registry/entityFromIndex.mdx | 12 - .../1.4.0/ecs-lib/Registry/getComponents.mdx | 12 - .../ecs-lib/Registry/getComponentsConst.mdx | 12 - .../ecs-lib/Registry/getEntityComponent.mdx | 12 - .../Registry/getEntityComponentConst.mdx | 12 - .../ecs-lib/Registry/getIndexedZipper.mdx | 12 - .../1.4.0/ecs-lib/Registry/getZipper.mdx | 12 - .../1.4.0/ecs-lib/Registry/killEntity.mdx | 12 - .../1.4.0/ecs-lib/Registry/maxEntities.mdx | 12 - .../ecs-lib/Registry/registerComponent.mdx | 12 - .../ecs-lib/Registry/removeComponent.mdx | 12 - .../1.4.0/ecs-lib/Registry/removeSystem.mdx | 12 - .../1.4.0/ecs-lib/Registry/runSystems.mdx | 12 - .../1.4.0/ecs-lib/Registry/spawnEntity.mdx | 12 - references/1.4.0/ecs-lib/SparseArray.mdx | 15 - .../1.4.0/ecs-lib/SparseArray/clear.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/empty.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/erase.mdx | 12 - references/1.4.0/ecs-lib/SparseArray/get.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/getConst.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/getIndex.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/insertAt.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/insertAt_1.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/resize.mdx | 12 - references/1.4.0/ecs-lib/SparseArray/set.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/setByCopy.mdx | 12 - .../1.4.0/ecs-lib/SparseArray/setByMove.mdx | 12 - references/1.4.0/ecs-lib/SparseArray/size.mdx | 12 - references/1.4.0/ecs-lib/System.mdx | 15 - references/1.4.0/ecs-server/0-index.mdx | 129 - .../1.4.0/ecs-server/ECSServerLibrary.mdx | 29 - .../ECSServerLibrary/constructor.mdx | 19 - references/1.4.0/ecs-server/Module.mdx | 15 - references/1.4.0/graphics-2d/0-index.mdx | 114 - references/1.4.0/graphics-2d/Animation_2.mdx | 15 - references/1.4.0/graphics-2d/Arc.mdx | 15 - references/1.4.0/graphics-2d/ArcConfig.mdx | 15 - references/1.4.0/graphics-2d/Arrow.mdx | 15 - references/1.4.0/graphics-2d/ArrowConfig.mdx | 15 - references/1.4.0/graphics-2d/Canvas.mdx | 15 - references/1.4.0/graphics-2d/Circle.mdx | 15 - references/1.4.0/graphics-2d/CircleConfig.mdx | 15 - references/1.4.0/graphics-2d/Container.mdx | 15 - .../1.4.0/graphics-2d/ContainerConfig.mdx | 15 - references/1.4.0/graphics-2d/Context.mdx | 15 - references/1.4.0/graphics-2d/DD.mdx | 30 - references/1.4.0/graphics-2d/Easings.mdx | 32 - references/1.4.0/graphics-2d/Ellipse.mdx | 15 - .../1.4.0/graphics-2d/EllipseConfig.mdx | 15 - references/1.4.0/graphics-2d/FastLayer.mdx | 15 - references/1.4.0/graphics-2d/Filters.mdx | 36 - .../1.4.0/graphics-2d/Graphics2DLibrary.mdx | 37 - .../Graphics2DLibrary/baseLayer.mdx | 18 - .../graphics-2d/Graphics2DLibrary/stage.mdx | 18 - references/1.4.0/graphics-2d/Group.mdx | 15 - references/1.4.0/graphics-2d/GroupConfig.mdx | 15 - references/1.4.0/graphics-2d/ImageConfig.mdx | 15 - references/1.4.0/graphics-2d/Image_2.mdx | 15 - .../1.4.0/graphics-2d/KonvaEventListener.mdx | 15 - .../1.4.0/graphics-2d/KonvaEventObject.mdx | 15 - .../1.4.0/graphics-2d/KonvaPointerEvent.mdx | 15 - references/1.4.0/graphics-2d/Label.mdx | 15 - references/1.4.0/graphics-2d/LabelConfig.mdx | 15 - references/1.4.0/graphics-2d/Layer.mdx | 15 - references/1.4.0/graphics-2d/LayerConfig.mdx | 15 - references/1.4.0/graphics-2d/Line.mdx | 15 - references/1.4.0/graphics-2d/LineConfig.mdx | 15 - references/1.4.0/graphics-2d/NodeConfig.mdx | 15 - references/1.4.0/graphics-2d/Node_2.mdx | 15 - references/1.4.0/graphics-2d/Path.mdx | 15 - references/1.4.0/graphics-2d/PathConfig.mdx | 15 - references/1.4.0/graphics-2d/Rect.mdx | 15 - references/1.4.0/graphics-2d/RectConfig.mdx | 15 - .../1.4.0/graphics-2d/RegularPolygon.mdx | 15 - .../graphics-2d/RegularPolygonConfig.mdx | 15 - references/1.4.0/graphics-2d/Ring.mdx | 15 - references/1.4.0/graphics-2d/RingConfig.mdx | 15 - references/1.4.0/graphics-2d/Shape.mdx | 15 - references/1.4.0/graphics-2d/ShapeConfig.mdx | 15 - references/1.4.0/graphics-2d/Sprite.mdx | 15 - references/1.4.0/graphics-2d/SpriteConfig.mdx | 15 - references/1.4.0/graphics-2d/Stage.mdx | 15 - references/1.4.0/graphics-2d/StageConfig.mdx | 15 - references/1.4.0/graphics-2d/Star.mdx | 15 - references/1.4.0/graphics-2d/StarConfig.mdx | 15 - references/1.4.0/graphics-2d/Tag.mdx | 15 - references/1.4.0/graphics-2d/TagConfig.mdx | 15 - references/1.4.0/graphics-2d/TextConfig.mdx | 15 - references/1.4.0/graphics-2d/TextPath.mdx | 15 - .../1.4.0/graphics-2d/TextPathConfig.mdx | 15 - references/1.4.0/graphics-2d/Text_2.mdx | 15 - references/1.4.0/graphics-2d/Transform.mdx | 15 - .../1.4.0/graphics-2d/TransformerConfig.mdx | 15 - .../1.4.0/graphics-2d/Transformer_2.mdx | 15 - references/1.4.0/graphics-2d/Tween.mdx | 15 - references/1.4.0/graphics-2d/TweenConfig.mdx | 15 - references/1.4.0/graphics-2d/Util.mdx | 116 - references/1.4.0/graphics-2d/Vector2d.mdx | 15 - references/1.4.0/graphics-2d/Wedge.mdx | 15 - references/1.4.0/graphics-2d/WedgeConfig.mdx | 15 - references/1.4.0/input/0-index.mdx | 88 - references/1.4.0/input/InputEnum.mdx | 177 - references/1.4.0/input/InputLibrary.mdx | 59 - .../1.4.0/input/InputLibrary/constructor.mdx | 19 - .../1.4.0/input/InputLibrary/getDragState.mdx | 29 - .../input/InputLibrary/getMousePosition.mdx | 40 - .../input/InputLibrary/getMouseState.mdx | 29 - .../input/InputLibrary/getPressedKeys.mdx | 29 - .../input/InputLibrary/getWheelState.mdx | 33 - .../1.4.0/input/InputLibrary/isDragging.mdx | 33 - .../1.4.0/input/InputLibrary/isKeyPressed.mdx | 32 - references/1.4.0/music/0-index.mdx | 94 - references/1.4.0/music/MusicLibrary.mdx | 37 - references/1.4.0/music/MusicLibrary/load.mdx | 41 - references/1.4.0/music/MusicLibrary/mute.mdx | 29 - references/1.4.0/music/MusicLibrary/play.mdx | 32 - references/1.4.0/network-client/0-index.mdx | 101 - .../network-client/NetworkClientLibrary.mdx | 35 - .../NetworkClientLibrary/tcp.mdx | 18 - .../NetworkClientLibrary/udp.mdx | 18 - references/1.4.0/network-client/TCPClient.mdx | 47 - .../network-client/TCPClient/connect.mdx | 33 - .../network-client/TCPClient/constructor.mdx | 39 - .../TCPClient/getReceivedPackets.mdx | 33 - .../network-client/TCPClient/isConnected.mdx | 29 - .../network-client/TCPClient/sendData.mdx | 36 - references/1.4.0/network-client/UDPClient.mdx | 47 - .../network-client/UDPClient/connect.mdx | 33 - .../network-client/UDPClient/constructor.mdx | 39 - .../UDPClient/getReceivedPackets.mdx | 33 - .../network-client/UDPClient/isConnected.mdx | 29 - .../network-client/UDPClient/sendData.mdx | 36 - references/1.4.0/network-server/0-index.mdx | 103 - .../network-server/NetworkServerLibrary.mdx | 35 - .../NetworkServerLibrary/tcp.mdx | 18 - .../NetworkServerLibrary/udp.mdx | 18 - references/1.4.0/network-server/TCPServer.mdx | 51 - .../network-server/TCPServer/constructor.mdx | 46 - .../TCPServer/getConnectedClients.mdx | 29 - .../TCPServer/getReceivedPackets.mdx | 29 - .../1.4.0/network-server/TCPServer/listen.mdx | 29 - .../network-server/TCPServer/sendToClient.mdx | 37 - .../TCPServer/sendToEverybody.mdx | 32 - references/1.4.0/network-server/UDPServer.mdx | 51 - .../network-server/UDPServer/constructor.mdx | 46 - .../UDPServer/getConnectedClients.mdx | 29 - .../UDPServer/getReceivedPackets.mdx | 29 - .../1.4.0/network-server/UDPServer/listen.mdx | 29 - .../network-server/UDPServer/sendToClient.mdx | 37 - .../UDPServer/sendToEverybody.mdx | 32 - references/1.4.0/sound/0-index.mdx | 92 - references/1.4.0/sound/SoundLibrary.mdx | 37 - references/1.4.0/sound/SoundLibrary/load.mdx | 41 - references/1.4.0/sound/SoundLibrary/mute.mdx | 29 - references/1.4.0/sound/SoundLibrary/play.mdx | 32 - references/1.4.1/.tsdocs/client/ValidRefs.js | 29 - .../1.4.1/.tsdocs/client/tsdocs-config.js | 28 - .../1.4.1/.tsdocs/client/tsdocs-styles.css | 65 - references/1.4.1/.tsdocs/global.d.ts | 145 - references/1.4.1/asset-manager/0-index.mdx | 89 - .../asset-manager/AssetManagerLibrary.mdx | 33 - .../AssetManagerLibrary/getAsset.mdx | 36 - .../AssetManagerLibrary/getAsset_1.mdx | 26 - references/1.4.1/common/0-index.mdx | 54 - .../1.4.1/common/ASSET_MANAGER_LIBRARY.mdx | 23 - .../1.4.1/common/ApplicationContext.mdx | 37 - .../1.4.1/common/ApplicationContext/delta.mdx | 14 - .../common/ApplicationContext/isRunning.mdx | 14 - .../1.4.1/common/BaseAssetManagerLibrary.mdx | 35 - .../BaseAssetManagerLibrary/getAsset.mdx | 32 - .../BaseAssetManagerLibrary/getAsset_1.mdx | 26 - .../common/BaseComponentSystemLibrary.mdx | 23 - .../1.4.1/common/BaseGraphicsLibrary.mdx | 23 - references/1.4.1/common/BaseInputLibrary.mdx | 23 - references/1.4.1/common/BaseMusicLibrary.mdx | 35 - .../1.4.1/common/BaseMusicLibrary/mute.mdx | 29 - .../1.4.1/common/BaseMusicLibrary/play.mdx | 32 - .../1.4.1/common/BaseNetworkLibrary.mdx | 23 - references/1.4.1/common/BaseSoundLibrary.mdx | 35 - .../1.4.1/common/BaseSoundLibrary/mute.mdx | 29 - .../1.4.1/common/BaseSoundLibrary/play.mdx | 32 - .../1.4.1/common/COMPONENT_SYSTEM_LIBRARY.mdx | 23 - references/1.4.1/common/ClearContext.mdx | 23 - .../1.4.1/common/ClientLibraryManager.mdx | 63 - .../ClientLibraryManager/constructor.mdx | 26 - .../1.4.1/common/ClientLibraryManager/get.mdx | 32 - .../ClientLibraryManager/getAssetManager.mdx | 29 - .../getComponentSystem.mdx | 29 - .../ClientLibraryManager/getGraphics.mdx | 29 - .../common/ClientLibraryManager/getInput.mdx | 29 - .../common/ClientLibraryManager/getMusic.mdx | 29 - .../ClientLibraryManager/getNetwork.mdx | 29 - .../common/ClientLibraryManager/getSound.mdx | 29 - references/1.4.1/common/Context.mdx | 33 - references/1.4.1/common/Context/app.mdx | 10 - .../1.4.1/common/Context/constructor.mdx | 29 - references/1.4.1/common/Context/libs.mdx | 10 - .../1.4.1/common/DefaultLibrariesEnum.mdx | 29 - references/1.4.1/common/ExecutionContext.mdx | 23 - references/1.4.1/common/GRAPHICS_LIBRARY.mdx | 23 - .../1.4.1/common/IAssetManagerLibrary.mdx | 23 - .../common/IAssetManagerLibrary/getAsset.mdx | 18 - .../IAssetManagerLibrary/getAsset_1.mdx | 12 - .../1.4.1/common/IComponentSystemLibrary.mdx | 23 - references/1.4.1/common/IConfigRegistry.mdx | 31 - .../common/IConfigRegistry/registerConfig.mdx | 18 - references/1.4.1/common/IExposedLibrary.mdx | 23 - references/1.4.1/common/IGraphicsLibrary.mdx | 23 - references/1.4.1/common/IInputLibrary.mdx | 23 - references/1.4.1/common/ILibrary.mdx | 23 - references/1.4.1/common/IMusicLibrary.mdx | 23 - references/1.4.1/common/IMutableLibrary.mdx | 23 - .../1.4.1/common/IMutableLibrary/mute.mdx | 18 - references/1.4.1/common/INPUT_LIBRARY.mdx | 23 - references/1.4.1/common/INetworkLibrary.mdx | 23 - references/1.4.1/common/IRunClientOptions.mdx | 23 - .../common/IRunClientOptions/container.mdx | 22 - .../1.4.1/common/IRunClientOptions/env.mdx | 18 - .../1.4.1/common/IRunClientOptions/files.mdx | 22 - references/1.4.1/common/IRunOptions.mdx | 19 - references/1.4.1/common/IRunServerOptions.mdx | 23 - .../1.4.1/common/IRunServerOptions/env.mdx | 18 - .../1.4.1/common/IRunServerOptions/files.mdx | 22 - references/1.4.1/common/IRunnerLibrary.mdx | 23 - references/1.4.1/common/ISoundLibrary.mdx | 23 - references/1.4.1/common/InitContext.mdx | 55 - .../1.4.1/common/InitContext/config.mdx | 18 - .../1.4.1/common/InitContext/constructor.mdx | 41 - .../1.4.1/common/InitContext/container.mdx | 18 - references/1.4.1/common/InitContext/env.mdx | 14 - references/1.4.1/common/InitContext/files.mdx | 14 - references/1.4.1/common/Library.mdx | 45 - .../1.4.1/common/Library/_relationship.mdx | 10 - .../1.4.1/common/Library/constructor.mdx | 27 - references/1.4.1/common/LibraryContext.mdx | 27 - .../1.4.1/common/LibraryContext/status.mdx | 14 - references/1.4.1/common/LibraryHandle.mdx | 49 - .../common/LibraryHandle/constructor.mdx | 36 - .../1.4.1/common/LibraryHandle/context.mdx | 14 - .../1.4.1/common/LibraryHandle/library.mdx | 14 - .../1.4.1/common/LibraryHandle/symbol.mdx | 14 - references/1.4.1/common/LibraryManager.mdx | 67 - .../common/LibraryManager/constructor.mdx | 19 - .../common/LibraryManager/getAssetManager.mdx | 29 - .../LibraryManager/getComponentSystem.mdx | 29 - .../common/LibraryManager/getGraphics.mdx | 29 - .../1.4.1/common/LibraryManager/getInput.mdx | 29 - .../1.4.1/common/LibraryManager/getMusic.mdx | 29 - .../common/LibraryManager/getNetwork.mdx | 29 - .../1.4.1/common/LibraryManager/getSound.mdx | 29 - references/1.4.1/common/LibraryStatusEnum.mdx | 21 - references/1.4.1/common/MUSIC_LIBRARY.mdx | 23 - references/1.4.1/common/NETWORK_LIBRARY.mdx | 23 - references/1.4.1/common/NfConfigException.mdx | 37 - .../1.4.1/common/NfConfigException/code.mdx | 14 - .../common/NfConfigException/constructor.mdx | 32 - references/1.4.1/common/NfFetchException.mdx | 37 - .../1.4.1/common/NfFetchException/code.mdx | 14 - .../common/NfFetchException/constructor.mdx | 31 - references/1.4.1/common/NfFile.mdx | 71 - .../1.4.1/common/NfFile/arrayBuffer.mdx | 29 - references/1.4.1/common/NfFile/blob.mdx | 29 - references/1.4.1/common/NfFile/bytes.mdx | 29 - .../1.4.1/common/NfFile/constructor.mdx | 26 - references/1.4.1/common/NfFile/formData.mdx | 29 - references/1.4.1/common/NfFile/json.mdx | 29 - references/1.4.1/common/NfFile/path.mdx | 14 - references/1.4.1/common/NfFile/text.mdx | 29 - references/1.4.1/common/NfNotFound.mdx | 41 - references/1.4.1/common/NfNotFound/code.mdx | 14 - .../1.4.1/common/NfNotFound/constructor.mdx | 32 - .../common/NfNotInitializedException.mdx | 37 - .../common/NfNotInitializedException/code.mdx | 14 - .../NfNotInitializedException/constructor.mdx | 32 - references/1.4.1/common/SOUND_LIBRARY.mdx | 23 - references/1.4.1/config/0-index.mdx | 159 - references/1.4.1/config/Default.mdx | 44 - references/1.4.1/config/IsIpOrURL.mdx | 45 - .../1.4.1/config/TransformToBoolean.mdx | 41 - references/1.4.1/core-editor/0-index.mdx | 56 - references/1.4.1/core-editor/CoreEvents.mdx | 23 - references/1.4.1/core-editor/EditorEvents.mdx | 15 - references/1.4.1/core-editor/EventEmitter.mdx | 33 - .../core-editor/EventEmitter/constructor.mdx | 24 - .../1.4.1/core-editor/EventEmitter/emit.mdx | 31 - .../1.4.1/core-editor/EventEmitter/on.mdx | 31 - .../core-editor/EventEmitter/runEvents.mdx | 23 - .../1.4.1/core-editor/NanoforgeClient.mdx | 37 - .../NanoforgeClient/useGraphics.mdx | 32 - .../core-editor/NanoforgeClient/useInput.mdx | 32 - .../core-editor/NanoforgeClient/useSound.mdx | 32 - .../1.4.1/core-editor/NanoforgeFactory.mdx | 31 - .../1.4.1/core-editor/NanoforgeServer.mdx | 23 - references/1.4.1/core/0-index.mdx | 71 - references/1.4.1/core/NanoforgeClient.mdx | 45 - .../core/NanoforgeClient/useGraphics.mdx | 32 - .../1.4.1/core/NanoforgeClient/useInput.mdx | 32 - .../1.4.1/core/NanoforgeClient/useSound.mdx | 32 - references/1.4.1/core/NanoforgeFactory.mdx | 31 - references/1.4.1/core/NanoforgeServer.mdx | 31 - references/1.4.1/ecs-client/0-index.mdx | 129 - .../1.4.1/ecs-client/ECSClientLibrary.mdx | 29 - .../ECSClientLibrary/constructor.mdx | 19 - references/1.4.1/ecs-lib/0-index.mdx | 60 - .../1.4.1/ecs-lib/AbstractECSLibrary.mdx | 66 - .../ecs-lib/AbstractECSLibrary/_registry.mdx | 10 - .../AbstractECSLibrary/constructor.mdx | 19 - .../ecs-lib/AbstractECSLibrary/module.mdx | 10 - .../1.4.1/ecs-lib/AbstractECSLibrary/path.mdx | 10 - .../ecs-lib/AbstractECSLibrary/registry.mdx | 18 - references/1.4.1/ecs-lib/Component.mdx | 18 - .../1.4.1/ecs-lib/EditorComponentManifest.mdx | 23 - .../1.4.1/ecs-lib/EditorSystemManifest.mdx | 23 - references/1.4.1/ecs-lib/Entity.mdx | 15 - references/1.4.1/ecs-lib/Entity/getId.mdx | 12 - references/1.4.1/ecs-lib/Registry.mdx | 15 - .../1.4.1/ecs-lib/Registry/addComponent.mdx | 12 - .../1.4.1/ecs-lib/Registry/addSystem.mdx | 12 - .../1.4.1/ecs-lib/Registry/clearEntities.mdx | 12 - .../1.4.1/ecs-lib/Registry/clearSystems.mdx | 12 - .../ecs-lib/Registry/entityFromIndex.mdx | 12 - .../1.4.1/ecs-lib/Registry/getComponents.mdx | 12 - .../ecs-lib/Registry/getComponentsConst.mdx | 12 - .../ecs-lib/Registry/getEntityComponent.mdx | 12 - .../Registry/getEntityComponentConst.mdx | 12 - .../ecs-lib/Registry/getIndexedZipper.mdx | 12 - .../1.4.1/ecs-lib/Registry/getZipper.mdx | 12 - .../1.4.1/ecs-lib/Registry/killEntity.mdx | 12 - .../1.4.1/ecs-lib/Registry/maxEntities.mdx | 12 - .../ecs-lib/Registry/registerComponent.mdx | 12 - .../ecs-lib/Registry/removeComponent.mdx | 12 - .../1.4.1/ecs-lib/Registry/removeSystem.mdx | 12 - .../1.4.1/ecs-lib/Registry/runSystems.mdx | 12 - .../1.4.1/ecs-lib/Registry/spawnEntity.mdx | 12 - references/1.4.1/ecs-lib/SparseArray.mdx | 15 - .../1.4.1/ecs-lib/SparseArray/clear.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/empty.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/erase.mdx | 12 - references/1.4.1/ecs-lib/SparseArray/get.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/getConst.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/getIndex.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/insertAt.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/insertAt_1.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/resize.mdx | 12 - references/1.4.1/ecs-lib/SparseArray/set.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/setByCopy.mdx | 12 - .../1.4.1/ecs-lib/SparseArray/setByMove.mdx | 12 - references/1.4.1/ecs-lib/SparseArray/size.mdx | 12 - references/1.4.1/ecs-lib/System.mdx | 15 - references/1.4.1/ecs-server/0-index.mdx | 129 - .../1.4.1/ecs-server/ECSServerLibrary.mdx | 29 - .../ECSServerLibrary/constructor.mdx | 19 - references/1.4.1/ecs-server/Module.mdx | 15 - references/1.4.1/graphics-2d/0-index.mdx | 114 - references/1.4.1/graphics-2d/Animation_2.mdx | 15 - references/1.4.1/graphics-2d/Arc.mdx | 15 - references/1.4.1/graphics-2d/ArcConfig.mdx | 15 - references/1.4.1/graphics-2d/Arrow.mdx | 15 - references/1.4.1/graphics-2d/ArrowConfig.mdx | 15 - references/1.4.1/graphics-2d/Canvas.mdx | 15 - references/1.4.1/graphics-2d/Circle.mdx | 15 - references/1.4.1/graphics-2d/CircleConfig.mdx | 15 - references/1.4.1/graphics-2d/Container.mdx | 15 - .../1.4.1/graphics-2d/ContainerConfig.mdx | 15 - references/1.4.1/graphics-2d/Context.mdx | 15 - references/1.4.1/graphics-2d/DD.mdx | 30 - references/1.4.1/graphics-2d/Easings.mdx | 32 - references/1.4.1/graphics-2d/Ellipse.mdx | 15 - .../1.4.1/graphics-2d/EllipseConfig.mdx | 15 - references/1.4.1/graphics-2d/FastLayer.mdx | 15 - references/1.4.1/graphics-2d/Filters.mdx | 36 - .../1.4.1/graphics-2d/Graphics2DLibrary.mdx | 37 - .../Graphics2DLibrary/baseLayer.mdx | 18 - .../graphics-2d/Graphics2DLibrary/stage.mdx | 18 - references/1.4.1/graphics-2d/Group.mdx | 15 - references/1.4.1/graphics-2d/GroupConfig.mdx | 15 - references/1.4.1/graphics-2d/ImageConfig.mdx | 15 - references/1.4.1/graphics-2d/Image_2.mdx | 15 - .../1.4.1/graphics-2d/KonvaEventListener.mdx | 15 - .../1.4.1/graphics-2d/KonvaEventObject.mdx | 15 - .../1.4.1/graphics-2d/KonvaPointerEvent.mdx | 15 - references/1.4.1/graphics-2d/Label.mdx | 15 - references/1.4.1/graphics-2d/LabelConfig.mdx | 15 - references/1.4.1/graphics-2d/Layer.mdx | 15 - references/1.4.1/graphics-2d/LayerConfig.mdx | 15 - references/1.4.1/graphics-2d/Line.mdx | 15 - references/1.4.1/graphics-2d/LineConfig.mdx | 15 - references/1.4.1/graphics-2d/NodeConfig.mdx | 15 - references/1.4.1/graphics-2d/Node_2.mdx | 15 - references/1.4.1/graphics-2d/Path.mdx | 15 - references/1.4.1/graphics-2d/PathConfig.mdx | 15 - references/1.4.1/graphics-2d/Rect.mdx | 15 - references/1.4.1/graphics-2d/RectConfig.mdx | 15 - .../1.4.1/graphics-2d/RegularPolygon.mdx | 15 - .../graphics-2d/RegularPolygonConfig.mdx | 15 - references/1.4.1/graphics-2d/Ring.mdx | 15 - references/1.4.1/graphics-2d/RingConfig.mdx | 15 - references/1.4.1/graphics-2d/Shape.mdx | 15 - references/1.4.1/graphics-2d/ShapeConfig.mdx | 15 - references/1.4.1/graphics-2d/Sprite.mdx | 15 - references/1.4.1/graphics-2d/SpriteConfig.mdx | 15 - references/1.4.1/graphics-2d/Stage.mdx | 15 - references/1.4.1/graphics-2d/StageConfig.mdx | 15 - references/1.4.1/graphics-2d/Star.mdx | 15 - references/1.4.1/graphics-2d/StarConfig.mdx | 15 - references/1.4.1/graphics-2d/Tag.mdx | 15 - references/1.4.1/graphics-2d/TagConfig.mdx | 15 - references/1.4.1/graphics-2d/TextConfig.mdx | 15 - references/1.4.1/graphics-2d/TextPath.mdx | 15 - .../1.4.1/graphics-2d/TextPathConfig.mdx | 15 - references/1.4.1/graphics-2d/Text_2.mdx | 15 - references/1.4.1/graphics-2d/Transform.mdx | 15 - .../1.4.1/graphics-2d/TransformerConfig.mdx | 15 - .../1.4.1/graphics-2d/Transformer_2.mdx | 15 - references/1.4.1/graphics-2d/Tween.mdx | 15 - references/1.4.1/graphics-2d/TweenConfig.mdx | 15 - references/1.4.1/graphics-2d/Util.mdx | 116 - references/1.4.1/graphics-2d/Vector2d.mdx | 15 - references/1.4.1/graphics-2d/Wedge.mdx | 15 - references/1.4.1/graphics-2d/WedgeConfig.mdx | 15 - references/1.4.1/input/0-index.mdx | 88 - references/1.4.1/input/InputEnum.mdx | 177 - references/1.4.1/input/InputLibrary.mdx | 59 - .../1.4.1/input/InputLibrary/constructor.mdx | 19 - .../1.4.1/input/InputLibrary/getDragState.mdx | 29 - .../input/InputLibrary/getMousePosition.mdx | 40 - .../input/InputLibrary/getMouseState.mdx | 29 - .../input/InputLibrary/getPressedKeys.mdx | 29 - .../input/InputLibrary/getWheelState.mdx | 33 - .../1.4.1/input/InputLibrary/isDragging.mdx | 33 - .../1.4.1/input/InputLibrary/isKeyPressed.mdx | 32 - references/1.4.1/music/0-index.mdx | 94 - references/1.4.1/music/MusicLibrary.mdx | 37 - references/1.4.1/music/MusicLibrary/load.mdx | 41 - references/1.4.1/music/MusicLibrary/mute.mdx | 29 - references/1.4.1/music/MusicLibrary/play.mdx | 32 - references/1.4.1/network-client/0-index.mdx | 101 - .../network-client/NetworkClientLibrary.mdx | 35 - .../NetworkClientLibrary/tcp.mdx | 18 - .../NetworkClientLibrary/udp.mdx | 18 - references/1.4.1/network-client/TCPClient.mdx | 47 - .../network-client/TCPClient/connect.mdx | 33 - .../network-client/TCPClient/constructor.mdx | 39 - .../TCPClient/getReceivedPackets.mdx | 33 - .../network-client/TCPClient/isConnected.mdx | 29 - .../network-client/TCPClient/sendData.mdx | 36 - references/1.4.1/network-client/UDPClient.mdx | 47 - .../network-client/UDPClient/connect.mdx | 33 - .../network-client/UDPClient/constructor.mdx | 39 - .../UDPClient/getReceivedPackets.mdx | 33 - .../network-client/UDPClient/isConnected.mdx | 29 - .../network-client/UDPClient/sendData.mdx | 36 - references/1.4.1/network-server/0-index.mdx | 103 - .../network-server/NetworkServerLibrary.mdx | 35 - .../NetworkServerLibrary/tcp.mdx | 18 - .../NetworkServerLibrary/udp.mdx | 18 - references/1.4.1/network-server/TCPServer.mdx | 51 - .../network-server/TCPServer/constructor.mdx | 46 - .../TCPServer/getConnectedClients.mdx | 29 - .../TCPServer/getReceivedPackets.mdx | 29 - .../1.4.1/network-server/TCPServer/listen.mdx | 29 - .../network-server/TCPServer/sendToClient.mdx | 37 - .../TCPServer/sendToEverybody.mdx | 32 - references/1.4.1/network-server/UDPServer.mdx | 51 - .../network-server/UDPServer/constructor.mdx | 46 - .../UDPServer/getConnectedClients.mdx | 29 - .../UDPServer/getReceivedPackets.mdx | 29 - .../1.4.1/network-server/UDPServer/listen.mdx | 29 - .../network-server/UDPServer/sendToClient.mdx | 37 - .../UDPServer/sendToEverybody.mdx | 32 - references/1.4.1/sound/0-index.mdx | 92 - references/1.4.1/sound/SoundLibrary.mdx | 37 - references/1.4.1/sound/SoundLibrary/load.mdx | 41 - references/1.4.1/sound/SoundLibrary/mute.mdx | 29 - references/1.4.1/sound/SoundLibrary/play.mdx | 32 - references/1.4.2/.tsdocs/client/ValidRefs.js | 29 - .../1.4.2/.tsdocs/client/tsdocs-config.js | 28 - .../1.4.2/.tsdocs/client/tsdocs-styles.css | 65 - references/1.4.2/.tsdocs/global.d.ts | 145 - references/1.4.2/asset-manager/0-index.mdx | 89 - .../asset-manager/AssetManagerLibrary.mdx | 33 - .../AssetManagerLibrary/getAsset.mdx | 36 - .../AssetManagerLibrary/getAsset_1.mdx | 26 - references/1.4.2/common/0-index.mdx | 54 - .../1.4.2/common/ASSET_MANAGER_LIBRARY.mdx | 23 - .../1.4.2/common/ApplicationContext.mdx | 37 - .../1.4.2/common/ApplicationContext/delta.mdx | 14 - .../common/ApplicationContext/isRunning.mdx | 14 - .../1.4.2/common/BaseAssetManagerLibrary.mdx | 35 - .../BaseAssetManagerLibrary/getAsset.mdx | 32 - .../BaseAssetManagerLibrary/getAsset_1.mdx | 26 - .../common/BaseComponentSystemLibrary.mdx | 23 - .../1.4.2/common/BaseGraphicsLibrary.mdx | 23 - references/1.4.2/common/BaseInputLibrary.mdx | 23 - references/1.4.2/common/BaseMusicLibrary.mdx | 35 - .../1.4.2/common/BaseMusicLibrary/mute.mdx | 29 - .../1.4.2/common/BaseMusicLibrary/play.mdx | 32 - .../1.4.2/common/BaseNetworkLibrary.mdx | 23 - references/1.4.2/common/BaseSoundLibrary.mdx | 35 - .../1.4.2/common/BaseSoundLibrary/mute.mdx | 29 - .../1.4.2/common/BaseSoundLibrary/play.mdx | 32 - .../1.4.2/common/COMPONENT_SYSTEM_LIBRARY.mdx | 23 - references/1.4.2/common/ClearContext.mdx | 23 - .../1.4.2/common/ClientLibraryManager.mdx | 63 - .../ClientLibraryManager/constructor.mdx | 26 - .../1.4.2/common/ClientLibraryManager/get.mdx | 32 - .../ClientLibraryManager/getAssetManager.mdx | 29 - .../getComponentSystem.mdx | 29 - .../ClientLibraryManager/getGraphics.mdx | 29 - .../common/ClientLibraryManager/getInput.mdx | 29 - .../common/ClientLibraryManager/getMusic.mdx | 29 - .../ClientLibraryManager/getNetwork.mdx | 29 - .../common/ClientLibraryManager/getSound.mdx | 29 - references/1.4.2/common/Context.mdx | 33 - references/1.4.2/common/Context/app.mdx | 10 - .../1.4.2/common/Context/constructor.mdx | 29 - references/1.4.2/common/Context/libs.mdx | 10 - .../1.4.2/common/DefaultLibrariesEnum.mdx | 29 - references/1.4.2/common/ExecutionContext.mdx | 23 - references/1.4.2/common/GRAPHICS_LIBRARY.mdx | 23 - .../1.4.2/common/IAssetManagerLibrary.mdx | 23 - .../common/IAssetManagerLibrary/getAsset.mdx | 18 - .../IAssetManagerLibrary/getAsset_1.mdx | 12 - .../1.4.2/common/IComponentSystemLibrary.mdx | 23 - references/1.4.2/common/IConfigRegistry.mdx | 31 - .../common/IConfigRegistry/registerConfig.mdx | 18 - references/1.4.2/common/IExposedLibrary.mdx | 23 - references/1.4.2/common/IGraphicsLibrary.mdx | 23 - references/1.4.2/common/IInputLibrary.mdx | 23 - references/1.4.2/common/ILibrary.mdx | 23 - references/1.4.2/common/IMusicLibrary.mdx | 23 - references/1.4.2/common/IMutableLibrary.mdx | 23 - .../1.4.2/common/IMutableLibrary/mute.mdx | 18 - references/1.4.2/common/INPUT_LIBRARY.mdx | 23 - references/1.4.2/common/INetworkLibrary.mdx | 23 - references/1.4.2/common/IRunClientOptions.mdx | 23 - .../common/IRunClientOptions/container.mdx | 22 - .../1.4.2/common/IRunClientOptions/env.mdx | 18 - .../1.4.2/common/IRunClientOptions/files.mdx | 22 - references/1.4.2/common/IRunOptions.mdx | 19 - references/1.4.2/common/IRunServerOptions.mdx | 23 - .../1.4.2/common/IRunServerOptions/env.mdx | 18 - .../1.4.2/common/IRunServerOptions/files.mdx | 22 - references/1.4.2/common/IRunnerLibrary.mdx | 23 - references/1.4.2/common/ISoundLibrary.mdx | 23 - references/1.4.2/common/InitContext.mdx | 55 - .../1.4.2/common/InitContext/config.mdx | 18 - .../1.4.2/common/InitContext/constructor.mdx | 41 - .../1.4.2/common/InitContext/container.mdx | 18 - references/1.4.2/common/InitContext/env.mdx | 14 - references/1.4.2/common/InitContext/files.mdx | 14 - references/1.4.2/common/Library.mdx | 45 - .../1.4.2/common/Library/_relationship.mdx | 10 - .../1.4.2/common/Library/constructor.mdx | 27 - references/1.4.2/common/LibraryContext.mdx | 27 - .../1.4.2/common/LibraryContext/status.mdx | 14 - references/1.4.2/common/LibraryHandle.mdx | 49 - .../common/LibraryHandle/constructor.mdx | 36 - .../1.4.2/common/LibraryHandle/context.mdx | 14 - .../1.4.2/common/LibraryHandle/library.mdx | 14 - .../1.4.2/common/LibraryHandle/symbol.mdx | 14 - references/1.4.2/common/LibraryManager.mdx | 67 - .../common/LibraryManager/constructor.mdx | 19 - .../common/LibraryManager/getAssetManager.mdx | 29 - .../LibraryManager/getComponentSystem.mdx | 29 - .../common/LibraryManager/getGraphics.mdx | 29 - .../1.4.2/common/LibraryManager/getInput.mdx | 29 - .../1.4.2/common/LibraryManager/getMusic.mdx | 29 - .../common/LibraryManager/getNetwork.mdx | 29 - .../1.4.2/common/LibraryManager/getSound.mdx | 29 - references/1.4.2/common/LibraryStatusEnum.mdx | 21 - references/1.4.2/common/MUSIC_LIBRARY.mdx | 23 - references/1.4.2/common/NETWORK_LIBRARY.mdx | 23 - references/1.4.2/common/NfConfigException.mdx | 37 - .../1.4.2/common/NfConfigException/code.mdx | 14 - .../common/NfConfigException/constructor.mdx | 32 - references/1.4.2/common/NfFetchException.mdx | 37 - .../1.4.2/common/NfFetchException/code.mdx | 14 - .../common/NfFetchException/constructor.mdx | 31 - references/1.4.2/common/NfFile.mdx | 71 - .../1.4.2/common/NfFile/arrayBuffer.mdx | 29 - references/1.4.2/common/NfFile/blob.mdx | 29 - references/1.4.2/common/NfFile/bytes.mdx | 29 - .../1.4.2/common/NfFile/constructor.mdx | 26 - references/1.4.2/common/NfFile/formData.mdx | 29 - references/1.4.2/common/NfFile/json.mdx | 29 - references/1.4.2/common/NfFile/path.mdx | 14 - references/1.4.2/common/NfFile/text.mdx | 29 - references/1.4.2/common/NfNotFound.mdx | 41 - references/1.4.2/common/NfNotFound/code.mdx | 14 - .../1.4.2/common/NfNotFound/constructor.mdx | 32 - .../common/NfNotInitializedException.mdx | 37 - .../common/NfNotInitializedException/code.mdx | 14 - .../NfNotInitializedException/constructor.mdx | 32 - references/1.4.2/common/SOUND_LIBRARY.mdx | 23 - references/1.4.2/config/0-index.mdx | 159 - references/1.4.2/config/Default.mdx | 44 - references/1.4.2/config/IsIpOrURL.mdx | 57 - .../1.4.2/config/TransformToBoolean.mdx | 41 - references/1.4.2/core-editor/0-index.mdx | 56 - references/1.4.2/core-editor/CoreEvents.mdx | 23 - references/1.4.2/core-editor/EditorEvents.mdx | 15 - references/1.4.2/core-editor/EventEmitter.mdx | 33 - .../core-editor/EventEmitter/constructor.mdx | 24 - .../1.4.2/core-editor/EventEmitter/emit.mdx | 31 - .../1.4.2/core-editor/EventEmitter/on.mdx | 31 - .../core-editor/EventEmitter/runEvents.mdx | 23 - .../1.4.2/core-editor/NanoforgeClient.mdx | 37 - .../NanoforgeClient/useGraphics.mdx | 32 - .../core-editor/NanoforgeClient/useInput.mdx | 32 - .../core-editor/NanoforgeClient/useSound.mdx | 32 - .../1.4.2/core-editor/NanoforgeFactory.mdx | 31 - .../1.4.2/core-editor/NanoforgeServer.mdx | 23 - references/1.4.2/core/0-index.mdx | 71 - references/1.4.2/core/NanoforgeClient.mdx | 45 - .../core/NanoforgeClient/useGraphics.mdx | 32 - .../1.4.2/core/NanoforgeClient/useInput.mdx | 32 - .../1.4.2/core/NanoforgeClient/useSound.mdx | 32 - references/1.4.2/core/NanoforgeFactory.mdx | 31 - references/1.4.2/core/NanoforgeServer.mdx | 31 - references/1.4.2/ecs-client/0-index.mdx | 129 - .../1.4.2/ecs-client/ECSClientLibrary.mdx | 29 - .../ECSClientLibrary/constructor.mdx | 19 - references/1.4.2/ecs-lib/0-index.mdx | 60 - .../1.4.2/ecs-lib/AbstractECSLibrary.mdx | 66 - .../ecs-lib/AbstractECSLibrary/_registry.mdx | 10 - .../AbstractECSLibrary/constructor.mdx | 19 - .../ecs-lib/AbstractECSLibrary/module.mdx | 10 - .../1.4.2/ecs-lib/AbstractECSLibrary/path.mdx | 10 - .../ecs-lib/AbstractECSLibrary/registry.mdx | 18 - references/1.4.2/ecs-lib/Component.mdx | 18 - .../1.4.2/ecs-lib/EditorComponentManifest.mdx | 23 - .../1.4.2/ecs-lib/EditorSystemManifest.mdx | 23 - references/1.4.2/ecs-lib/Entity.mdx | 15 - references/1.4.2/ecs-lib/Entity/getId.mdx | 12 - references/1.4.2/ecs-lib/Registry.mdx | 15 - .../1.4.2/ecs-lib/Registry/addComponent.mdx | 12 - .../1.4.2/ecs-lib/Registry/addSystem.mdx | 12 - .../1.4.2/ecs-lib/Registry/clearEntities.mdx | 12 - .../1.4.2/ecs-lib/Registry/clearSystems.mdx | 12 - .../ecs-lib/Registry/entityFromIndex.mdx | 12 - .../1.4.2/ecs-lib/Registry/getComponents.mdx | 12 - .../ecs-lib/Registry/getComponentsConst.mdx | 12 - .../ecs-lib/Registry/getEntityComponent.mdx | 12 - .../Registry/getEntityComponentConst.mdx | 12 - .../ecs-lib/Registry/getIndexedZipper.mdx | 12 - .../1.4.2/ecs-lib/Registry/getZipper.mdx | 12 - .../1.4.2/ecs-lib/Registry/killEntity.mdx | 12 - .../1.4.2/ecs-lib/Registry/maxEntities.mdx | 12 - .../ecs-lib/Registry/registerComponent.mdx | 12 - .../ecs-lib/Registry/removeComponent.mdx | 12 - .../1.4.2/ecs-lib/Registry/removeSystem.mdx | 12 - .../1.4.2/ecs-lib/Registry/runSystems.mdx | 12 - .../1.4.2/ecs-lib/Registry/spawnEntity.mdx | 12 - references/1.4.2/ecs-lib/SparseArray.mdx | 15 - .../1.4.2/ecs-lib/SparseArray/clear.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/empty.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/erase.mdx | 12 - references/1.4.2/ecs-lib/SparseArray/get.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/getConst.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/getIndex.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/insertAt.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/insertAt_1.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/resize.mdx | 12 - references/1.4.2/ecs-lib/SparseArray/set.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/setByCopy.mdx | 12 - .../1.4.2/ecs-lib/SparseArray/setByMove.mdx | 12 - references/1.4.2/ecs-lib/SparseArray/size.mdx | 12 - references/1.4.2/ecs-lib/System.mdx | 15 - references/1.4.2/ecs-server/0-index.mdx | 129 - .../1.4.2/ecs-server/ECSServerLibrary.mdx | 29 - .../ECSServerLibrary/constructor.mdx | 19 - references/1.4.2/ecs-server/Module.mdx | 15 - references/1.4.2/graphics-2d/0-index.mdx | 114 - references/1.4.2/graphics-2d/Animation_2.mdx | 15 - references/1.4.2/graphics-2d/Arc.mdx | 15 - references/1.4.2/graphics-2d/ArcConfig.mdx | 15 - references/1.4.2/graphics-2d/Arrow.mdx | 15 - references/1.4.2/graphics-2d/ArrowConfig.mdx | 15 - references/1.4.2/graphics-2d/Canvas.mdx | 15 - references/1.4.2/graphics-2d/Circle.mdx | 15 - references/1.4.2/graphics-2d/CircleConfig.mdx | 15 - references/1.4.2/graphics-2d/Container.mdx | 15 - .../1.4.2/graphics-2d/ContainerConfig.mdx | 15 - references/1.4.2/graphics-2d/Context.mdx | 15 - references/1.4.2/graphics-2d/DD.mdx | 30 - references/1.4.2/graphics-2d/Easings.mdx | 32 - references/1.4.2/graphics-2d/Ellipse.mdx | 15 - .../1.4.2/graphics-2d/EllipseConfig.mdx | 15 - references/1.4.2/graphics-2d/FastLayer.mdx | 15 - references/1.4.2/graphics-2d/Filters.mdx | 36 - .../1.4.2/graphics-2d/Graphics2DLibrary.mdx | 37 - .../Graphics2DLibrary/baseLayer.mdx | 18 - .../graphics-2d/Graphics2DLibrary/stage.mdx | 18 - references/1.4.2/graphics-2d/Group.mdx | 15 - references/1.4.2/graphics-2d/GroupConfig.mdx | 15 - references/1.4.2/graphics-2d/ImageConfig.mdx | 15 - references/1.4.2/graphics-2d/Image_2.mdx | 15 - .../1.4.2/graphics-2d/KonvaEventListener.mdx | 15 - .../1.4.2/graphics-2d/KonvaEventObject.mdx | 15 - .../1.4.2/graphics-2d/KonvaPointerEvent.mdx | 15 - references/1.4.2/graphics-2d/Label.mdx | 15 - references/1.4.2/graphics-2d/LabelConfig.mdx | 15 - references/1.4.2/graphics-2d/Layer.mdx | 15 - references/1.4.2/graphics-2d/LayerConfig.mdx | 15 - references/1.4.2/graphics-2d/Line.mdx | 15 - references/1.4.2/graphics-2d/LineConfig.mdx | 15 - references/1.4.2/graphics-2d/NodeConfig.mdx | 15 - references/1.4.2/graphics-2d/Node_2.mdx | 15 - references/1.4.2/graphics-2d/Path.mdx | 15 - references/1.4.2/graphics-2d/PathConfig.mdx | 15 - references/1.4.2/graphics-2d/Rect.mdx | 15 - references/1.4.2/graphics-2d/RectConfig.mdx | 15 - .../1.4.2/graphics-2d/RegularPolygon.mdx | 15 - .../graphics-2d/RegularPolygonConfig.mdx | 15 - references/1.4.2/graphics-2d/Ring.mdx | 15 - references/1.4.2/graphics-2d/RingConfig.mdx | 15 - references/1.4.2/graphics-2d/Shape.mdx | 15 - references/1.4.2/graphics-2d/ShapeConfig.mdx | 15 - references/1.4.2/graphics-2d/Sprite.mdx | 15 - references/1.4.2/graphics-2d/SpriteConfig.mdx | 15 - references/1.4.2/graphics-2d/Stage.mdx | 15 - references/1.4.2/graphics-2d/StageConfig.mdx | 15 - references/1.4.2/graphics-2d/Star.mdx | 15 - references/1.4.2/graphics-2d/StarConfig.mdx | 15 - references/1.4.2/graphics-2d/Tag.mdx | 15 - references/1.4.2/graphics-2d/TagConfig.mdx | 15 - references/1.4.2/graphics-2d/TextConfig.mdx | 15 - references/1.4.2/graphics-2d/TextPath.mdx | 15 - .../1.4.2/graphics-2d/TextPathConfig.mdx | 15 - references/1.4.2/graphics-2d/Text_2.mdx | 15 - references/1.4.2/graphics-2d/Transform.mdx | 15 - .../1.4.2/graphics-2d/TransformerConfig.mdx | 15 - .../1.4.2/graphics-2d/Transformer_2.mdx | 15 - references/1.4.2/graphics-2d/Tween.mdx | 15 - references/1.4.2/graphics-2d/TweenConfig.mdx | 15 - references/1.4.2/graphics-2d/Util.mdx | 116 - references/1.4.2/graphics-2d/Vector2d.mdx | 15 - references/1.4.2/graphics-2d/Wedge.mdx | 15 - references/1.4.2/graphics-2d/WedgeConfig.mdx | 15 - references/1.4.2/input/0-index.mdx | 88 - references/1.4.2/input/InputEnum.mdx | 177 - references/1.4.2/input/InputLibrary.mdx | 59 - .../1.4.2/input/InputLibrary/constructor.mdx | 19 - .../1.4.2/input/InputLibrary/getDragState.mdx | 29 - .../input/InputLibrary/getMousePosition.mdx | 40 - .../input/InputLibrary/getMouseState.mdx | 29 - .../input/InputLibrary/getPressedKeys.mdx | 29 - .../input/InputLibrary/getWheelState.mdx | 33 - .../1.4.2/input/InputLibrary/isDragging.mdx | 33 - .../1.4.2/input/InputLibrary/isKeyPressed.mdx | 32 - references/1.4.2/music/0-index.mdx | 94 - references/1.4.2/music/MusicLibrary.mdx | 37 - references/1.4.2/music/MusicLibrary/load.mdx | 41 - references/1.4.2/music/MusicLibrary/mute.mdx | 29 - references/1.4.2/music/MusicLibrary/play.mdx | 32 - references/1.4.2/network-client/0-index.mdx | 101 - .../network-client/NetworkClientLibrary.mdx | 35 - .../NetworkClientLibrary/tcp.mdx | 18 - .../NetworkClientLibrary/udp.mdx | 18 - references/1.4.2/network-client/TCPClient.mdx | 47 - .../network-client/TCPClient/connect.mdx | 33 - .../network-client/TCPClient/constructor.mdx | 39 - .../TCPClient/getReceivedPackets.mdx | 33 - .../network-client/TCPClient/isConnected.mdx | 29 - .../network-client/TCPClient/sendData.mdx | 36 - references/1.4.2/network-client/UDPClient.mdx | 47 - .../network-client/UDPClient/connect.mdx | 33 - .../network-client/UDPClient/constructor.mdx | 39 - .../UDPClient/getReceivedPackets.mdx | 33 - .../network-client/UDPClient/isConnected.mdx | 29 - .../network-client/UDPClient/sendData.mdx | 36 - references/1.4.2/network-server/0-index.mdx | 103 - .../network-server/NetworkServerLibrary.mdx | 35 - .../NetworkServerLibrary/tcp.mdx | 18 - .../NetworkServerLibrary/udp.mdx | 18 - references/1.4.2/network-server/TCPServer.mdx | 51 - .../network-server/TCPServer/constructor.mdx | 46 - .../TCPServer/getConnectedClients.mdx | 29 - .../TCPServer/getReceivedPackets.mdx | 29 - .../1.4.2/network-server/TCPServer/listen.mdx | 29 - .../network-server/TCPServer/sendToClient.mdx | 37 - .../TCPServer/sendToEverybody.mdx | 32 - references/1.4.2/network-server/UDPServer.mdx | 51 - .../network-server/UDPServer/constructor.mdx | 46 - .../UDPServer/getConnectedClients.mdx | 29 - .../UDPServer/getReceivedPackets.mdx | 29 - .../1.4.2/network-server/UDPServer/listen.mdx | 29 - .../network-server/UDPServer/sendToClient.mdx | 37 - .../UDPServer/sendToEverybody.mdx | 32 - references/1.4.2/sound/0-index.mdx | 92 - references/1.4.2/sound/SoundLibrary.mdx | 37 - references/1.4.2/sound/SoundLibrary/load.mdx | 41 - references/1.4.2/sound/SoundLibrary/mute.mdx | 29 - references/1.4.2/sound/SoundLibrary/play.mdx | 32 - references/engine/navigation.json | 1 + references/engine/upcoming.mdx | 6 + 1409 files changed, 272 insertions(+), 44141 deletions(-) create mode 100644 .prettierignore delete mode 100644 docs/cli/commands/1-overview.mdx delete mode 100644 docs/cli/commands/2-commands/1-new.mdx delete mode 100644 docs/cli/commands/2-commands/2-dev.mdx delete mode 100644 docs/cli/commands/2-commands/3-build.mdx delete mode 100644 docs/cli/commands/2-commands/4-start.mdx delete mode 100644 docs/cli/commands/2-commands/5-create.mdx delete mode 100644 docs/cli/commands/2-commands/6-install.mdx delete mode 100644 docs/cli/commands/2-commands/7-editor.mdx delete mode 100644 docs/cli/commands/2-commands/7-install.mdx delete mode 100644 docs/cli/commands/2-commands/8-editor.mdx delete mode 100644 docs/cli/commands/2-commands/8-registry.mdx delete mode 100644 docs/cli/commands/2-commands/9-registry.mdx delete mode 100644 docs/cli/configuration/1-configuration-file.mdx delete mode 100644 docs/cli/configuration/2-environment-variables.mdx delete mode 100644 docs/cli/getting-started/1-introduction.mdx delete mode 100644 docs/cli/getting-started/2-installation.mdx delete mode 100644 docs/cli/getting-started/3-quickstart.mdx delete mode 100644 docs/cli/getting-started/index.mdx delete mode 100644 docs/cli/getting-started/usage.mdx delete mode 100644 docs/cli/loader/1-overview.mdx delete mode 100644 docs/cli/loader/2-client.mdx delete mode 100644 docs/cli/loader/3-website.mdx delete mode 100644 docs/cli/loader/4-server.mdx delete mode 100644 docs/cli/schematics/1-overview.mdx delete mode 100644 docs/cli/schematics/2-schematics/1-application.mdx delete mode 100644 docs/cli/schematics/2-schematics/1-workspace.mdx delete mode 100644 docs/cli/schematics/2-schematics/2-configuration.mdx delete mode 100644 docs/cli/schematics/2-schematics/2-project.mdx delete mode 100644 docs/cli/schematics/2-schematics/3-component.mdx delete mode 100644 docs/cli/schematics/2-schematics/3-part-base.mdx delete mode 100644 docs/cli/schematics/2-schematics/4-part-main.mdx delete mode 100644 docs/cli/schematics/2-schematics/4-system.mdx delete mode 100644 docs/cli/schematics/2-schematics/5-docker.mdx delete mode 100644 docs/cli/schematics/2-schematics/6-component.mdx delete mode 100644 docs/cli/schematics/2-schematics/7-system.mdx delete mode 100644 docs/engine/getting-started/1-index.mdx delete mode 100644 docs/engine/getting-started/documentation.mdx delete mode 100644 docs/engine/getting-started/how_to_use.mdx delete mode 100644 docs/engine/network/index.mdx delete mode 100644 docs/engine/network/network-client-api.mdx delete mode 100644 docs/engine/network/network-client.mdx delete mode 100644 docs/engine/network/network-server-api.mdx delete mode 100644 docs/engine/network/network-server.mdx delete mode 100644 docs/engine/network/packet-framing.mdx delete mode 100644 docs/engine/registry/index.mdx delete mode 100644 docs/engine/registry/writing_web_assembly.mdx delete mode 100644 guides/cli/cli/1-overview.mdx delete mode 100644 guides/cli/cli/2-create-a-project.mdx delete mode 100644 guides/cli/cli/3-develop-locally.mdx delete mode 100644 guides/cli/cli/4-build-and-deploy.mdx delete mode 100644 guides/cli/cli/5-components-and-systems.mdx delete mode 100644 guides/cli/cli/6-publish-a-package.mdx create mode 100644 index.mdx delete mode 100644 references/1.3.0/.tsdocs/client/ValidRefs.js delete mode 100644 references/1.3.0/.tsdocs/client/tsdocs-config.js delete mode 100644 references/1.3.0/.tsdocs/client/tsdocs-styles.css delete mode 100644 references/1.3.0/.tsdocs/global.d.ts delete mode 100644 references/1.3.0/asset-manager/asset-manager.mdx delete mode 100644 references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary.mdx delete mode 100644 references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__init.mdx delete mode 100644 references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__name.mdx delete mode 100644 references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.3.0/asset-manager/index.mdx delete mode 100644 references/1.3.0/common/common.mdx delete mode 100644 references/1.3.0/common/common/ASSET_MANAGER_LIBRARY.mdx delete mode 100644 references/1.3.0/common/common/ApplicationContext.mdx delete mode 100644 references/1.3.0/common/common/ApplicationContext/_delta.mdx delete mode 100644 references/1.3.0/common/common/ApplicationContext/delta.mdx delete mode 100644 references/1.3.0/common/common/ApplicationContext/isRunning.mdx delete mode 100644 references/1.3.0/common/common/ApplicationContext/muteSoundLibraries.mdx delete mode 100644 references/1.3.0/common/common/ApplicationContext/setIsRunning.mdx delete mode 100644 references/1.3.0/common/common/BaseAssetManagerLibrary.mdx delete mode 100644 references/1.3.0/common/common/BaseAssetManagerLibrary/__init.mdx delete mode 100644 references/1.3.0/common/common/BaseAssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.3.0/common/common/BaseComponentSystemLibrary.mdx delete mode 100644 references/1.3.0/common/common/BaseComponentSystemLibrary/__run.mdx delete mode 100644 references/1.3.0/common/common/BaseGraphicsLibrary.mdx delete mode 100644 references/1.3.0/common/common/BaseGraphicsLibrary/__run.mdx delete mode 100644 references/1.3.0/common/common/BaseInputLibrary.mdx delete mode 100644 references/1.3.0/common/common/BaseInputLibrary/__run.mdx delete mode 100644 references/1.3.0/common/common/BaseMusicLibrary.mdx delete mode 100644 references/1.3.0/common/common/BaseMusicLibrary/__init.mdx delete mode 100644 references/1.3.0/common/common/BaseMusicLibrary/mute.mdx delete mode 100644 references/1.3.0/common/common/BaseMusicLibrary/play.mdx delete mode 100644 references/1.3.0/common/common/BaseNetworkLibrary.mdx delete mode 100644 references/1.3.0/common/common/BaseSoundLibrary.mdx delete mode 100644 references/1.3.0/common/common/BaseSoundLibrary/__init.mdx delete mode 100644 references/1.3.0/common/common/BaseSoundLibrary/mute.mdx delete mode 100644 references/1.3.0/common/common/BaseSoundLibrary/play.mdx delete mode 100644 references/1.3.0/common/common/COMPONENT_SYSTEM_LIBRARY.mdx delete mode 100644 references/1.3.0/common/common/ClearContext.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/constructor.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/get.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/getAssetManager.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/getComponentSystem.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/getGraphics.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/getInput.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/getMusic.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/getNetwork.mdx delete mode 100644 references/1.3.0/common/common/ClientLibraryManager/getSound.mdx delete mode 100644 references/1.3.0/common/common/Context.mdx delete mode 100644 references/1.3.0/common/common/Context/app.mdx delete mode 100644 references/1.3.0/common/common/Context/constructor.mdx delete mode 100644 references/1.3.0/common/common/Context/libs.mdx delete mode 100644 references/1.3.0/common/common/DefaultLibrariesEnum.mdx delete mode 100644 references/1.3.0/common/common/ExecutionContext.mdx delete mode 100644 references/1.3.0/common/common/GRAPHICS_LIBRARY.mdx delete mode 100644 references/1.3.0/common/common/IAssetManagerLibrary.mdx delete mode 100644 references/1.3.0/common/common/IAssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.3.0/common/common/IComponentSystemLibrary.mdx delete mode 100644 references/1.3.0/common/common/IConfigRegistry.mdx delete mode 100644 references/1.3.0/common/common/IConfigRegistry/registerConfig.mdx delete mode 100644 references/1.3.0/common/common/IExposedLibrary.mdx delete mode 100644 references/1.3.0/common/common/IGraphicsLibrary.mdx delete mode 100644 references/1.3.0/common/common/IInputLibrary.mdx delete mode 100644 references/1.3.0/common/common/ILibrary.mdx delete mode 100644 references/1.3.0/common/common/ILibrary/__clear.mdx delete mode 100644 references/1.3.0/common/common/ILibrary/__init.mdx delete mode 100644 references/1.3.0/common/common/ILibrary/__name.mdx delete mode 100644 references/1.3.0/common/common/ILibrary/__relationship.mdx delete mode 100644 references/1.3.0/common/common/IMusicLibrary.mdx delete mode 100644 references/1.3.0/common/common/IMutableLibrary.mdx delete mode 100644 references/1.3.0/common/common/IMutableLibrary/mute.mdx delete mode 100644 references/1.3.0/common/common/INPUT_LIBRARY.mdx delete mode 100644 references/1.3.0/common/common/INetworkLibrary.mdx delete mode 100644 references/1.3.0/common/common/IRunClientOptions.mdx delete mode 100644 references/1.3.0/common/common/IRunClientOptions/container.mdx delete mode 100644 references/1.3.0/common/common/IRunClientOptions/env.mdx delete mode 100644 references/1.3.0/common/common/IRunClientOptions/files.mdx delete mode 100644 references/1.3.0/common/common/IRunOptions.mdx delete mode 100644 references/1.3.0/common/common/IRunServerOptions.mdx delete mode 100644 references/1.3.0/common/common/IRunServerOptions/env.mdx delete mode 100644 references/1.3.0/common/common/IRunServerOptions/files.mdx delete mode 100644 references/1.3.0/common/common/IRunnerLibrary.mdx delete mode 100644 references/1.3.0/common/common/IRunnerLibrary/__run.mdx delete mode 100644 references/1.3.0/common/common/ISoundLibrary.mdx delete mode 100644 references/1.3.0/common/common/InitContext.mdx delete mode 100644 references/1.3.0/common/common/InitContext/config.mdx delete mode 100644 references/1.3.0/common/common/InitContext/constructor.mdx delete mode 100644 references/1.3.0/common/common/InitContext/container.mdx delete mode 100644 references/1.3.0/common/common/InitContext/env.mdx delete mode 100644 references/1.3.0/common/common/InitContext/files.mdx delete mode 100644 references/1.3.0/common/common/LibraryContext.mdx delete mode 100644 references/1.3.0/common/common/LibraryContext/_status.mdx delete mode 100644 references/1.3.0/common/common/LibraryContext/status.mdx delete mode 100644 references/1.3.0/common/common/LibraryHandle.mdx delete mode 100644 references/1.3.0/common/common/LibraryHandle/constructor.mdx delete mode 100644 references/1.3.0/common/common/LibraryHandle/context.mdx delete mode 100644 references/1.3.0/common/common/LibraryHandle/library.mdx delete mode 100644 references/1.3.0/common/common/LibraryHandle/symbol.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager/constructor.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager/getAssetManager.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager/getComponentSystem.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager/getGraphics.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager/getInput.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager/getMusic.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager/getNetwork.mdx delete mode 100644 references/1.3.0/common/common/LibraryManager/getSound.mdx delete mode 100644 references/1.3.0/common/common/LibraryStatusEnum.mdx delete mode 100644 references/1.3.0/common/common/MUSIC_LIBRARY.mdx delete mode 100644 references/1.3.0/common/common/NETWORK_LIBRARY.mdx delete mode 100644 references/1.3.0/common/common/NfConfigException.mdx delete mode 100644 references/1.3.0/common/common/NfConfigException/code.mdx delete mode 100644 references/1.3.0/common/common/NfConfigException/constructor.mdx delete mode 100644 references/1.3.0/common/common/NfFetchException.mdx delete mode 100644 references/1.3.0/common/common/NfFetchException/code.mdx delete mode 100644 references/1.3.0/common/common/NfFetchException/constructor.mdx delete mode 100644 references/1.3.0/common/common/NfFile.mdx delete mode 100644 references/1.3.0/common/common/NfFile/arrayBuffer.mdx delete mode 100644 references/1.3.0/common/common/NfFile/blob.mdx delete mode 100644 references/1.3.0/common/common/NfFile/bytes.mdx delete mode 100644 references/1.3.0/common/common/NfFile/constructor.mdx delete mode 100644 references/1.3.0/common/common/NfFile/formData.mdx delete mode 100644 references/1.3.0/common/common/NfFile/json.mdx delete mode 100644 references/1.3.0/common/common/NfFile/path.mdx delete mode 100644 references/1.3.0/common/common/NfFile/text.mdx delete mode 100644 references/1.3.0/common/common/NfNotFound.mdx delete mode 100644 references/1.3.0/common/common/NfNotFound/code.mdx delete mode 100644 references/1.3.0/common/common/NfNotFound/constructor.mdx delete mode 100644 references/1.3.0/common/common/NfNotInitializedException.mdx delete mode 100644 references/1.3.0/common/common/NfNotInitializedException/code.mdx delete mode 100644 references/1.3.0/common/common/NfNotInitializedException/constructor.mdx delete mode 100644 references/1.3.0/common/common/SOUND_LIBRARY.mdx delete mode 100644 references/1.3.0/common/index.mdx delete mode 100644 references/1.3.0/config/config.mdx delete mode 100644 references/1.3.0/config/config/Default.mdx delete mode 100644 references/1.3.0/config/config/IsIpOrFQDN.mdx delete mode 100644 references/1.3.0/config/config/TransformToBoolean.mdx delete mode 100644 references/1.3.0/config/index.mdx delete mode 100644 references/1.3.0/core-editor/core-editor.mdx delete mode 100644 references/1.3.0/core-editor/core-editor/NanoforgeClient.mdx delete mode 100644 references/1.3.0/core-editor/core-editor/NanoforgeClient/useGraphics.mdx delete mode 100644 references/1.3.0/core-editor/core-editor/NanoforgeClient/useInput.mdx delete mode 100644 references/1.3.0/core-editor/core-editor/NanoforgeClient/useSound.mdx delete mode 100644 references/1.3.0/core-editor/core-editor/NanoforgeFactory.mdx delete mode 100644 references/1.3.0/core-editor/core-editor/NanoforgeServer.mdx delete mode 100644 references/1.3.0/core-editor/index.mdx delete mode 100644 references/1.3.0/core/core.mdx delete mode 100644 references/1.3.0/core/core/NanoforgeClient.mdx delete mode 100644 references/1.3.0/core/core/NanoforgeClient/useGraphics.mdx delete mode 100644 references/1.3.0/core/core/NanoforgeClient/useInput.mdx delete mode 100644 references/1.3.0/core/core/NanoforgeClient/useSound.mdx delete mode 100644 references/1.3.0/core/core/NanoforgeFactory.mdx delete mode 100644 references/1.3.0/core/core/NanoforgeServer.mdx delete mode 100644 references/1.3.0/core/index.mdx delete mode 100644 references/1.3.0/ecs-client/ecs-client.mdx delete mode 100644 references/1.3.0/ecs-client/ecs-client/ECSClientLibrary.mdx delete mode 100644 references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__init.mdx delete mode 100644 references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__name.mdx delete mode 100644 references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/constructor.mdx delete mode 100644 references/1.3.0/ecs-client/index.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__name.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__run.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/_registry.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/constructor.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/module.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/path.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/registry.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Component.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/EditorComponentManifest.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/EditorSystemManifest.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Entity.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Entity/getId.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/addComponent.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/addSystem.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/clearEntities.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/clearSystems.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/entityFromIndex.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/getComponents.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/getComponentsConst.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponent.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponentConst.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/getZipper.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/killEntity.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/maxEntities.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/registerComponent.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/removeComponent.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/removeSystem.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/runSystems.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/Registry/spawnEntity.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/clear.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/empty.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/erase.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/get.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/getConst.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/getIndex.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt_1.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/resize.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/set.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByCopy.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByMove.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/SparseArray/size.mdx delete mode 100644 references/1.3.0/ecs-lib/ecs-lib/System.mdx delete mode 100644 references/1.3.0/ecs-lib/index.mdx delete mode 100644 references/1.3.0/ecs-server/ecs-server.mdx delete mode 100644 references/1.3.0/ecs-server/ecs-server/ECSServerLibrary.mdx delete mode 100644 references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__init.mdx delete mode 100644 references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__name.mdx delete mode 100644 references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/constructor.mdx delete mode 100644 references/1.3.0/ecs-server/ecs-server/Module.mdx delete mode 100644 references/1.3.0/ecs-server/index.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Animation_2.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Arc.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/ArcConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Arrow.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/ArrowConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Canvas.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Circle.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/CircleConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Container.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/ContainerConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Context.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/DD.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Easings.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Ellipse.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/EllipseConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/FastLayer.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Filters.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__init.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__name.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__run.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/baseLayer.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/stage.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Group.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/GroupConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/ImageConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Image_2.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/KonvaEventListener.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/KonvaEventObject.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/KonvaPointerEvent.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Label.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/LabelConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Layer.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/LayerConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Line.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/LineConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/NodeConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Node_2.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Path.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/PathConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Rect.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/RectConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/RegularPolygon.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/RegularPolygonConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Ring.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/RingConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Shape.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/ShapeConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Sprite.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/SpriteConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Stage.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/StageConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Star.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/StarConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Tag.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/TagConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/TextConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/TextPath.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/TextPathConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Text_2.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Transform.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/TransformerConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Transformer_2.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Tween.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/TweenConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Util.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Vector2d.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/Wedge.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/WedgeConfig.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_global.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_injectGlobal.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_mouseDblClickPointerId.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_mouseInDblClickWindow.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_mouseListenClick.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_pointerDblClickPointerId.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_pointerInDblClickWindow.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_pointerListenClick.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_renderBackend.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_touchDblClickPointerId.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_touchInDblClickWindow.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/_touchListenClick.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/angleDeg.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/autoDrawEnabled.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/capturePointerEventsEnabled.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/dblClickWindow.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/document_2.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/dragButtons.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/dragDistance.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/enableTrace.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/getAngle.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/hitOnDragEnabled.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/isBrowser.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/isDragReady.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/isDragging.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/isTransforming.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/isUnminified.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/legacyTextRendering.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/pixelRatio.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/pointerEventsEnabled.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/releaseCanvasOnDestroy.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/shapes.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/showWarnings.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/stages.mdx delete mode 100644 references/1.3.0/graphics-2d/graphics-2d/version.mdx delete mode 100644 references/1.3.0/graphics-2d/index.mdx delete mode 100644 references/1.3.0/input/index.mdx delete mode 100644 references/1.3.0/input/input.mdx delete mode 100644 references/1.3.0/input/input/InputEnum.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/__init.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/__name.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/__run.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/constructor.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/getDragState.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/getMousePosition.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/getMouseState.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/getPressedKeys.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/getWheelState.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/isDragging.mdx delete mode 100644 references/1.3.0/input/input/InputLibrary/isKeyPressed.mdx delete mode 100644 references/1.3.0/music/index.mdx delete mode 100644 references/1.3.0/music/music.mdx delete mode 100644 references/1.3.0/music/music/MusicLibrary.mdx delete mode 100644 references/1.3.0/music/music/MusicLibrary/__init.mdx delete mode 100644 references/1.3.0/music/music/MusicLibrary/__name.mdx delete mode 100644 references/1.3.0/music/music/MusicLibrary/load.mdx delete mode 100644 references/1.3.0/music/music/MusicLibrary/mute.mdx delete mode 100644 references/1.3.0/music/music/MusicLibrary/play.mdx delete mode 100644 references/1.3.0/network-client/index.mdx delete mode 100644 references/1.3.0/network-client/network-client.mdx delete mode 100644 references/1.3.0/network-client/network-client/NetworkClientLibrary.mdx delete mode 100644 references/1.3.0/network-client/network-client/NetworkClientLibrary/__init.mdx delete mode 100644 references/1.3.0/network-client/network-client/NetworkClientLibrary/__name.mdx delete mode 100644 references/1.3.0/network-client/network-client/NetworkClientLibrary/tcp.mdx delete mode 100644 references/1.3.0/network-client/network-client/NetworkClientLibrary/udp.mdx delete mode 100644 references/1.3.0/network-client/network-client/TCPClient.mdx delete mode 100644 references/1.3.0/network-client/network-client/TCPClient/connect.mdx delete mode 100644 references/1.3.0/network-client/network-client/TCPClient/constructor.mdx delete mode 100644 references/1.3.0/network-client/network-client/TCPClient/getReceivedPackets.mdx delete mode 100644 references/1.3.0/network-client/network-client/TCPClient/isConnected.mdx delete mode 100644 references/1.3.0/network-client/network-client/TCPClient/sendData.mdx delete mode 100644 references/1.3.0/network-client/network-client/UDPClient.mdx delete mode 100644 references/1.3.0/network-client/network-client/UDPClient/connect.mdx delete mode 100644 references/1.3.0/network-client/network-client/UDPClient/constructor.mdx delete mode 100644 references/1.3.0/network-client/network-client/UDPClient/getReceivedPackets.mdx delete mode 100644 references/1.3.0/network-client/network-client/UDPClient/isConnected.mdx delete mode 100644 references/1.3.0/network-client/network-client/UDPClient/sendData.mdx delete mode 100644 references/1.3.0/network-server/index.mdx delete mode 100644 references/1.3.0/network-server/network-server.mdx delete mode 100644 references/1.3.0/network-server/network-server/NetworkServerLibrary.mdx delete mode 100644 references/1.3.0/network-server/network-server/NetworkServerLibrary/__init.mdx delete mode 100644 references/1.3.0/network-server/network-server/NetworkServerLibrary/__name.mdx delete mode 100644 references/1.3.0/network-server/network-server/NetworkServerLibrary/tcp.mdx delete mode 100644 references/1.3.0/network-server/network-server/NetworkServerLibrary/udp.mdx delete mode 100644 references/1.3.0/network-server/network-server/TCPServer.mdx delete mode 100644 references/1.3.0/network-server/network-server/TCPServer/constructor.mdx delete mode 100644 references/1.3.0/network-server/network-server/TCPServer/getConnectedClients.mdx delete mode 100644 references/1.3.0/network-server/network-server/TCPServer/getReceivedPackets.mdx delete mode 100644 references/1.3.0/network-server/network-server/TCPServer/listen.mdx delete mode 100644 references/1.3.0/network-server/network-server/TCPServer/sendToClient.mdx delete mode 100644 references/1.3.0/network-server/network-server/TCPServer/sendToEverybody.mdx delete mode 100644 references/1.3.0/network-server/network-server/UDPServer.mdx delete mode 100644 references/1.3.0/network-server/network-server/UDPServer/constructor.mdx delete mode 100644 references/1.3.0/network-server/network-server/UDPServer/getConnectedClients.mdx delete mode 100644 references/1.3.0/network-server/network-server/UDPServer/getReceivedPackets.mdx delete mode 100644 references/1.3.0/network-server/network-server/UDPServer/listen.mdx delete mode 100644 references/1.3.0/network-server/network-server/UDPServer/sendToClient.mdx delete mode 100644 references/1.3.0/network-server/network-server/UDPServer/sendToEverybody.mdx delete mode 100644 references/1.3.0/sound/index.mdx delete mode 100644 references/1.3.0/sound/sound.mdx delete mode 100644 references/1.3.0/sound/sound/SoundLibrary.mdx delete mode 100644 references/1.3.0/sound/sound/SoundLibrary/__init.mdx delete mode 100644 references/1.3.0/sound/sound/SoundLibrary/__name.mdx delete mode 100644 references/1.3.0/sound/sound/SoundLibrary/load.mdx delete mode 100644 references/1.3.0/sound/sound/SoundLibrary/mute.mdx delete mode 100644 references/1.3.0/sound/sound/SoundLibrary/play.mdx delete mode 100644 references/1.4.0/.tsdocs/client/ValidRefs.js delete mode 100644 references/1.4.0/.tsdocs/client/tsdocs-config.js delete mode 100644 references/1.4.0/.tsdocs/client/tsdocs-styles.css delete mode 100644 references/1.4.0/.tsdocs/global.d.ts delete mode 100644 references/1.4.0/asset-manager/0-index.mdx delete mode 100644 references/1.4.0/asset-manager/AssetManagerLibrary.mdx delete mode 100644 references/1.4.0/asset-manager/AssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.0/asset-manager/AssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.0/common/0-index.mdx delete mode 100644 references/1.4.0/common/ASSET_MANAGER_LIBRARY.mdx delete mode 100644 references/1.4.0/common/ApplicationContext.mdx delete mode 100644 references/1.4.0/common/ApplicationContext/delta.mdx delete mode 100644 references/1.4.0/common/ApplicationContext/isRunning.mdx delete mode 100644 references/1.4.0/common/BaseAssetManagerLibrary.mdx delete mode 100644 references/1.4.0/common/BaseAssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.0/common/BaseAssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.0/common/BaseComponentSystemLibrary.mdx delete mode 100644 references/1.4.0/common/BaseGraphicsLibrary.mdx delete mode 100644 references/1.4.0/common/BaseInputLibrary.mdx delete mode 100644 references/1.4.0/common/BaseMusicLibrary.mdx delete mode 100644 references/1.4.0/common/BaseMusicLibrary/mute.mdx delete mode 100644 references/1.4.0/common/BaseMusicLibrary/play.mdx delete mode 100644 references/1.4.0/common/BaseNetworkLibrary.mdx delete mode 100644 references/1.4.0/common/BaseSoundLibrary.mdx delete mode 100644 references/1.4.0/common/BaseSoundLibrary/mute.mdx delete mode 100644 references/1.4.0/common/BaseSoundLibrary/play.mdx delete mode 100644 references/1.4.0/common/COMPONENT_SYSTEM_LIBRARY.mdx delete mode 100644 references/1.4.0/common/ClearContext.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/constructor.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/get.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/getAssetManager.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/getComponentSystem.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/getGraphics.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/getInput.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/getMusic.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/getNetwork.mdx delete mode 100644 references/1.4.0/common/ClientLibraryManager/getSound.mdx delete mode 100644 references/1.4.0/common/Context.mdx delete mode 100644 references/1.4.0/common/Context/app.mdx delete mode 100644 references/1.4.0/common/Context/constructor.mdx delete mode 100644 references/1.4.0/common/Context/libs.mdx delete mode 100644 references/1.4.0/common/DefaultLibrariesEnum.mdx delete mode 100644 references/1.4.0/common/ExecutionContext.mdx delete mode 100644 references/1.4.0/common/GRAPHICS_LIBRARY.mdx delete mode 100644 references/1.4.0/common/IAssetManagerLibrary.mdx delete mode 100644 references/1.4.0/common/IAssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.0/common/IAssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.0/common/IComponentSystemLibrary.mdx delete mode 100644 references/1.4.0/common/IConfigRegistry.mdx delete mode 100644 references/1.4.0/common/IConfigRegistry/registerConfig.mdx delete mode 100644 references/1.4.0/common/IExposedLibrary.mdx delete mode 100644 references/1.4.0/common/IGraphicsLibrary.mdx delete mode 100644 references/1.4.0/common/IInputLibrary.mdx delete mode 100644 references/1.4.0/common/ILibrary.mdx delete mode 100644 references/1.4.0/common/IMusicLibrary.mdx delete mode 100644 references/1.4.0/common/IMutableLibrary.mdx delete mode 100644 references/1.4.0/common/IMutableLibrary/mute.mdx delete mode 100644 references/1.4.0/common/INPUT_LIBRARY.mdx delete mode 100644 references/1.4.0/common/INetworkLibrary.mdx delete mode 100644 references/1.4.0/common/IRunClientOptions.mdx delete mode 100644 references/1.4.0/common/IRunClientOptions/container.mdx delete mode 100644 references/1.4.0/common/IRunClientOptions/env.mdx delete mode 100644 references/1.4.0/common/IRunClientOptions/files.mdx delete mode 100644 references/1.4.0/common/IRunOptions.mdx delete mode 100644 references/1.4.0/common/IRunServerOptions.mdx delete mode 100644 references/1.4.0/common/IRunServerOptions/env.mdx delete mode 100644 references/1.4.0/common/IRunServerOptions/files.mdx delete mode 100644 references/1.4.0/common/IRunnerLibrary.mdx delete mode 100644 references/1.4.0/common/ISoundLibrary.mdx delete mode 100644 references/1.4.0/common/InitContext.mdx delete mode 100644 references/1.4.0/common/InitContext/config.mdx delete mode 100644 references/1.4.0/common/InitContext/constructor.mdx delete mode 100644 references/1.4.0/common/InitContext/container.mdx delete mode 100644 references/1.4.0/common/InitContext/env.mdx delete mode 100644 references/1.4.0/common/InitContext/files.mdx delete mode 100644 references/1.4.0/common/Library.mdx delete mode 100644 references/1.4.0/common/Library/_relationship.mdx delete mode 100644 references/1.4.0/common/Library/constructor.mdx delete mode 100644 references/1.4.0/common/LibraryContext.mdx delete mode 100644 references/1.4.0/common/LibraryContext/status.mdx delete mode 100644 references/1.4.0/common/LibraryHandle.mdx delete mode 100644 references/1.4.0/common/LibraryHandle/constructor.mdx delete mode 100644 references/1.4.0/common/LibraryHandle/context.mdx delete mode 100644 references/1.4.0/common/LibraryHandle/library.mdx delete mode 100644 references/1.4.0/common/LibraryHandle/symbol.mdx delete mode 100644 references/1.4.0/common/LibraryManager.mdx delete mode 100644 references/1.4.0/common/LibraryManager/constructor.mdx delete mode 100644 references/1.4.0/common/LibraryManager/getAssetManager.mdx delete mode 100644 references/1.4.0/common/LibraryManager/getComponentSystem.mdx delete mode 100644 references/1.4.0/common/LibraryManager/getGraphics.mdx delete mode 100644 references/1.4.0/common/LibraryManager/getInput.mdx delete mode 100644 references/1.4.0/common/LibraryManager/getMusic.mdx delete mode 100644 references/1.4.0/common/LibraryManager/getNetwork.mdx delete mode 100644 references/1.4.0/common/LibraryManager/getSound.mdx delete mode 100644 references/1.4.0/common/LibraryStatusEnum.mdx delete mode 100644 references/1.4.0/common/MUSIC_LIBRARY.mdx delete mode 100644 references/1.4.0/common/NETWORK_LIBRARY.mdx delete mode 100644 references/1.4.0/common/NfConfigException.mdx delete mode 100644 references/1.4.0/common/NfConfigException/code.mdx delete mode 100644 references/1.4.0/common/NfConfigException/constructor.mdx delete mode 100644 references/1.4.0/common/NfFetchException.mdx delete mode 100644 references/1.4.0/common/NfFetchException/code.mdx delete mode 100644 references/1.4.0/common/NfFetchException/constructor.mdx delete mode 100644 references/1.4.0/common/NfFile.mdx delete mode 100644 references/1.4.0/common/NfFile/arrayBuffer.mdx delete mode 100644 references/1.4.0/common/NfFile/blob.mdx delete mode 100644 references/1.4.0/common/NfFile/bytes.mdx delete mode 100644 references/1.4.0/common/NfFile/constructor.mdx delete mode 100644 references/1.4.0/common/NfFile/formData.mdx delete mode 100644 references/1.4.0/common/NfFile/json.mdx delete mode 100644 references/1.4.0/common/NfFile/path.mdx delete mode 100644 references/1.4.0/common/NfFile/text.mdx delete mode 100644 references/1.4.0/common/NfNotFound.mdx delete mode 100644 references/1.4.0/common/NfNotFound/code.mdx delete mode 100644 references/1.4.0/common/NfNotFound/constructor.mdx delete mode 100644 references/1.4.0/common/NfNotInitializedException.mdx delete mode 100644 references/1.4.0/common/NfNotInitializedException/code.mdx delete mode 100644 references/1.4.0/common/NfNotInitializedException/constructor.mdx delete mode 100644 references/1.4.0/common/SOUND_LIBRARY.mdx delete mode 100644 references/1.4.0/config/0-index.mdx delete mode 100644 references/1.4.0/config/Default.mdx delete mode 100644 references/1.4.0/config/IsIpOrFQDN.mdx delete mode 100644 references/1.4.0/config/TransformToBoolean.mdx delete mode 100644 references/1.4.0/core-editor/0-index.mdx delete mode 100644 references/1.4.0/core-editor/CoreEvents.mdx delete mode 100644 references/1.4.0/core-editor/EditorEvents.mdx delete mode 100644 references/1.4.0/core-editor/EventEmitter.mdx delete mode 100644 references/1.4.0/core-editor/EventEmitter/constructor.mdx delete mode 100644 references/1.4.0/core-editor/EventEmitter/emit.mdx delete mode 100644 references/1.4.0/core-editor/EventEmitter/on.mdx delete mode 100644 references/1.4.0/core-editor/EventEmitter/runEvents.mdx delete mode 100644 references/1.4.0/core-editor/NanoforgeClient.mdx delete mode 100644 references/1.4.0/core-editor/NanoforgeClient/useGraphics.mdx delete mode 100644 references/1.4.0/core-editor/NanoforgeClient/useInput.mdx delete mode 100644 references/1.4.0/core-editor/NanoforgeClient/useSound.mdx delete mode 100644 references/1.4.0/core-editor/NanoforgeFactory.mdx delete mode 100644 references/1.4.0/core-editor/NanoforgeServer.mdx delete mode 100644 references/1.4.0/core/0-index.mdx delete mode 100644 references/1.4.0/core/NanoforgeClient.mdx delete mode 100644 references/1.4.0/core/NanoforgeClient/useGraphics.mdx delete mode 100644 references/1.4.0/core/NanoforgeClient/useInput.mdx delete mode 100644 references/1.4.0/core/NanoforgeClient/useSound.mdx delete mode 100644 references/1.4.0/core/NanoforgeFactory.mdx delete mode 100644 references/1.4.0/core/NanoforgeServer.mdx delete mode 100644 references/1.4.0/ecs-client/0-index.mdx delete mode 100644 references/1.4.0/ecs-client/ECSClientLibrary.mdx delete mode 100644 references/1.4.0/ecs-client/ECSClientLibrary/constructor.mdx delete mode 100644 references/1.4.0/ecs-lib/0-index.mdx delete mode 100644 references/1.4.0/ecs-lib/AbstractECSLibrary.mdx delete mode 100644 references/1.4.0/ecs-lib/AbstractECSLibrary/_registry.mdx delete mode 100644 references/1.4.0/ecs-lib/AbstractECSLibrary/constructor.mdx delete mode 100644 references/1.4.0/ecs-lib/AbstractECSLibrary/module.mdx delete mode 100644 references/1.4.0/ecs-lib/AbstractECSLibrary/path.mdx delete mode 100644 references/1.4.0/ecs-lib/AbstractECSLibrary/registry.mdx delete mode 100644 references/1.4.0/ecs-lib/Component.mdx delete mode 100644 references/1.4.0/ecs-lib/EditorComponentManifest.mdx delete mode 100644 references/1.4.0/ecs-lib/EditorSystemManifest.mdx delete mode 100644 references/1.4.0/ecs-lib/Entity.mdx delete mode 100644 references/1.4.0/ecs-lib/Entity/getId.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/addComponent.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/addSystem.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/clearEntities.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/clearSystems.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/entityFromIndex.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/getComponents.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/getComponentsConst.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/getEntityComponent.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/getEntityComponentConst.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/getIndexedZipper.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/getZipper.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/killEntity.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/maxEntities.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/registerComponent.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/removeComponent.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/removeSystem.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/runSystems.mdx delete mode 100644 references/1.4.0/ecs-lib/Registry/spawnEntity.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/clear.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/empty.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/erase.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/get.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/getConst.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/getIndex.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/insertAt.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/insertAt_1.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/resize.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/set.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/setByCopy.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/setByMove.mdx delete mode 100644 references/1.4.0/ecs-lib/SparseArray/size.mdx delete mode 100644 references/1.4.0/ecs-lib/System.mdx delete mode 100644 references/1.4.0/ecs-server/0-index.mdx delete mode 100644 references/1.4.0/ecs-server/ECSServerLibrary.mdx delete mode 100644 references/1.4.0/ecs-server/ECSServerLibrary/constructor.mdx delete mode 100644 references/1.4.0/ecs-server/Module.mdx delete mode 100644 references/1.4.0/graphics-2d/0-index.mdx delete mode 100644 references/1.4.0/graphics-2d/Animation_2.mdx delete mode 100644 references/1.4.0/graphics-2d/Arc.mdx delete mode 100644 references/1.4.0/graphics-2d/ArcConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Arrow.mdx delete mode 100644 references/1.4.0/graphics-2d/ArrowConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Canvas.mdx delete mode 100644 references/1.4.0/graphics-2d/Circle.mdx delete mode 100644 references/1.4.0/graphics-2d/CircleConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Container.mdx delete mode 100644 references/1.4.0/graphics-2d/ContainerConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Context.mdx delete mode 100644 references/1.4.0/graphics-2d/DD.mdx delete mode 100644 references/1.4.0/graphics-2d/Easings.mdx delete mode 100644 references/1.4.0/graphics-2d/Ellipse.mdx delete mode 100644 references/1.4.0/graphics-2d/EllipseConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/FastLayer.mdx delete mode 100644 references/1.4.0/graphics-2d/Filters.mdx delete mode 100644 references/1.4.0/graphics-2d/Graphics2DLibrary.mdx delete mode 100644 references/1.4.0/graphics-2d/Graphics2DLibrary/baseLayer.mdx delete mode 100644 references/1.4.0/graphics-2d/Graphics2DLibrary/stage.mdx delete mode 100644 references/1.4.0/graphics-2d/Group.mdx delete mode 100644 references/1.4.0/graphics-2d/GroupConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/ImageConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Image_2.mdx delete mode 100644 references/1.4.0/graphics-2d/KonvaEventListener.mdx delete mode 100644 references/1.4.0/graphics-2d/KonvaEventObject.mdx delete mode 100644 references/1.4.0/graphics-2d/KonvaPointerEvent.mdx delete mode 100644 references/1.4.0/graphics-2d/Label.mdx delete mode 100644 references/1.4.0/graphics-2d/LabelConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Layer.mdx delete mode 100644 references/1.4.0/graphics-2d/LayerConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Line.mdx delete mode 100644 references/1.4.0/graphics-2d/LineConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/NodeConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Node_2.mdx delete mode 100644 references/1.4.0/graphics-2d/Path.mdx delete mode 100644 references/1.4.0/graphics-2d/PathConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Rect.mdx delete mode 100644 references/1.4.0/graphics-2d/RectConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/RegularPolygon.mdx delete mode 100644 references/1.4.0/graphics-2d/RegularPolygonConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Ring.mdx delete mode 100644 references/1.4.0/graphics-2d/RingConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Shape.mdx delete mode 100644 references/1.4.0/graphics-2d/ShapeConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Sprite.mdx delete mode 100644 references/1.4.0/graphics-2d/SpriteConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Stage.mdx delete mode 100644 references/1.4.0/graphics-2d/StageConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Star.mdx delete mode 100644 references/1.4.0/graphics-2d/StarConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Tag.mdx delete mode 100644 references/1.4.0/graphics-2d/TagConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/TextConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/TextPath.mdx delete mode 100644 references/1.4.0/graphics-2d/TextPathConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Text_2.mdx delete mode 100644 references/1.4.0/graphics-2d/Transform.mdx delete mode 100644 references/1.4.0/graphics-2d/TransformerConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Transformer_2.mdx delete mode 100644 references/1.4.0/graphics-2d/Tween.mdx delete mode 100644 references/1.4.0/graphics-2d/TweenConfig.mdx delete mode 100644 references/1.4.0/graphics-2d/Util.mdx delete mode 100644 references/1.4.0/graphics-2d/Vector2d.mdx delete mode 100644 references/1.4.0/graphics-2d/Wedge.mdx delete mode 100644 references/1.4.0/graphics-2d/WedgeConfig.mdx delete mode 100644 references/1.4.0/input/0-index.mdx delete mode 100644 references/1.4.0/input/InputEnum.mdx delete mode 100644 references/1.4.0/input/InputLibrary.mdx delete mode 100644 references/1.4.0/input/InputLibrary/constructor.mdx delete mode 100644 references/1.4.0/input/InputLibrary/getDragState.mdx delete mode 100644 references/1.4.0/input/InputLibrary/getMousePosition.mdx delete mode 100644 references/1.4.0/input/InputLibrary/getMouseState.mdx delete mode 100644 references/1.4.0/input/InputLibrary/getPressedKeys.mdx delete mode 100644 references/1.4.0/input/InputLibrary/getWheelState.mdx delete mode 100644 references/1.4.0/input/InputLibrary/isDragging.mdx delete mode 100644 references/1.4.0/input/InputLibrary/isKeyPressed.mdx delete mode 100644 references/1.4.0/music/0-index.mdx delete mode 100644 references/1.4.0/music/MusicLibrary.mdx delete mode 100644 references/1.4.0/music/MusicLibrary/load.mdx delete mode 100644 references/1.4.0/music/MusicLibrary/mute.mdx delete mode 100644 references/1.4.0/music/MusicLibrary/play.mdx delete mode 100644 references/1.4.0/network-client/0-index.mdx delete mode 100644 references/1.4.0/network-client/NetworkClientLibrary.mdx delete mode 100644 references/1.4.0/network-client/NetworkClientLibrary/tcp.mdx delete mode 100644 references/1.4.0/network-client/NetworkClientLibrary/udp.mdx delete mode 100644 references/1.4.0/network-client/TCPClient.mdx delete mode 100644 references/1.4.0/network-client/TCPClient/connect.mdx delete mode 100644 references/1.4.0/network-client/TCPClient/constructor.mdx delete mode 100644 references/1.4.0/network-client/TCPClient/getReceivedPackets.mdx delete mode 100644 references/1.4.0/network-client/TCPClient/isConnected.mdx delete mode 100644 references/1.4.0/network-client/TCPClient/sendData.mdx delete mode 100644 references/1.4.0/network-client/UDPClient.mdx delete mode 100644 references/1.4.0/network-client/UDPClient/connect.mdx delete mode 100644 references/1.4.0/network-client/UDPClient/constructor.mdx delete mode 100644 references/1.4.0/network-client/UDPClient/getReceivedPackets.mdx delete mode 100644 references/1.4.0/network-client/UDPClient/isConnected.mdx delete mode 100644 references/1.4.0/network-client/UDPClient/sendData.mdx delete mode 100644 references/1.4.0/network-server/0-index.mdx delete mode 100644 references/1.4.0/network-server/NetworkServerLibrary.mdx delete mode 100644 references/1.4.0/network-server/NetworkServerLibrary/tcp.mdx delete mode 100644 references/1.4.0/network-server/NetworkServerLibrary/udp.mdx delete mode 100644 references/1.4.0/network-server/TCPServer.mdx delete mode 100644 references/1.4.0/network-server/TCPServer/constructor.mdx delete mode 100644 references/1.4.0/network-server/TCPServer/getConnectedClients.mdx delete mode 100644 references/1.4.0/network-server/TCPServer/getReceivedPackets.mdx delete mode 100644 references/1.4.0/network-server/TCPServer/listen.mdx delete mode 100644 references/1.4.0/network-server/TCPServer/sendToClient.mdx delete mode 100644 references/1.4.0/network-server/TCPServer/sendToEverybody.mdx delete mode 100644 references/1.4.0/network-server/UDPServer.mdx delete mode 100644 references/1.4.0/network-server/UDPServer/constructor.mdx delete mode 100644 references/1.4.0/network-server/UDPServer/getConnectedClients.mdx delete mode 100644 references/1.4.0/network-server/UDPServer/getReceivedPackets.mdx delete mode 100644 references/1.4.0/network-server/UDPServer/listen.mdx delete mode 100644 references/1.4.0/network-server/UDPServer/sendToClient.mdx delete mode 100644 references/1.4.0/network-server/UDPServer/sendToEverybody.mdx delete mode 100644 references/1.4.0/sound/0-index.mdx delete mode 100644 references/1.4.0/sound/SoundLibrary.mdx delete mode 100644 references/1.4.0/sound/SoundLibrary/load.mdx delete mode 100644 references/1.4.0/sound/SoundLibrary/mute.mdx delete mode 100644 references/1.4.0/sound/SoundLibrary/play.mdx delete mode 100644 references/1.4.1/.tsdocs/client/ValidRefs.js delete mode 100644 references/1.4.1/.tsdocs/client/tsdocs-config.js delete mode 100644 references/1.4.1/.tsdocs/client/tsdocs-styles.css delete mode 100644 references/1.4.1/.tsdocs/global.d.ts delete mode 100644 references/1.4.1/asset-manager/0-index.mdx delete mode 100644 references/1.4.1/asset-manager/AssetManagerLibrary.mdx delete mode 100644 references/1.4.1/asset-manager/AssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.1/asset-manager/AssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.1/common/0-index.mdx delete mode 100644 references/1.4.1/common/ASSET_MANAGER_LIBRARY.mdx delete mode 100644 references/1.4.1/common/ApplicationContext.mdx delete mode 100644 references/1.4.1/common/ApplicationContext/delta.mdx delete mode 100644 references/1.4.1/common/ApplicationContext/isRunning.mdx delete mode 100644 references/1.4.1/common/BaseAssetManagerLibrary.mdx delete mode 100644 references/1.4.1/common/BaseAssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.1/common/BaseAssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.1/common/BaseComponentSystemLibrary.mdx delete mode 100644 references/1.4.1/common/BaseGraphicsLibrary.mdx delete mode 100644 references/1.4.1/common/BaseInputLibrary.mdx delete mode 100644 references/1.4.1/common/BaseMusicLibrary.mdx delete mode 100644 references/1.4.1/common/BaseMusicLibrary/mute.mdx delete mode 100644 references/1.4.1/common/BaseMusicLibrary/play.mdx delete mode 100644 references/1.4.1/common/BaseNetworkLibrary.mdx delete mode 100644 references/1.4.1/common/BaseSoundLibrary.mdx delete mode 100644 references/1.4.1/common/BaseSoundLibrary/mute.mdx delete mode 100644 references/1.4.1/common/BaseSoundLibrary/play.mdx delete mode 100644 references/1.4.1/common/COMPONENT_SYSTEM_LIBRARY.mdx delete mode 100644 references/1.4.1/common/ClearContext.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/constructor.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/get.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/getAssetManager.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/getComponentSystem.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/getGraphics.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/getInput.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/getMusic.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/getNetwork.mdx delete mode 100644 references/1.4.1/common/ClientLibraryManager/getSound.mdx delete mode 100644 references/1.4.1/common/Context.mdx delete mode 100644 references/1.4.1/common/Context/app.mdx delete mode 100644 references/1.4.1/common/Context/constructor.mdx delete mode 100644 references/1.4.1/common/Context/libs.mdx delete mode 100644 references/1.4.1/common/DefaultLibrariesEnum.mdx delete mode 100644 references/1.4.1/common/ExecutionContext.mdx delete mode 100644 references/1.4.1/common/GRAPHICS_LIBRARY.mdx delete mode 100644 references/1.4.1/common/IAssetManagerLibrary.mdx delete mode 100644 references/1.4.1/common/IAssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.1/common/IAssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.1/common/IComponentSystemLibrary.mdx delete mode 100644 references/1.4.1/common/IConfigRegistry.mdx delete mode 100644 references/1.4.1/common/IConfigRegistry/registerConfig.mdx delete mode 100644 references/1.4.1/common/IExposedLibrary.mdx delete mode 100644 references/1.4.1/common/IGraphicsLibrary.mdx delete mode 100644 references/1.4.1/common/IInputLibrary.mdx delete mode 100644 references/1.4.1/common/ILibrary.mdx delete mode 100644 references/1.4.1/common/IMusicLibrary.mdx delete mode 100644 references/1.4.1/common/IMutableLibrary.mdx delete mode 100644 references/1.4.1/common/IMutableLibrary/mute.mdx delete mode 100644 references/1.4.1/common/INPUT_LIBRARY.mdx delete mode 100644 references/1.4.1/common/INetworkLibrary.mdx delete mode 100644 references/1.4.1/common/IRunClientOptions.mdx delete mode 100644 references/1.4.1/common/IRunClientOptions/container.mdx delete mode 100644 references/1.4.1/common/IRunClientOptions/env.mdx delete mode 100644 references/1.4.1/common/IRunClientOptions/files.mdx delete mode 100644 references/1.4.1/common/IRunOptions.mdx delete mode 100644 references/1.4.1/common/IRunServerOptions.mdx delete mode 100644 references/1.4.1/common/IRunServerOptions/env.mdx delete mode 100644 references/1.4.1/common/IRunServerOptions/files.mdx delete mode 100644 references/1.4.1/common/IRunnerLibrary.mdx delete mode 100644 references/1.4.1/common/ISoundLibrary.mdx delete mode 100644 references/1.4.1/common/InitContext.mdx delete mode 100644 references/1.4.1/common/InitContext/config.mdx delete mode 100644 references/1.4.1/common/InitContext/constructor.mdx delete mode 100644 references/1.4.1/common/InitContext/container.mdx delete mode 100644 references/1.4.1/common/InitContext/env.mdx delete mode 100644 references/1.4.1/common/InitContext/files.mdx delete mode 100644 references/1.4.1/common/Library.mdx delete mode 100644 references/1.4.1/common/Library/_relationship.mdx delete mode 100644 references/1.4.1/common/Library/constructor.mdx delete mode 100644 references/1.4.1/common/LibraryContext.mdx delete mode 100644 references/1.4.1/common/LibraryContext/status.mdx delete mode 100644 references/1.4.1/common/LibraryHandle.mdx delete mode 100644 references/1.4.1/common/LibraryHandle/constructor.mdx delete mode 100644 references/1.4.1/common/LibraryHandle/context.mdx delete mode 100644 references/1.4.1/common/LibraryHandle/library.mdx delete mode 100644 references/1.4.1/common/LibraryHandle/symbol.mdx delete mode 100644 references/1.4.1/common/LibraryManager.mdx delete mode 100644 references/1.4.1/common/LibraryManager/constructor.mdx delete mode 100644 references/1.4.1/common/LibraryManager/getAssetManager.mdx delete mode 100644 references/1.4.1/common/LibraryManager/getComponentSystem.mdx delete mode 100644 references/1.4.1/common/LibraryManager/getGraphics.mdx delete mode 100644 references/1.4.1/common/LibraryManager/getInput.mdx delete mode 100644 references/1.4.1/common/LibraryManager/getMusic.mdx delete mode 100644 references/1.4.1/common/LibraryManager/getNetwork.mdx delete mode 100644 references/1.4.1/common/LibraryManager/getSound.mdx delete mode 100644 references/1.4.1/common/LibraryStatusEnum.mdx delete mode 100644 references/1.4.1/common/MUSIC_LIBRARY.mdx delete mode 100644 references/1.4.1/common/NETWORK_LIBRARY.mdx delete mode 100644 references/1.4.1/common/NfConfigException.mdx delete mode 100644 references/1.4.1/common/NfConfigException/code.mdx delete mode 100644 references/1.4.1/common/NfConfigException/constructor.mdx delete mode 100644 references/1.4.1/common/NfFetchException.mdx delete mode 100644 references/1.4.1/common/NfFetchException/code.mdx delete mode 100644 references/1.4.1/common/NfFetchException/constructor.mdx delete mode 100644 references/1.4.1/common/NfFile.mdx delete mode 100644 references/1.4.1/common/NfFile/arrayBuffer.mdx delete mode 100644 references/1.4.1/common/NfFile/blob.mdx delete mode 100644 references/1.4.1/common/NfFile/bytes.mdx delete mode 100644 references/1.4.1/common/NfFile/constructor.mdx delete mode 100644 references/1.4.1/common/NfFile/formData.mdx delete mode 100644 references/1.4.1/common/NfFile/json.mdx delete mode 100644 references/1.4.1/common/NfFile/path.mdx delete mode 100644 references/1.4.1/common/NfFile/text.mdx delete mode 100644 references/1.4.1/common/NfNotFound.mdx delete mode 100644 references/1.4.1/common/NfNotFound/code.mdx delete mode 100644 references/1.4.1/common/NfNotFound/constructor.mdx delete mode 100644 references/1.4.1/common/NfNotInitializedException.mdx delete mode 100644 references/1.4.1/common/NfNotInitializedException/code.mdx delete mode 100644 references/1.4.1/common/NfNotInitializedException/constructor.mdx delete mode 100644 references/1.4.1/common/SOUND_LIBRARY.mdx delete mode 100644 references/1.4.1/config/0-index.mdx delete mode 100644 references/1.4.1/config/Default.mdx delete mode 100644 references/1.4.1/config/IsIpOrURL.mdx delete mode 100644 references/1.4.1/config/TransformToBoolean.mdx delete mode 100644 references/1.4.1/core-editor/0-index.mdx delete mode 100644 references/1.4.1/core-editor/CoreEvents.mdx delete mode 100644 references/1.4.1/core-editor/EditorEvents.mdx delete mode 100644 references/1.4.1/core-editor/EventEmitter.mdx delete mode 100644 references/1.4.1/core-editor/EventEmitter/constructor.mdx delete mode 100644 references/1.4.1/core-editor/EventEmitter/emit.mdx delete mode 100644 references/1.4.1/core-editor/EventEmitter/on.mdx delete mode 100644 references/1.4.1/core-editor/EventEmitter/runEvents.mdx delete mode 100644 references/1.4.1/core-editor/NanoforgeClient.mdx delete mode 100644 references/1.4.1/core-editor/NanoforgeClient/useGraphics.mdx delete mode 100644 references/1.4.1/core-editor/NanoforgeClient/useInput.mdx delete mode 100644 references/1.4.1/core-editor/NanoforgeClient/useSound.mdx delete mode 100644 references/1.4.1/core-editor/NanoforgeFactory.mdx delete mode 100644 references/1.4.1/core-editor/NanoforgeServer.mdx delete mode 100644 references/1.4.1/core/0-index.mdx delete mode 100644 references/1.4.1/core/NanoforgeClient.mdx delete mode 100644 references/1.4.1/core/NanoforgeClient/useGraphics.mdx delete mode 100644 references/1.4.1/core/NanoforgeClient/useInput.mdx delete mode 100644 references/1.4.1/core/NanoforgeClient/useSound.mdx delete mode 100644 references/1.4.1/core/NanoforgeFactory.mdx delete mode 100644 references/1.4.1/core/NanoforgeServer.mdx delete mode 100644 references/1.4.1/ecs-client/0-index.mdx delete mode 100644 references/1.4.1/ecs-client/ECSClientLibrary.mdx delete mode 100644 references/1.4.1/ecs-client/ECSClientLibrary/constructor.mdx delete mode 100644 references/1.4.1/ecs-lib/0-index.mdx delete mode 100644 references/1.4.1/ecs-lib/AbstractECSLibrary.mdx delete mode 100644 references/1.4.1/ecs-lib/AbstractECSLibrary/_registry.mdx delete mode 100644 references/1.4.1/ecs-lib/AbstractECSLibrary/constructor.mdx delete mode 100644 references/1.4.1/ecs-lib/AbstractECSLibrary/module.mdx delete mode 100644 references/1.4.1/ecs-lib/AbstractECSLibrary/path.mdx delete mode 100644 references/1.4.1/ecs-lib/AbstractECSLibrary/registry.mdx delete mode 100644 references/1.4.1/ecs-lib/Component.mdx delete mode 100644 references/1.4.1/ecs-lib/EditorComponentManifest.mdx delete mode 100644 references/1.4.1/ecs-lib/EditorSystemManifest.mdx delete mode 100644 references/1.4.1/ecs-lib/Entity.mdx delete mode 100644 references/1.4.1/ecs-lib/Entity/getId.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/addComponent.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/addSystem.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/clearEntities.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/clearSystems.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/entityFromIndex.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/getComponents.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/getComponentsConst.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/getEntityComponent.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/getEntityComponentConst.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/getIndexedZipper.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/getZipper.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/killEntity.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/maxEntities.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/registerComponent.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/removeComponent.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/removeSystem.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/runSystems.mdx delete mode 100644 references/1.4.1/ecs-lib/Registry/spawnEntity.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/clear.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/empty.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/erase.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/get.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/getConst.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/getIndex.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/insertAt.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/insertAt_1.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/resize.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/set.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/setByCopy.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/setByMove.mdx delete mode 100644 references/1.4.1/ecs-lib/SparseArray/size.mdx delete mode 100644 references/1.4.1/ecs-lib/System.mdx delete mode 100644 references/1.4.1/ecs-server/0-index.mdx delete mode 100644 references/1.4.1/ecs-server/ECSServerLibrary.mdx delete mode 100644 references/1.4.1/ecs-server/ECSServerLibrary/constructor.mdx delete mode 100644 references/1.4.1/ecs-server/Module.mdx delete mode 100644 references/1.4.1/graphics-2d/0-index.mdx delete mode 100644 references/1.4.1/graphics-2d/Animation_2.mdx delete mode 100644 references/1.4.1/graphics-2d/Arc.mdx delete mode 100644 references/1.4.1/graphics-2d/ArcConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Arrow.mdx delete mode 100644 references/1.4.1/graphics-2d/ArrowConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Canvas.mdx delete mode 100644 references/1.4.1/graphics-2d/Circle.mdx delete mode 100644 references/1.4.1/graphics-2d/CircleConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Container.mdx delete mode 100644 references/1.4.1/graphics-2d/ContainerConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Context.mdx delete mode 100644 references/1.4.1/graphics-2d/DD.mdx delete mode 100644 references/1.4.1/graphics-2d/Easings.mdx delete mode 100644 references/1.4.1/graphics-2d/Ellipse.mdx delete mode 100644 references/1.4.1/graphics-2d/EllipseConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/FastLayer.mdx delete mode 100644 references/1.4.1/graphics-2d/Filters.mdx delete mode 100644 references/1.4.1/graphics-2d/Graphics2DLibrary.mdx delete mode 100644 references/1.4.1/graphics-2d/Graphics2DLibrary/baseLayer.mdx delete mode 100644 references/1.4.1/graphics-2d/Graphics2DLibrary/stage.mdx delete mode 100644 references/1.4.1/graphics-2d/Group.mdx delete mode 100644 references/1.4.1/graphics-2d/GroupConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/ImageConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Image_2.mdx delete mode 100644 references/1.4.1/graphics-2d/KonvaEventListener.mdx delete mode 100644 references/1.4.1/graphics-2d/KonvaEventObject.mdx delete mode 100644 references/1.4.1/graphics-2d/KonvaPointerEvent.mdx delete mode 100644 references/1.4.1/graphics-2d/Label.mdx delete mode 100644 references/1.4.1/graphics-2d/LabelConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Layer.mdx delete mode 100644 references/1.4.1/graphics-2d/LayerConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Line.mdx delete mode 100644 references/1.4.1/graphics-2d/LineConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/NodeConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Node_2.mdx delete mode 100644 references/1.4.1/graphics-2d/Path.mdx delete mode 100644 references/1.4.1/graphics-2d/PathConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Rect.mdx delete mode 100644 references/1.4.1/graphics-2d/RectConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/RegularPolygon.mdx delete mode 100644 references/1.4.1/graphics-2d/RegularPolygonConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Ring.mdx delete mode 100644 references/1.4.1/graphics-2d/RingConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Shape.mdx delete mode 100644 references/1.4.1/graphics-2d/ShapeConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Sprite.mdx delete mode 100644 references/1.4.1/graphics-2d/SpriteConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Stage.mdx delete mode 100644 references/1.4.1/graphics-2d/StageConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Star.mdx delete mode 100644 references/1.4.1/graphics-2d/StarConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Tag.mdx delete mode 100644 references/1.4.1/graphics-2d/TagConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/TextConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/TextPath.mdx delete mode 100644 references/1.4.1/graphics-2d/TextPathConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Text_2.mdx delete mode 100644 references/1.4.1/graphics-2d/Transform.mdx delete mode 100644 references/1.4.1/graphics-2d/TransformerConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Transformer_2.mdx delete mode 100644 references/1.4.1/graphics-2d/Tween.mdx delete mode 100644 references/1.4.1/graphics-2d/TweenConfig.mdx delete mode 100644 references/1.4.1/graphics-2d/Util.mdx delete mode 100644 references/1.4.1/graphics-2d/Vector2d.mdx delete mode 100644 references/1.4.1/graphics-2d/Wedge.mdx delete mode 100644 references/1.4.1/graphics-2d/WedgeConfig.mdx delete mode 100644 references/1.4.1/input/0-index.mdx delete mode 100644 references/1.4.1/input/InputEnum.mdx delete mode 100644 references/1.4.1/input/InputLibrary.mdx delete mode 100644 references/1.4.1/input/InputLibrary/constructor.mdx delete mode 100644 references/1.4.1/input/InputLibrary/getDragState.mdx delete mode 100644 references/1.4.1/input/InputLibrary/getMousePosition.mdx delete mode 100644 references/1.4.1/input/InputLibrary/getMouseState.mdx delete mode 100644 references/1.4.1/input/InputLibrary/getPressedKeys.mdx delete mode 100644 references/1.4.1/input/InputLibrary/getWheelState.mdx delete mode 100644 references/1.4.1/input/InputLibrary/isDragging.mdx delete mode 100644 references/1.4.1/input/InputLibrary/isKeyPressed.mdx delete mode 100644 references/1.4.1/music/0-index.mdx delete mode 100644 references/1.4.1/music/MusicLibrary.mdx delete mode 100644 references/1.4.1/music/MusicLibrary/load.mdx delete mode 100644 references/1.4.1/music/MusicLibrary/mute.mdx delete mode 100644 references/1.4.1/music/MusicLibrary/play.mdx delete mode 100644 references/1.4.1/network-client/0-index.mdx delete mode 100644 references/1.4.1/network-client/NetworkClientLibrary.mdx delete mode 100644 references/1.4.1/network-client/NetworkClientLibrary/tcp.mdx delete mode 100644 references/1.4.1/network-client/NetworkClientLibrary/udp.mdx delete mode 100644 references/1.4.1/network-client/TCPClient.mdx delete mode 100644 references/1.4.1/network-client/TCPClient/connect.mdx delete mode 100644 references/1.4.1/network-client/TCPClient/constructor.mdx delete mode 100644 references/1.4.1/network-client/TCPClient/getReceivedPackets.mdx delete mode 100644 references/1.4.1/network-client/TCPClient/isConnected.mdx delete mode 100644 references/1.4.1/network-client/TCPClient/sendData.mdx delete mode 100644 references/1.4.1/network-client/UDPClient.mdx delete mode 100644 references/1.4.1/network-client/UDPClient/connect.mdx delete mode 100644 references/1.4.1/network-client/UDPClient/constructor.mdx delete mode 100644 references/1.4.1/network-client/UDPClient/getReceivedPackets.mdx delete mode 100644 references/1.4.1/network-client/UDPClient/isConnected.mdx delete mode 100644 references/1.4.1/network-client/UDPClient/sendData.mdx delete mode 100644 references/1.4.1/network-server/0-index.mdx delete mode 100644 references/1.4.1/network-server/NetworkServerLibrary.mdx delete mode 100644 references/1.4.1/network-server/NetworkServerLibrary/tcp.mdx delete mode 100644 references/1.4.1/network-server/NetworkServerLibrary/udp.mdx delete mode 100644 references/1.4.1/network-server/TCPServer.mdx delete mode 100644 references/1.4.1/network-server/TCPServer/constructor.mdx delete mode 100644 references/1.4.1/network-server/TCPServer/getConnectedClients.mdx delete mode 100644 references/1.4.1/network-server/TCPServer/getReceivedPackets.mdx delete mode 100644 references/1.4.1/network-server/TCPServer/listen.mdx delete mode 100644 references/1.4.1/network-server/TCPServer/sendToClient.mdx delete mode 100644 references/1.4.1/network-server/TCPServer/sendToEverybody.mdx delete mode 100644 references/1.4.1/network-server/UDPServer.mdx delete mode 100644 references/1.4.1/network-server/UDPServer/constructor.mdx delete mode 100644 references/1.4.1/network-server/UDPServer/getConnectedClients.mdx delete mode 100644 references/1.4.1/network-server/UDPServer/getReceivedPackets.mdx delete mode 100644 references/1.4.1/network-server/UDPServer/listen.mdx delete mode 100644 references/1.4.1/network-server/UDPServer/sendToClient.mdx delete mode 100644 references/1.4.1/network-server/UDPServer/sendToEverybody.mdx delete mode 100644 references/1.4.1/sound/0-index.mdx delete mode 100644 references/1.4.1/sound/SoundLibrary.mdx delete mode 100644 references/1.4.1/sound/SoundLibrary/load.mdx delete mode 100644 references/1.4.1/sound/SoundLibrary/mute.mdx delete mode 100644 references/1.4.1/sound/SoundLibrary/play.mdx delete mode 100644 references/1.4.2/.tsdocs/client/ValidRefs.js delete mode 100644 references/1.4.2/.tsdocs/client/tsdocs-config.js delete mode 100644 references/1.4.2/.tsdocs/client/tsdocs-styles.css delete mode 100644 references/1.4.2/.tsdocs/global.d.ts delete mode 100644 references/1.4.2/asset-manager/0-index.mdx delete mode 100644 references/1.4.2/asset-manager/AssetManagerLibrary.mdx delete mode 100644 references/1.4.2/asset-manager/AssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.2/asset-manager/AssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.2/common/0-index.mdx delete mode 100644 references/1.4.2/common/ASSET_MANAGER_LIBRARY.mdx delete mode 100644 references/1.4.2/common/ApplicationContext.mdx delete mode 100644 references/1.4.2/common/ApplicationContext/delta.mdx delete mode 100644 references/1.4.2/common/ApplicationContext/isRunning.mdx delete mode 100644 references/1.4.2/common/BaseAssetManagerLibrary.mdx delete mode 100644 references/1.4.2/common/BaseAssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.2/common/BaseAssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.2/common/BaseComponentSystemLibrary.mdx delete mode 100644 references/1.4.2/common/BaseGraphicsLibrary.mdx delete mode 100644 references/1.4.2/common/BaseInputLibrary.mdx delete mode 100644 references/1.4.2/common/BaseMusicLibrary.mdx delete mode 100644 references/1.4.2/common/BaseMusicLibrary/mute.mdx delete mode 100644 references/1.4.2/common/BaseMusicLibrary/play.mdx delete mode 100644 references/1.4.2/common/BaseNetworkLibrary.mdx delete mode 100644 references/1.4.2/common/BaseSoundLibrary.mdx delete mode 100644 references/1.4.2/common/BaseSoundLibrary/mute.mdx delete mode 100644 references/1.4.2/common/BaseSoundLibrary/play.mdx delete mode 100644 references/1.4.2/common/COMPONENT_SYSTEM_LIBRARY.mdx delete mode 100644 references/1.4.2/common/ClearContext.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/constructor.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/get.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/getAssetManager.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/getComponentSystem.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/getGraphics.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/getInput.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/getMusic.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/getNetwork.mdx delete mode 100644 references/1.4.2/common/ClientLibraryManager/getSound.mdx delete mode 100644 references/1.4.2/common/Context.mdx delete mode 100644 references/1.4.2/common/Context/app.mdx delete mode 100644 references/1.4.2/common/Context/constructor.mdx delete mode 100644 references/1.4.2/common/Context/libs.mdx delete mode 100644 references/1.4.2/common/DefaultLibrariesEnum.mdx delete mode 100644 references/1.4.2/common/ExecutionContext.mdx delete mode 100644 references/1.4.2/common/GRAPHICS_LIBRARY.mdx delete mode 100644 references/1.4.2/common/IAssetManagerLibrary.mdx delete mode 100644 references/1.4.2/common/IAssetManagerLibrary/getAsset.mdx delete mode 100644 references/1.4.2/common/IAssetManagerLibrary/getAsset_1.mdx delete mode 100644 references/1.4.2/common/IComponentSystemLibrary.mdx delete mode 100644 references/1.4.2/common/IConfigRegistry.mdx delete mode 100644 references/1.4.2/common/IConfigRegistry/registerConfig.mdx delete mode 100644 references/1.4.2/common/IExposedLibrary.mdx delete mode 100644 references/1.4.2/common/IGraphicsLibrary.mdx delete mode 100644 references/1.4.2/common/IInputLibrary.mdx delete mode 100644 references/1.4.2/common/ILibrary.mdx delete mode 100644 references/1.4.2/common/IMusicLibrary.mdx delete mode 100644 references/1.4.2/common/IMutableLibrary.mdx delete mode 100644 references/1.4.2/common/IMutableLibrary/mute.mdx delete mode 100644 references/1.4.2/common/INPUT_LIBRARY.mdx delete mode 100644 references/1.4.2/common/INetworkLibrary.mdx delete mode 100644 references/1.4.2/common/IRunClientOptions.mdx delete mode 100644 references/1.4.2/common/IRunClientOptions/container.mdx delete mode 100644 references/1.4.2/common/IRunClientOptions/env.mdx delete mode 100644 references/1.4.2/common/IRunClientOptions/files.mdx delete mode 100644 references/1.4.2/common/IRunOptions.mdx delete mode 100644 references/1.4.2/common/IRunServerOptions.mdx delete mode 100644 references/1.4.2/common/IRunServerOptions/env.mdx delete mode 100644 references/1.4.2/common/IRunServerOptions/files.mdx delete mode 100644 references/1.4.2/common/IRunnerLibrary.mdx delete mode 100644 references/1.4.2/common/ISoundLibrary.mdx delete mode 100644 references/1.4.2/common/InitContext.mdx delete mode 100644 references/1.4.2/common/InitContext/config.mdx delete mode 100644 references/1.4.2/common/InitContext/constructor.mdx delete mode 100644 references/1.4.2/common/InitContext/container.mdx delete mode 100644 references/1.4.2/common/InitContext/env.mdx delete mode 100644 references/1.4.2/common/InitContext/files.mdx delete mode 100644 references/1.4.2/common/Library.mdx delete mode 100644 references/1.4.2/common/Library/_relationship.mdx delete mode 100644 references/1.4.2/common/Library/constructor.mdx delete mode 100644 references/1.4.2/common/LibraryContext.mdx delete mode 100644 references/1.4.2/common/LibraryContext/status.mdx delete mode 100644 references/1.4.2/common/LibraryHandle.mdx delete mode 100644 references/1.4.2/common/LibraryHandle/constructor.mdx delete mode 100644 references/1.4.2/common/LibraryHandle/context.mdx delete mode 100644 references/1.4.2/common/LibraryHandle/library.mdx delete mode 100644 references/1.4.2/common/LibraryHandle/symbol.mdx delete mode 100644 references/1.4.2/common/LibraryManager.mdx delete mode 100644 references/1.4.2/common/LibraryManager/constructor.mdx delete mode 100644 references/1.4.2/common/LibraryManager/getAssetManager.mdx delete mode 100644 references/1.4.2/common/LibraryManager/getComponentSystem.mdx delete mode 100644 references/1.4.2/common/LibraryManager/getGraphics.mdx delete mode 100644 references/1.4.2/common/LibraryManager/getInput.mdx delete mode 100644 references/1.4.2/common/LibraryManager/getMusic.mdx delete mode 100644 references/1.4.2/common/LibraryManager/getNetwork.mdx delete mode 100644 references/1.4.2/common/LibraryManager/getSound.mdx delete mode 100644 references/1.4.2/common/LibraryStatusEnum.mdx delete mode 100644 references/1.4.2/common/MUSIC_LIBRARY.mdx delete mode 100644 references/1.4.2/common/NETWORK_LIBRARY.mdx delete mode 100644 references/1.4.2/common/NfConfigException.mdx delete mode 100644 references/1.4.2/common/NfConfigException/code.mdx delete mode 100644 references/1.4.2/common/NfConfigException/constructor.mdx delete mode 100644 references/1.4.2/common/NfFetchException.mdx delete mode 100644 references/1.4.2/common/NfFetchException/code.mdx delete mode 100644 references/1.4.2/common/NfFetchException/constructor.mdx delete mode 100644 references/1.4.2/common/NfFile.mdx delete mode 100644 references/1.4.2/common/NfFile/arrayBuffer.mdx delete mode 100644 references/1.4.2/common/NfFile/blob.mdx delete mode 100644 references/1.4.2/common/NfFile/bytes.mdx delete mode 100644 references/1.4.2/common/NfFile/constructor.mdx delete mode 100644 references/1.4.2/common/NfFile/formData.mdx delete mode 100644 references/1.4.2/common/NfFile/json.mdx delete mode 100644 references/1.4.2/common/NfFile/path.mdx delete mode 100644 references/1.4.2/common/NfFile/text.mdx delete mode 100644 references/1.4.2/common/NfNotFound.mdx delete mode 100644 references/1.4.2/common/NfNotFound/code.mdx delete mode 100644 references/1.4.2/common/NfNotFound/constructor.mdx delete mode 100644 references/1.4.2/common/NfNotInitializedException.mdx delete mode 100644 references/1.4.2/common/NfNotInitializedException/code.mdx delete mode 100644 references/1.4.2/common/NfNotInitializedException/constructor.mdx delete mode 100644 references/1.4.2/common/SOUND_LIBRARY.mdx delete mode 100644 references/1.4.2/config/0-index.mdx delete mode 100644 references/1.4.2/config/Default.mdx delete mode 100644 references/1.4.2/config/IsIpOrURL.mdx delete mode 100644 references/1.4.2/config/TransformToBoolean.mdx delete mode 100644 references/1.4.2/core-editor/0-index.mdx delete mode 100644 references/1.4.2/core-editor/CoreEvents.mdx delete mode 100644 references/1.4.2/core-editor/EditorEvents.mdx delete mode 100644 references/1.4.2/core-editor/EventEmitter.mdx delete mode 100644 references/1.4.2/core-editor/EventEmitter/constructor.mdx delete mode 100644 references/1.4.2/core-editor/EventEmitter/emit.mdx delete mode 100644 references/1.4.2/core-editor/EventEmitter/on.mdx delete mode 100644 references/1.4.2/core-editor/EventEmitter/runEvents.mdx delete mode 100644 references/1.4.2/core-editor/NanoforgeClient.mdx delete mode 100644 references/1.4.2/core-editor/NanoforgeClient/useGraphics.mdx delete mode 100644 references/1.4.2/core-editor/NanoforgeClient/useInput.mdx delete mode 100644 references/1.4.2/core-editor/NanoforgeClient/useSound.mdx delete mode 100644 references/1.4.2/core-editor/NanoforgeFactory.mdx delete mode 100644 references/1.4.2/core-editor/NanoforgeServer.mdx delete mode 100644 references/1.4.2/core/0-index.mdx delete mode 100644 references/1.4.2/core/NanoforgeClient.mdx delete mode 100644 references/1.4.2/core/NanoforgeClient/useGraphics.mdx delete mode 100644 references/1.4.2/core/NanoforgeClient/useInput.mdx delete mode 100644 references/1.4.2/core/NanoforgeClient/useSound.mdx delete mode 100644 references/1.4.2/core/NanoforgeFactory.mdx delete mode 100644 references/1.4.2/core/NanoforgeServer.mdx delete mode 100644 references/1.4.2/ecs-client/0-index.mdx delete mode 100644 references/1.4.2/ecs-client/ECSClientLibrary.mdx delete mode 100644 references/1.4.2/ecs-client/ECSClientLibrary/constructor.mdx delete mode 100644 references/1.4.2/ecs-lib/0-index.mdx delete mode 100644 references/1.4.2/ecs-lib/AbstractECSLibrary.mdx delete mode 100644 references/1.4.2/ecs-lib/AbstractECSLibrary/_registry.mdx delete mode 100644 references/1.4.2/ecs-lib/AbstractECSLibrary/constructor.mdx delete mode 100644 references/1.4.2/ecs-lib/AbstractECSLibrary/module.mdx delete mode 100644 references/1.4.2/ecs-lib/AbstractECSLibrary/path.mdx delete mode 100644 references/1.4.2/ecs-lib/AbstractECSLibrary/registry.mdx delete mode 100644 references/1.4.2/ecs-lib/Component.mdx delete mode 100644 references/1.4.2/ecs-lib/EditorComponentManifest.mdx delete mode 100644 references/1.4.2/ecs-lib/EditorSystemManifest.mdx delete mode 100644 references/1.4.2/ecs-lib/Entity.mdx delete mode 100644 references/1.4.2/ecs-lib/Entity/getId.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/addComponent.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/addSystem.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/clearEntities.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/clearSystems.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/entityFromIndex.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/getComponents.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/getComponentsConst.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/getEntityComponent.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/getEntityComponentConst.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/getIndexedZipper.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/getZipper.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/killEntity.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/maxEntities.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/registerComponent.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/removeComponent.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/removeSystem.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/runSystems.mdx delete mode 100644 references/1.4.2/ecs-lib/Registry/spawnEntity.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/clear.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/empty.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/erase.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/get.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/getConst.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/getIndex.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/insertAt.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/insertAt_1.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/resize.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/set.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/setByCopy.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/setByMove.mdx delete mode 100644 references/1.4.2/ecs-lib/SparseArray/size.mdx delete mode 100644 references/1.4.2/ecs-lib/System.mdx delete mode 100644 references/1.4.2/ecs-server/0-index.mdx delete mode 100644 references/1.4.2/ecs-server/ECSServerLibrary.mdx delete mode 100644 references/1.4.2/ecs-server/ECSServerLibrary/constructor.mdx delete mode 100644 references/1.4.2/ecs-server/Module.mdx delete mode 100644 references/1.4.2/graphics-2d/0-index.mdx delete mode 100644 references/1.4.2/graphics-2d/Animation_2.mdx delete mode 100644 references/1.4.2/graphics-2d/Arc.mdx delete mode 100644 references/1.4.2/graphics-2d/ArcConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Arrow.mdx delete mode 100644 references/1.4.2/graphics-2d/ArrowConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Canvas.mdx delete mode 100644 references/1.4.2/graphics-2d/Circle.mdx delete mode 100644 references/1.4.2/graphics-2d/CircleConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Container.mdx delete mode 100644 references/1.4.2/graphics-2d/ContainerConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Context.mdx delete mode 100644 references/1.4.2/graphics-2d/DD.mdx delete mode 100644 references/1.4.2/graphics-2d/Easings.mdx delete mode 100644 references/1.4.2/graphics-2d/Ellipse.mdx delete mode 100644 references/1.4.2/graphics-2d/EllipseConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/FastLayer.mdx delete mode 100644 references/1.4.2/graphics-2d/Filters.mdx delete mode 100644 references/1.4.2/graphics-2d/Graphics2DLibrary.mdx delete mode 100644 references/1.4.2/graphics-2d/Graphics2DLibrary/baseLayer.mdx delete mode 100644 references/1.4.2/graphics-2d/Graphics2DLibrary/stage.mdx delete mode 100644 references/1.4.2/graphics-2d/Group.mdx delete mode 100644 references/1.4.2/graphics-2d/GroupConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/ImageConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Image_2.mdx delete mode 100644 references/1.4.2/graphics-2d/KonvaEventListener.mdx delete mode 100644 references/1.4.2/graphics-2d/KonvaEventObject.mdx delete mode 100644 references/1.4.2/graphics-2d/KonvaPointerEvent.mdx delete mode 100644 references/1.4.2/graphics-2d/Label.mdx delete mode 100644 references/1.4.2/graphics-2d/LabelConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Layer.mdx delete mode 100644 references/1.4.2/graphics-2d/LayerConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Line.mdx delete mode 100644 references/1.4.2/graphics-2d/LineConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/NodeConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Node_2.mdx delete mode 100644 references/1.4.2/graphics-2d/Path.mdx delete mode 100644 references/1.4.2/graphics-2d/PathConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Rect.mdx delete mode 100644 references/1.4.2/graphics-2d/RectConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/RegularPolygon.mdx delete mode 100644 references/1.4.2/graphics-2d/RegularPolygonConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Ring.mdx delete mode 100644 references/1.4.2/graphics-2d/RingConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Shape.mdx delete mode 100644 references/1.4.2/graphics-2d/ShapeConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Sprite.mdx delete mode 100644 references/1.4.2/graphics-2d/SpriteConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Stage.mdx delete mode 100644 references/1.4.2/graphics-2d/StageConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Star.mdx delete mode 100644 references/1.4.2/graphics-2d/StarConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Tag.mdx delete mode 100644 references/1.4.2/graphics-2d/TagConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/TextConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/TextPath.mdx delete mode 100644 references/1.4.2/graphics-2d/TextPathConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Text_2.mdx delete mode 100644 references/1.4.2/graphics-2d/Transform.mdx delete mode 100644 references/1.4.2/graphics-2d/TransformerConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Transformer_2.mdx delete mode 100644 references/1.4.2/graphics-2d/Tween.mdx delete mode 100644 references/1.4.2/graphics-2d/TweenConfig.mdx delete mode 100644 references/1.4.2/graphics-2d/Util.mdx delete mode 100644 references/1.4.2/graphics-2d/Vector2d.mdx delete mode 100644 references/1.4.2/graphics-2d/Wedge.mdx delete mode 100644 references/1.4.2/graphics-2d/WedgeConfig.mdx delete mode 100644 references/1.4.2/input/0-index.mdx delete mode 100644 references/1.4.2/input/InputEnum.mdx delete mode 100644 references/1.4.2/input/InputLibrary.mdx delete mode 100644 references/1.4.2/input/InputLibrary/constructor.mdx delete mode 100644 references/1.4.2/input/InputLibrary/getDragState.mdx delete mode 100644 references/1.4.2/input/InputLibrary/getMousePosition.mdx delete mode 100644 references/1.4.2/input/InputLibrary/getMouseState.mdx delete mode 100644 references/1.4.2/input/InputLibrary/getPressedKeys.mdx delete mode 100644 references/1.4.2/input/InputLibrary/getWheelState.mdx delete mode 100644 references/1.4.2/input/InputLibrary/isDragging.mdx delete mode 100644 references/1.4.2/input/InputLibrary/isKeyPressed.mdx delete mode 100644 references/1.4.2/music/0-index.mdx delete mode 100644 references/1.4.2/music/MusicLibrary.mdx delete mode 100644 references/1.4.2/music/MusicLibrary/load.mdx delete mode 100644 references/1.4.2/music/MusicLibrary/mute.mdx delete mode 100644 references/1.4.2/music/MusicLibrary/play.mdx delete mode 100644 references/1.4.2/network-client/0-index.mdx delete mode 100644 references/1.4.2/network-client/NetworkClientLibrary.mdx delete mode 100644 references/1.4.2/network-client/NetworkClientLibrary/tcp.mdx delete mode 100644 references/1.4.2/network-client/NetworkClientLibrary/udp.mdx delete mode 100644 references/1.4.2/network-client/TCPClient.mdx delete mode 100644 references/1.4.2/network-client/TCPClient/connect.mdx delete mode 100644 references/1.4.2/network-client/TCPClient/constructor.mdx delete mode 100644 references/1.4.2/network-client/TCPClient/getReceivedPackets.mdx delete mode 100644 references/1.4.2/network-client/TCPClient/isConnected.mdx delete mode 100644 references/1.4.2/network-client/TCPClient/sendData.mdx delete mode 100644 references/1.4.2/network-client/UDPClient.mdx delete mode 100644 references/1.4.2/network-client/UDPClient/connect.mdx delete mode 100644 references/1.4.2/network-client/UDPClient/constructor.mdx delete mode 100644 references/1.4.2/network-client/UDPClient/getReceivedPackets.mdx delete mode 100644 references/1.4.2/network-client/UDPClient/isConnected.mdx delete mode 100644 references/1.4.2/network-client/UDPClient/sendData.mdx delete mode 100644 references/1.4.2/network-server/0-index.mdx delete mode 100644 references/1.4.2/network-server/NetworkServerLibrary.mdx delete mode 100644 references/1.4.2/network-server/NetworkServerLibrary/tcp.mdx delete mode 100644 references/1.4.2/network-server/NetworkServerLibrary/udp.mdx delete mode 100644 references/1.4.2/network-server/TCPServer.mdx delete mode 100644 references/1.4.2/network-server/TCPServer/constructor.mdx delete mode 100644 references/1.4.2/network-server/TCPServer/getConnectedClients.mdx delete mode 100644 references/1.4.2/network-server/TCPServer/getReceivedPackets.mdx delete mode 100644 references/1.4.2/network-server/TCPServer/listen.mdx delete mode 100644 references/1.4.2/network-server/TCPServer/sendToClient.mdx delete mode 100644 references/1.4.2/network-server/TCPServer/sendToEverybody.mdx delete mode 100644 references/1.4.2/network-server/UDPServer.mdx delete mode 100644 references/1.4.2/network-server/UDPServer/constructor.mdx delete mode 100644 references/1.4.2/network-server/UDPServer/getConnectedClients.mdx delete mode 100644 references/1.4.2/network-server/UDPServer/getReceivedPackets.mdx delete mode 100644 references/1.4.2/network-server/UDPServer/listen.mdx delete mode 100644 references/1.4.2/network-server/UDPServer/sendToClient.mdx delete mode 100644 references/1.4.2/network-server/UDPServer/sendToEverybody.mdx delete mode 100644 references/1.4.2/sound/0-index.mdx delete mode 100644 references/1.4.2/sound/SoundLibrary.mdx delete mode 100644 references/1.4.2/sound/SoundLibrary/load.mdx delete mode 100644 references/1.4.2/sound/SoundLibrary/mute.mdx delete mode 100644 references/1.4.2/sound/SoundLibrary/play.mdx create mode 100644 references/engine/navigation.json create mode 100644 references/engine/upcoming.mdx diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..6918f87 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,4 @@ +# Owned by the source repositories, written by the docs-sync action at their releases. +docs/ +guides/ +references/ diff --git a/docs.json b/docs.json index 90b89d8..d7e23c7 100644 --- a/docs.json +++ b/docs.json @@ -13,2690 +13,251 @@ "dark": "#7c3aed" }, "navigation": { - "languages": [ + "tabs": [ { - "language": "en", - "tabs": [ + "tab": "Documentation", + "dropdowns": [ { - "tab": "Documentation", - "dropdowns": [ - { - "dropdown": "Engine", - "groups": [ - { - "group": "Getting-Started", - "pages": [ - "docs/engine/getting-started/1-index", - "docs/engine/getting-started/documentation", - "docs/engine/getting-started/how_to_use" - ] - }, - { - "group": "Network", - "pages": [ - "docs/engine/network/index", - "docs/engine/network/network-client-api", - "docs/engine/network/network-client", - "docs/engine/network/network-server-api", - "docs/engine/network/network-server", - "docs/engine/network/packet-framing" - ] - }, - { - "group": "Registry", - "pages": [ - "docs/engine/registry/index", - "docs/engine/registry/writing_web_assembly" - ] - } - ] - }, - { - "dropdown": "CLI", - "groups": [ - { - "group": "Commands", - "pages": [ - "docs/cli/commands/1-overview", - { - "group": "Commands", - "pages": [ - "docs/cli/commands/2-commands/1-new", - "docs/cli/commands/2-commands/2-dev", - "docs/cli/commands/2-commands/3-build", - "docs/cli/commands/2-commands/4-start", - "docs/cli/commands/2-commands/5-create", - "docs/cli/commands/2-commands/6-install", - "docs/cli/commands/2-commands/7-install", - "docs/cli/commands/2-commands/7-editor", - "docs/cli/commands/2-commands/8-editor", - "docs/cli/commands/2-commands/8-registry", - "docs/cli/commands/2-commands/9-registry" - ] - } - ] - }, - { - "group": "Configuration", - "pages": [ - "docs/cli/configuration/1-configuration-file", - "docs/cli/configuration/2-environment-variables" - ] - }, - { - "group": "Getting-Started", - "pages": [ - "docs/cli/getting-started/1-introduction", - "docs/cli/getting-started/2-installation", - "docs/cli/getting-started/3-quickstart", - "docs/cli/getting-started/index", - "docs/cli/getting-started/usage" - ] - }, - { - "group": "Loader", - "pages": [ - "docs/cli/loader/1-overview", - "docs/cli/loader/2-client", - "docs/cli/loader/3-website", - "docs/cli/loader/4-server" - ] - }, - { - "group": "Schematics", - "pages": [ - "docs/cli/schematics/1-overview", - { - "group": "Schematics", - "pages": [ - "docs/cli/schematics/2-schematics/1-application", - "docs/cli/schematics/2-schematics/1-workspace", - "docs/cli/schematics/2-schematics/2-configuration", - "docs/cli/schematics/2-schematics/2-project", - "docs/cli/schematics/2-schematics/3-component", - "docs/cli/schematics/2-schematics/3-part-base", - "docs/cli/schematics/2-schematics/4-system", - "docs/cli/schematics/2-schematics/4-part-main", - "docs/cli/schematics/2-schematics/5-docker", - "docs/cli/schematics/2-schematics/6-component", - "docs/cli/schematics/2-schematics/7-system" - ] - } - ] - } - ] - } + "dropdown": "Overview", + "icon": "house", + "pages": [ + "index" ] }, { - "tab": "Guides", - "dropdowns": [ - { - "dropdown": "CLI", - "groups": [ - { - "group": "CLI", - "pages": [ - "guides/cli/cli/1-overview", - "guides/cli/cli/2-create-a-project", - "guides/cli/cli/3-develop-locally", - "guides/cli/cli/4-build-and-deploy", - "guides/cli/cli/5-components-and-systems", - "guides/cli/cli/6-publish-a-package" - ] - } - ] - } - ] + "dropdown": "Engine", + "icon": "gears", + "pages": { + "$ref": "./docs/engine/navigation.json" + } }, { - "tab": "References", - "versions": [ + "dropdown": "CLI", + "icon": "terminal", + "groups": [ { - "version": "1.4.0", - "dropdowns": [ - { - "dropdown": "Asset-Manager", - "pages": [ - "references/1.4.0/asset-manager/0-index", - { - "group": "AssetManagerLibrary", - "pages": [ - "references/1.4.0/asset-manager/AssetManagerLibrary/getAsset_1", - "references/1.4.0/asset-manager/AssetManagerLibrary/getAsset" - ], - "root": "references/1.4.0/asset-manager/AssetManagerLibrary" - } - ] - }, - { - "dropdown": "Common", - "pages": [ - "references/1.4.0/common/0-index", - { - "group": "ApplicationContext", - "pages": [ - "references/1.4.0/common/ApplicationContext/delta", - "references/1.4.0/common/ApplicationContext/isRunning" - ], - "root": "references/1.4.0/common/ApplicationContext" - }, - "references/1.4.0/common/ASSET_MANAGER_LIBRARY", - { - "group": "BaseAssetManagerLibrary", - "pages": [ - "references/1.4.0/common/BaseAssetManagerLibrary/getAsset_1", - "references/1.4.0/common/BaseAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.0/common/BaseAssetManagerLibrary" - }, - "references/1.4.0/common/BaseComponentSystemLibrary", - "references/1.4.0/common/BaseGraphicsLibrary", - "references/1.4.0/common/BaseInputLibrary", - { - "group": "BaseMusicLibrary", - "pages": [ - "references/1.4.0/common/BaseMusicLibrary/mute", - "references/1.4.0/common/BaseMusicLibrary/play" - ], - "root": "references/1.4.0/common/BaseMusicLibrary" - }, - "references/1.4.0/common/BaseNetworkLibrary", - { - "group": "BaseSoundLibrary", - "pages": [ - "references/1.4.0/common/BaseSoundLibrary/mute", - "references/1.4.0/common/BaseSoundLibrary/play" - ], - "root": "references/1.4.0/common/BaseSoundLibrary" - }, - "references/1.4.0/common/ClearContext", - { - "group": "ClientLibraryManager", - "pages": [ - "references/1.4.0/common/ClientLibraryManager/constructor", - "references/1.4.0/common/ClientLibraryManager/get", - "references/1.4.0/common/ClientLibraryManager/getAssetManager", - "references/1.4.0/common/ClientLibraryManager/getComponentSystem", - "references/1.4.0/common/ClientLibraryManager/getGraphics", - "references/1.4.0/common/ClientLibraryManager/getInput", - "references/1.4.0/common/ClientLibraryManager/getMusic", - "references/1.4.0/common/ClientLibraryManager/getNetwork", - "references/1.4.0/common/ClientLibraryManager/getSound" - ], - "root": "references/1.4.0/common/ClientLibraryManager" - }, - "references/1.4.0/common/COMPONENT_SYSTEM_LIBRARY", - { - "group": "Context", - "pages": [ - "references/1.4.0/common/Context/app", - "references/1.4.0/common/Context/constructor", - "references/1.4.0/common/Context/libs" - ], - "root": "references/1.4.0/common/Context" - }, - "references/1.4.0/common/DefaultLibrariesEnum", - "references/1.4.0/common/ExecutionContext", - "references/1.4.0/common/GRAPHICS_LIBRARY", - { - "group": "IAssetManagerLibrary", - "pages": [ - "references/1.4.0/common/IAssetManagerLibrary/getAsset_1", - "references/1.4.0/common/IAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.0/common/IAssetManagerLibrary" - }, - "references/1.4.0/common/IComponentSystemLibrary", - { - "group": "IConfigRegistry", - "pages": [ - "references/1.4.0/common/IConfigRegistry/registerConfig" - ], - "root": "references/1.4.0/common/IConfigRegistry" - }, - "references/1.4.0/common/IExposedLibrary", - "references/1.4.0/common/IGraphicsLibrary", - "references/1.4.0/common/IInputLibrary", - "references/1.4.0/common/ILibrary", - "references/1.4.0/common/IMusicLibrary", - { - "group": "IMutableLibrary", - "pages": [ - "references/1.4.0/common/IMutableLibrary/mute" - ], - "root": "references/1.4.0/common/IMutableLibrary" - }, - "references/1.4.0/common/INetworkLibrary", - { - "group": "InitContext", - "pages": [ - "references/1.4.0/common/InitContext/config", - "references/1.4.0/common/InitContext/constructor", - "references/1.4.0/common/InitContext/container", - "references/1.4.0/common/InitContext/env", - "references/1.4.0/common/InitContext/files" - ], - "root": "references/1.4.0/common/InitContext" - }, - "references/1.4.0/common/INPUT_LIBRARY", - { - "group": "IRunClientOptions", - "pages": [ - "references/1.4.0/common/IRunClientOptions/container", - "references/1.4.0/common/IRunClientOptions/env", - "references/1.4.0/common/IRunClientOptions/files" - ], - "root": "references/1.4.0/common/IRunClientOptions" - }, - "references/1.4.0/common/IRunnerLibrary", - "references/1.4.0/common/IRunOptions", - { - "group": "IRunServerOptions", - "pages": [ - "references/1.4.0/common/IRunServerOptions/env", - "references/1.4.0/common/IRunServerOptions/files" - ], - "root": "references/1.4.0/common/IRunServerOptions" - }, - "references/1.4.0/common/ISoundLibrary", - { - "group": "Library", - "pages": [ - "references/1.4.0/common/Library/_relationship", - "references/1.4.0/common/Library/constructor" - ], - "root": "references/1.4.0/common/Library" - }, - { - "group": "LibraryContext", - "pages": [ - "references/1.4.0/common/LibraryContext/status" - ], - "root": "references/1.4.0/common/LibraryContext" - }, - { - "group": "LibraryHandle", - "pages": [ - "references/1.4.0/common/LibraryHandle/constructor", - "references/1.4.0/common/LibraryHandle/context", - "references/1.4.0/common/LibraryHandle/library", - "references/1.4.0/common/LibraryHandle/symbol" - ], - "root": "references/1.4.0/common/LibraryHandle" - }, - { - "group": "LibraryManager", - "pages": [ - "references/1.4.0/common/LibraryManager/constructor", - "references/1.4.0/common/LibraryManager/getAssetManager", - "references/1.4.0/common/LibraryManager/getComponentSystem", - "references/1.4.0/common/LibraryManager/getGraphics", - "references/1.4.0/common/LibraryManager/getInput", - "references/1.4.0/common/LibraryManager/getMusic", - "references/1.4.0/common/LibraryManager/getNetwork", - "references/1.4.0/common/LibraryManager/getSound" - ], - "root": "references/1.4.0/common/LibraryManager" - }, - "references/1.4.0/common/LibraryStatusEnum", - "references/1.4.0/common/MUSIC_LIBRARY", - "references/1.4.0/common/NETWORK_LIBRARY", - { - "group": "NfConfigException", - "pages": [ - "references/1.4.0/common/NfConfigException/code", - "references/1.4.0/common/NfConfigException/constructor" - ], - "root": "references/1.4.0/common/NfConfigException" - }, - { - "group": "NfFetchException", - "pages": [ - "references/1.4.0/common/NfFetchException/code", - "references/1.4.0/common/NfFetchException/constructor" - ], - "root": "references/1.4.0/common/NfFetchException" - }, - { - "group": "NfFile", - "pages": [ - "references/1.4.0/common/NfFile/arrayBuffer", - "references/1.4.0/common/NfFile/blob", - "references/1.4.0/common/NfFile/bytes", - "references/1.4.0/common/NfFile/constructor", - "references/1.4.0/common/NfFile/formData", - "references/1.4.0/common/NfFile/json", - "references/1.4.0/common/NfFile/path", - "references/1.4.0/common/NfFile/text" - ], - "root": "references/1.4.0/common/NfFile" - }, - { - "group": "NfNotFound", - "pages": [ - "references/1.4.0/common/NfNotFound/code", - "references/1.4.0/common/NfNotFound/constructor" - ], - "root": "references/1.4.0/common/NfNotFound" - }, - { - "group": "NfNotInitializedException", - "pages": [ - "references/1.4.0/common/NfNotInitializedException/code", - "references/1.4.0/common/NfNotInitializedException/constructor" - ], - "root": "references/1.4.0/common/NfNotInitializedException" - }, - "references/1.4.0/common/SOUND_LIBRARY" - ] - }, - { - "dropdown": "Config", - "pages": [ - "references/1.4.0/config/0-index", - "references/1.4.0/config/Default", - "references/1.4.0/config/IsIpOrFQDN", - "references/1.4.0/config/TransformToBoolean" - ] - }, - { - "dropdown": "Core", - "pages": [ - "references/1.4.0/core/0-index", - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.0/core/NanoforgeClient/useGraphics", - "references/1.4.0/core/NanoforgeClient/useInput", - "references/1.4.0/core/NanoforgeClient/useSound" - ], - "root": "references/1.4.0/core/NanoforgeClient" - }, - "references/1.4.0/core/NanoforgeFactory", - "references/1.4.0/core/NanoforgeServer" - ] - }, - { - "dropdown": "Core-Editor", - "pages": [ - "references/1.4.0/core-editor/0-index", - "references/1.4.0/core-editor/CoreEvents", - "references/1.4.0/core-editor/EditorEvents", - { - "group": "EventEmitter", - "pages": [ - "references/1.4.0/core-editor/EventEmitter/constructor", - "references/1.4.0/core-editor/EventEmitter/emit", - "references/1.4.0/core-editor/EventEmitter/on", - "references/1.4.0/core-editor/EventEmitter/runEvents" - ], - "root": "references/1.4.0/core-editor/EventEmitter" - }, - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.0/core-editor/NanoforgeClient/useGraphics", - "references/1.4.0/core-editor/NanoforgeClient/useInput", - "references/1.4.0/core-editor/NanoforgeClient/useSound" - ], - "root": "references/1.4.0/core-editor/NanoforgeClient" - }, - "references/1.4.0/core-editor/NanoforgeFactory", - "references/1.4.0/core-editor/NanoforgeServer" - ] - }, - { - "dropdown": "ECS-Client", - "pages": [ - "references/1.4.0/ecs-client/0-index", - { - "group": "ECSClientLibrary", - "pages": [ - "references/1.4.0/ecs-client/ECSClientLibrary/constructor" - ], - "root": "references/1.4.0/ecs-client/ECSClientLibrary" - } - ] - }, - { - "dropdown": "ECS-Lib", - "pages": [ - "references/1.4.0/ecs-lib/0-index", - { - "group": "AbstractECSLibrary", - "pages": [ - "references/1.4.0/ecs-lib/AbstractECSLibrary/_registry", - "references/1.4.0/ecs-lib/AbstractECSLibrary/constructor", - "references/1.4.0/ecs-lib/AbstractECSLibrary/module", - "references/1.4.0/ecs-lib/AbstractECSLibrary/path", - "references/1.4.0/ecs-lib/AbstractECSLibrary/registry" - ], - "root": "references/1.4.0/ecs-lib/AbstractECSLibrary" - }, - "references/1.4.0/ecs-lib/Component", - "references/1.4.0/ecs-lib/EditorComponentManifest", - "references/1.4.0/ecs-lib/EditorSystemManifest", - { - "group": "Entity", - "pages": [ - "references/1.4.0/ecs-lib/Entity/getId" - ], - "root": "references/1.4.0/ecs-lib/Entity" - }, - { - "group": "Registry", - "pages": [ - "references/1.4.0/ecs-lib/Registry/addComponent", - "references/1.4.0/ecs-lib/Registry/addSystem", - "references/1.4.0/ecs-lib/Registry/clearEntities", - "references/1.4.0/ecs-lib/Registry/clearSystems", - "references/1.4.0/ecs-lib/Registry/entityFromIndex", - "references/1.4.0/ecs-lib/Registry/getComponents", - "references/1.4.0/ecs-lib/Registry/getComponentsConst", - "references/1.4.0/ecs-lib/Registry/getEntityComponent", - "references/1.4.0/ecs-lib/Registry/getEntityComponentConst", - "references/1.4.0/ecs-lib/Registry/getIndexedZipper", - "references/1.4.0/ecs-lib/Registry/getZipper", - "references/1.4.0/ecs-lib/Registry/killEntity", - "references/1.4.0/ecs-lib/Registry/maxEntities", - "references/1.4.0/ecs-lib/Registry/registerComponent", - "references/1.4.0/ecs-lib/Registry/removeComponent", - "references/1.4.0/ecs-lib/Registry/removeSystem", - "references/1.4.0/ecs-lib/Registry/runSystems", - "references/1.4.0/ecs-lib/Registry/spawnEntity" - ], - "root": "references/1.4.0/ecs-lib/Registry" - }, - { - "group": "SparseArray", - "pages": [ - "references/1.4.0/ecs-lib/SparseArray/clear", - "references/1.4.0/ecs-lib/SparseArray/empty", - "references/1.4.0/ecs-lib/SparseArray/erase", - "references/1.4.0/ecs-lib/SparseArray/get", - "references/1.4.0/ecs-lib/SparseArray/getConst", - "references/1.4.0/ecs-lib/SparseArray/getIndex", - "references/1.4.0/ecs-lib/SparseArray/insertAt_1", - "references/1.4.0/ecs-lib/SparseArray/insertAt", - "references/1.4.0/ecs-lib/SparseArray/resize", - "references/1.4.0/ecs-lib/SparseArray/set", - "references/1.4.0/ecs-lib/SparseArray/setByCopy", - "references/1.4.0/ecs-lib/SparseArray/setByMove", - "references/1.4.0/ecs-lib/SparseArray/size" - ], - "root": "references/1.4.0/ecs-lib/SparseArray" - }, - "references/1.4.0/ecs-lib/System" - ] - }, - { - "dropdown": "ECS-Server", - "pages": [ - "references/1.4.0/ecs-server/0-index", - { - "group": "ECSServerLibrary", - "pages": [ - "references/1.4.0/ecs-server/ECSServerLibrary/constructor" - ], - "root": "references/1.4.0/ecs-server/ECSServerLibrary" - }, - "references/1.4.0/ecs-server/Module" - ] - }, - { - "dropdown": "Graphics-2d", - "pages": [ - "references/1.4.0/graphics-2d/0-index", - "references/1.4.0/graphics-2d/Animation_2", - "references/1.4.0/graphics-2d/Arc", - "references/1.4.0/graphics-2d/ArcConfig", - "references/1.4.0/graphics-2d/Arrow", - "references/1.4.0/graphics-2d/ArrowConfig", - "references/1.4.0/graphics-2d/Canvas", - "references/1.4.0/graphics-2d/Circle", - "references/1.4.0/graphics-2d/CircleConfig", - "references/1.4.0/graphics-2d/Container", - "references/1.4.0/graphics-2d/ContainerConfig", - "references/1.4.0/graphics-2d/Context", - "references/1.4.0/graphics-2d/DD", - "references/1.4.0/graphics-2d/Easings", - "references/1.4.0/graphics-2d/Ellipse", - "references/1.4.0/graphics-2d/EllipseConfig", - "references/1.4.0/graphics-2d/FastLayer", - "references/1.4.0/graphics-2d/Filters", - { - "group": "Graphics2DLibrary", - "pages": [ - "references/1.4.0/graphics-2d/Graphics2DLibrary/baseLayer", - "references/1.4.0/graphics-2d/Graphics2DLibrary/stage" - ], - "root": "references/1.4.0/graphics-2d/Graphics2DLibrary" - }, - "references/1.4.0/graphics-2d/Group", - "references/1.4.0/graphics-2d/GroupConfig", - "references/1.4.0/graphics-2d/Image_2", - "references/1.4.0/graphics-2d/ImageConfig", - "references/1.4.0/graphics-2d/KonvaEventListener", - "references/1.4.0/graphics-2d/KonvaEventObject", - "references/1.4.0/graphics-2d/KonvaPointerEvent", - "references/1.4.0/graphics-2d/Label", - "references/1.4.0/graphics-2d/LabelConfig", - "references/1.4.0/graphics-2d/Layer", - "references/1.4.0/graphics-2d/LayerConfig", - "references/1.4.0/graphics-2d/Line", - "references/1.4.0/graphics-2d/LineConfig", - "references/1.4.0/graphics-2d/Node_2", - "references/1.4.0/graphics-2d/NodeConfig", - "references/1.4.0/graphics-2d/Path", - "references/1.4.0/graphics-2d/PathConfig", - "references/1.4.0/graphics-2d/Rect", - "references/1.4.0/graphics-2d/RectConfig", - "references/1.4.0/graphics-2d/RegularPolygon", - "references/1.4.0/graphics-2d/RegularPolygonConfig", - "references/1.4.0/graphics-2d/Ring", - "references/1.4.0/graphics-2d/RingConfig", - "references/1.4.0/graphics-2d/Shape", - "references/1.4.0/graphics-2d/ShapeConfig", - "references/1.4.0/graphics-2d/Sprite", - "references/1.4.0/graphics-2d/SpriteConfig", - "references/1.4.0/graphics-2d/Stage", - "references/1.4.0/graphics-2d/StageConfig", - "references/1.4.0/graphics-2d/Star", - "references/1.4.0/graphics-2d/StarConfig", - "references/1.4.0/graphics-2d/Tag", - "references/1.4.0/graphics-2d/TagConfig", - "references/1.4.0/graphics-2d/Text_2", - "references/1.4.0/graphics-2d/TextConfig", - "references/1.4.0/graphics-2d/TextPath", - "references/1.4.0/graphics-2d/TextPathConfig", - "references/1.4.0/graphics-2d/Transform", - "references/1.4.0/graphics-2d/Transformer_2", - "references/1.4.0/graphics-2d/TransformerConfig", - "references/1.4.0/graphics-2d/Tween", - "references/1.4.0/graphics-2d/TweenConfig", - "references/1.4.0/graphics-2d/Util", - "references/1.4.0/graphics-2d/Vector2d", - "references/1.4.0/graphics-2d/Wedge", - "references/1.4.0/graphics-2d/WedgeConfig" - ] - }, - { - "dropdown": "Input", - "pages": [ - "references/1.4.0/input/0-index", - "references/1.4.0/input/InputEnum", - { - "group": "InputLibrary", - "pages": [ - "references/1.4.0/input/InputLibrary/constructor", - "references/1.4.0/input/InputLibrary/getDragState", - "references/1.4.0/input/InputLibrary/getMousePosition", - "references/1.4.0/input/InputLibrary/getMouseState", - "references/1.4.0/input/InputLibrary/getPressedKeys", - "references/1.4.0/input/InputLibrary/getWheelState", - "references/1.4.0/input/InputLibrary/isDragging", - "references/1.4.0/input/InputLibrary/isKeyPressed" - ], - "root": "references/1.4.0/input/InputLibrary" - } - ] - }, - { - "dropdown": "Music", - "pages": [ - "references/1.4.0/music/0-index", - { - "group": "MusicLibrary", - "pages": [ - "references/1.4.0/music/MusicLibrary/load", - "references/1.4.0/music/MusicLibrary/mute", - "references/1.4.0/music/MusicLibrary/play" - ], - "root": "references/1.4.0/music/MusicLibrary" - } - ] - }, - { - "dropdown": "Network-Client", - "pages": [ - "references/1.4.0/network-client/0-index", - { - "group": "NetworkClientLibrary", - "pages": [ - "references/1.4.0/network-client/NetworkClientLibrary/tcp", - "references/1.4.0/network-client/NetworkClientLibrary/udp" - ], - "root": "references/1.4.0/network-client/NetworkClientLibrary" - }, - { - "group": "TCPClient", - "pages": [ - "references/1.4.0/network-client/TCPClient/connect", - "references/1.4.0/network-client/TCPClient/constructor", - "references/1.4.0/network-client/TCPClient/getReceivedPackets", - "references/1.4.0/network-client/TCPClient/isConnected", - "references/1.4.0/network-client/TCPClient/sendData" - ], - "root": "references/1.4.0/network-client/TCPClient" - }, - { - "group": "UDPClient", - "pages": [ - "references/1.4.0/network-client/UDPClient/connect", - "references/1.4.0/network-client/UDPClient/constructor", - "references/1.4.0/network-client/UDPClient/getReceivedPackets", - "references/1.4.0/network-client/UDPClient/isConnected", - "references/1.4.0/network-client/UDPClient/sendData" - ], - "root": "references/1.4.0/network-client/UDPClient" - } - ] - }, - { - "dropdown": "Network-Server", - "pages": [ - "references/1.4.0/network-server/0-index", - { - "group": "NetworkServerLibrary", - "pages": [ - "references/1.4.0/network-server/NetworkServerLibrary/tcp", - "references/1.4.0/network-server/NetworkServerLibrary/udp" - ], - "root": "references/1.4.0/network-server/NetworkServerLibrary" - }, - { - "group": "TCPServer", - "pages": [ - "references/1.4.0/network-server/TCPServer/constructor", - "references/1.4.0/network-server/TCPServer/getConnectedClients", - "references/1.4.0/network-server/TCPServer/getReceivedPackets", - "references/1.4.0/network-server/TCPServer/listen", - "references/1.4.0/network-server/TCPServer/sendToClient", - "references/1.4.0/network-server/TCPServer/sendToEverybody" - ], - "root": "references/1.4.0/network-server/TCPServer" - }, - { - "group": "UDPServer", - "pages": [ - "references/1.4.0/network-server/UDPServer/constructor", - "references/1.4.0/network-server/UDPServer/getConnectedClients", - "references/1.4.0/network-server/UDPServer/getReceivedPackets", - "references/1.4.0/network-server/UDPServer/listen", - "references/1.4.0/network-server/UDPServer/sendToClient", - "references/1.4.0/network-server/UDPServer/sendToEverybody" - ], - "root": "references/1.4.0/network-server/UDPServer" - } - ] - }, - { - "dropdown": "Sound", - "pages": [ - "references/1.4.0/sound/0-index", - { - "group": "SoundLibrary", - "pages": [ - "references/1.4.0/sound/SoundLibrary/load", - "references/1.4.0/sound/SoundLibrary/mute", - "references/1.4.0/sound/SoundLibrary/play" - ], - "root": "references/1.4.0/sound/SoundLibrary" - } - ] - } - ] + "group": "CLI", + "pages": { + "$ref": "./docs/cli/navigation.json" + } }, { - "version": "1.4.2", - "dropdowns": [ - { - "dropdown": "Asset-Manager", - "pages": [ - "references/1.4.2/asset-manager/0-index", - { - "group": "AssetManagerLibrary", - "pages": [ - "references/1.4.2/asset-manager/AssetManagerLibrary/getAsset_1", - "references/1.4.2/asset-manager/AssetManagerLibrary/getAsset" - ], - "root": "references/1.4.2/asset-manager/AssetManagerLibrary" - } - ] - }, - { - "dropdown": "Common", - "pages": [ - "references/1.4.2/common/0-index", - { - "group": "ApplicationContext", - "pages": [ - "references/1.4.2/common/ApplicationContext/delta", - "references/1.4.2/common/ApplicationContext/isRunning" - ], - "root": "references/1.4.2/common/ApplicationContext" - }, - "references/1.4.2/common/ASSET_MANAGER_LIBRARY", - { - "group": "BaseAssetManagerLibrary", - "pages": [ - "references/1.4.2/common/BaseAssetManagerLibrary/getAsset_1", - "references/1.4.2/common/BaseAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.2/common/BaseAssetManagerLibrary" - }, - "references/1.4.2/common/BaseComponentSystemLibrary", - "references/1.4.2/common/BaseGraphicsLibrary", - "references/1.4.2/common/BaseInputLibrary", - { - "group": "BaseMusicLibrary", - "pages": [ - "references/1.4.2/common/BaseMusicLibrary/mute", - "references/1.4.2/common/BaseMusicLibrary/play" - ], - "root": "references/1.4.2/common/BaseMusicLibrary" - }, - "references/1.4.2/common/BaseNetworkLibrary", - { - "group": "BaseSoundLibrary", - "pages": [ - "references/1.4.2/common/BaseSoundLibrary/mute", - "references/1.4.2/common/BaseSoundLibrary/play" - ], - "root": "references/1.4.2/common/BaseSoundLibrary" - }, - "references/1.4.2/common/ClearContext", - { - "group": "ClientLibraryManager", - "pages": [ - "references/1.4.2/common/ClientLibraryManager/constructor", - "references/1.4.2/common/ClientLibraryManager/get", - "references/1.4.2/common/ClientLibraryManager/getAssetManager", - "references/1.4.2/common/ClientLibraryManager/getComponentSystem", - "references/1.4.2/common/ClientLibraryManager/getGraphics", - "references/1.4.2/common/ClientLibraryManager/getInput", - "references/1.4.2/common/ClientLibraryManager/getMusic", - "references/1.4.2/common/ClientLibraryManager/getNetwork", - "references/1.4.2/common/ClientLibraryManager/getSound" - ], - "root": "references/1.4.2/common/ClientLibraryManager" - }, - "references/1.4.2/common/COMPONENT_SYSTEM_LIBRARY", - { - "group": "Context", - "pages": [ - "references/1.4.2/common/Context/app", - "references/1.4.2/common/Context/constructor", - "references/1.4.2/common/Context/libs" - ], - "root": "references/1.4.2/common/Context" - }, - "references/1.4.2/common/DefaultLibrariesEnum", - "references/1.4.2/common/ExecutionContext", - "references/1.4.2/common/GRAPHICS_LIBRARY", - { - "group": "IAssetManagerLibrary", - "pages": [ - "references/1.4.2/common/IAssetManagerLibrary/getAsset_1", - "references/1.4.2/common/IAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.2/common/IAssetManagerLibrary" - }, - "references/1.4.2/common/IComponentSystemLibrary", - { - "group": "IConfigRegistry", - "pages": [ - "references/1.4.2/common/IConfigRegistry/registerConfig" - ], - "root": "references/1.4.2/common/IConfigRegistry" - }, - "references/1.4.2/common/IExposedLibrary", - "references/1.4.2/common/IGraphicsLibrary", - "references/1.4.2/common/IInputLibrary", - "references/1.4.2/common/ILibrary", - "references/1.4.2/common/IMusicLibrary", - { - "group": "IMutableLibrary", - "pages": [ - "references/1.4.2/common/IMutableLibrary/mute" - ], - "root": "references/1.4.2/common/IMutableLibrary" - }, - "references/1.4.2/common/INetworkLibrary", - { - "group": "InitContext", - "pages": [ - "references/1.4.2/common/InitContext/config", - "references/1.4.2/common/InitContext/constructor", - "references/1.4.2/common/InitContext/container", - "references/1.4.2/common/InitContext/env", - "references/1.4.2/common/InitContext/files" - ], - "root": "references/1.4.2/common/InitContext" - }, - "references/1.4.2/common/INPUT_LIBRARY", - { - "group": "IRunClientOptions", - "pages": [ - "references/1.4.2/common/IRunClientOptions/container", - "references/1.4.2/common/IRunClientOptions/env", - "references/1.4.2/common/IRunClientOptions/files" - ], - "root": "references/1.4.2/common/IRunClientOptions" - }, - "references/1.4.2/common/IRunnerLibrary", - "references/1.4.2/common/IRunOptions", - { - "group": "IRunServerOptions", - "pages": [ - "references/1.4.2/common/IRunServerOptions/env", - "references/1.4.2/common/IRunServerOptions/files" - ], - "root": "references/1.4.2/common/IRunServerOptions" - }, - "references/1.4.2/common/ISoundLibrary", - { - "group": "Library", - "pages": [ - "references/1.4.2/common/Library/_relationship", - "references/1.4.2/common/Library/constructor" - ], - "root": "references/1.4.2/common/Library" - }, - { - "group": "LibraryContext", - "pages": [ - "references/1.4.2/common/LibraryContext/status" - ], - "root": "references/1.4.2/common/LibraryContext" - }, - { - "group": "LibraryHandle", - "pages": [ - "references/1.4.2/common/LibraryHandle/constructor", - "references/1.4.2/common/LibraryHandle/context", - "references/1.4.2/common/LibraryHandle/library", - "references/1.4.2/common/LibraryHandle/symbol" - ], - "root": "references/1.4.2/common/LibraryHandle" - }, - { - "group": "LibraryManager", - "pages": [ - "references/1.4.2/common/LibraryManager/constructor", - "references/1.4.2/common/LibraryManager/getAssetManager", - "references/1.4.2/common/LibraryManager/getComponentSystem", - "references/1.4.2/common/LibraryManager/getGraphics", - "references/1.4.2/common/LibraryManager/getInput", - "references/1.4.2/common/LibraryManager/getMusic", - "references/1.4.2/common/LibraryManager/getNetwork", - "references/1.4.2/common/LibraryManager/getSound" - ], - "root": "references/1.4.2/common/LibraryManager" - }, - "references/1.4.2/common/LibraryStatusEnum", - "references/1.4.2/common/MUSIC_LIBRARY", - "references/1.4.2/common/NETWORK_LIBRARY", - { - "group": "NfConfigException", - "pages": [ - "references/1.4.2/common/NfConfigException/code", - "references/1.4.2/common/NfConfigException/constructor" - ], - "root": "references/1.4.2/common/NfConfigException" - }, - { - "group": "NfFetchException", - "pages": [ - "references/1.4.2/common/NfFetchException/code", - "references/1.4.2/common/NfFetchException/constructor" - ], - "root": "references/1.4.2/common/NfFetchException" - }, - { - "group": "NfFile", - "pages": [ - "references/1.4.2/common/NfFile/arrayBuffer", - "references/1.4.2/common/NfFile/blob", - "references/1.4.2/common/NfFile/bytes", - "references/1.4.2/common/NfFile/constructor", - "references/1.4.2/common/NfFile/formData", - "references/1.4.2/common/NfFile/json", - "references/1.4.2/common/NfFile/path", - "references/1.4.2/common/NfFile/text" - ], - "root": "references/1.4.2/common/NfFile" - }, - { - "group": "NfNotFound", - "pages": [ - "references/1.4.2/common/NfNotFound/code", - "references/1.4.2/common/NfNotFound/constructor" - ], - "root": "references/1.4.2/common/NfNotFound" - }, - { - "group": "NfNotInitializedException", - "pages": [ - "references/1.4.2/common/NfNotInitializedException/code", - "references/1.4.2/common/NfNotInitializedException/constructor" - ], - "root": "references/1.4.2/common/NfNotInitializedException" - }, - "references/1.4.2/common/SOUND_LIBRARY" - ] - }, - { - "dropdown": "Config", - "pages": [ - "references/1.4.2/config/0-index", - "references/1.4.2/config/Default", - "references/1.4.2/config/IsIpOrURL", - "references/1.4.2/config/TransformToBoolean" - ] - }, - { - "dropdown": "Core", - "pages": [ - "references/1.4.2/core/0-index", - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.2/core/NanoforgeClient/useGraphics", - "references/1.4.2/core/NanoforgeClient/useInput", - "references/1.4.2/core/NanoforgeClient/useSound" - ], - "root": "references/1.4.2/core/NanoforgeClient" - }, - "references/1.4.2/core/NanoforgeFactory", - "references/1.4.2/core/NanoforgeServer" - ] - }, - { - "dropdown": "Core-Editor", - "pages": [ - "references/1.4.2/core-editor/0-index", - "references/1.4.2/core-editor/CoreEvents", - "references/1.4.2/core-editor/EditorEvents", - { - "group": "EventEmitter", - "pages": [ - "references/1.4.2/core-editor/EventEmitter/constructor", - "references/1.4.2/core-editor/EventEmitter/emit", - "references/1.4.2/core-editor/EventEmitter/on", - "references/1.4.2/core-editor/EventEmitter/runEvents" - ], - "root": "references/1.4.2/core-editor/EventEmitter" - }, - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.2/core-editor/NanoforgeClient/useGraphics", - "references/1.4.2/core-editor/NanoforgeClient/useInput", - "references/1.4.2/core-editor/NanoforgeClient/useSound" - ], - "root": "references/1.4.2/core-editor/NanoforgeClient" - }, - "references/1.4.2/core-editor/NanoforgeFactory", - "references/1.4.2/core-editor/NanoforgeServer" - ] - }, - { - "dropdown": "ECS-Client", - "pages": [ - "references/1.4.2/ecs-client/0-index", - { - "group": "ECSClientLibrary", - "pages": [ - "references/1.4.2/ecs-client/ECSClientLibrary/constructor" - ], - "root": "references/1.4.2/ecs-client/ECSClientLibrary" - } - ] - }, - { - "dropdown": "ECS-Lib", - "pages": [ - "references/1.4.2/ecs-lib/0-index", - { - "group": "AbstractECSLibrary", - "pages": [ - "references/1.4.2/ecs-lib/AbstractECSLibrary/_registry", - "references/1.4.2/ecs-lib/AbstractECSLibrary/constructor", - "references/1.4.2/ecs-lib/AbstractECSLibrary/module", - "references/1.4.2/ecs-lib/AbstractECSLibrary/path", - "references/1.4.2/ecs-lib/AbstractECSLibrary/registry" - ], - "root": "references/1.4.2/ecs-lib/AbstractECSLibrary" - }, - "references/1.4.2/ecs-lib/Component", - "references/1.4.2/ecs-lib/EditorComponentManifest", - "references/1.4.2/ecs-lib/EditorSystemManifest", - { - "group": "Entity", - "pages": [ - "references/1.4.2/ecs-lib/Entity/getId" - ], - "root": "references/1.4.2/ecs-lib/Entity" - }, - { - "group": "Registry", - "pages": [ - "references/1.4.2/ecs-lib/Registry/addComponent", - "references/1.4.2/ecs-lib/Registry/addSystem", - "references/1.4.2/ecs-lib/Registry/clearEntities", - "references/1.4.2/ecs-lib/Registry/clearSystems", - "references/1.4.2/ecs-lib/Registry/entityFromIndex", - "references/1.4.2/ecs-lib/Registry/getComponents", - "references/1.4.2/ecs-lib/Registry/getComponentsConst", - "references/1.4.2/ecs-lib/Registry/getEntityComponent", - "references/1.4.2/ecs-lib/Registry/getEntityComponentConst", - "references/1.4.2/ecs-lib/Registry/getIndexedZipper", - "references/1.4.2/ecs-lib/Registry/getZipper", - "references/1.4.2/ecs-lib/Registry/killEntity", - "references/1.4.2/ecs-lib/Registry/maxEntities", - "references/1.4.2/ecs-lib/Registry/registerComponent", - "references/1.4.2/ecs-lib/Registry/removeComponent", - "references/1.4.2/ecs-lib/Registry/removeSystem", - "references/1.4.2/ecs-lib/Registry/runSystems", - "references/1.4.2/ecs-lib/Registry/spawnEntity" - ], - "root": "references/1.4.2/ecs-lib/Registry" - }, - { - "group": "SparseArray", - "pages": [ - "references/1.4.2/ecs-lib/SparseArray/clear", - "references/1.4.2/ecs-lib/SparseArray/empty", - "references/1.4.2/ecs-lib/SparseArray/erase", - "references/1.4.2/ecs-lib/SparseArray/get", - "references/1.4.2/ecs-lib/SparseArray/getConst", - "references/1.4.2/ecs-lib/SparseArray/getIndex", - "references/1.4.2/ecs-lib/SparseArray/insertAt_1", - "references/1.4.2/ecs-lib/SparseArray/insertAt", - "references/1.4.2/ecs-lib/SparseArray/resize", - "references/1.4.2/ecs-lib/SparseArray/set", - "references/1.4.2/ecs-lib/SparseArray/setByCopy", - "references/1.4.2/ecs-lib/SparseArray/setByMove", - "references/1.4.2/ecs-lib/SparseArray/size" - ], - "root": "references/1.4.2/ecs-lib/SparseArray" - }, - "references/1.4.2/ecs-lib/System" - ] - }, - { - "dropdown": "ECS-Server", - "pages": [ - "references/1.4.2/ecs-server/0-index", - { - "group": "ECSServerLibrary", - "pages": [ - "references/1.4.2/ecs-server/ECSServerLibrary/constructor" - ], - "root": "references/1.4.2/ecs-server/ECSServerLibrary" - }, - "references/1.4.2/ecs-server/Module" - ] - }, - { - "dropdown": "Graphics-2d", - "pages": [ - "references/1.4.2/graphics-2d/0-index", - "references/1.4.2/graphics-2d/Animation_2", - "references/1.4.2/graphics-2d/Arc", - "references/1.4.2/graphics-2d/ArcConfig", - "references/1.4.2/graphics-2d/Arrow", - "references/1.4.2/graphics-2d/ArrowConfig", - "references/1.4.2/graphics-2d/Canvas", - "references/1.4.2/graphics-2d/Circle", - "references/1.4.2/graphics-2d/CircleConfig", - "references/1.4.2/graphics-2d/Container", - "references/1.4.2/graphics-2d/ContainerConfig", - "references/1.4.2/graphics-2d/Context", - "references/1.4.2/graphics-2d/DD", - "references/1.4.2/graphics-2d/Easings", - "references/1.4.2/graphics-2d/Ellipse", - "references/1.4.2/graphics-2d/EllipseConfig", - "references/1.4.2/graphics-2d/FastLayer", - "references/1.4.2/graphics-2d/Filters", - { - "group": "Graphics2DLibrary", - "pages": [ - "references/1.4.2/graphics-2d/Graphics2DLibrary/baseLayer", - "references/1.4.2/graphics-2d/Graphics2DLibrary/stage" - ], - "root": "references/1.4.2/graphics-2d/Graphics2DLibrary" - }, - "references/1.4.2/graphics-2d/Group", - "references/1.4.2/graphics-2d/GroupConfig", - "references/1.4.2/graphics-2d/Image_2", - "references/1.4.2/graphics-2d/ImageConfig", - "references/1.4.2/graphics-2d/KonvaEventListener", - "references/1.4.2/graphics-2d/KonvaEventObject", - "references/1.4.2/graphics-2d/KonvaPointerEvent", - "references/1.4.2/graphics-2d/Label", - "references/1.4.2/graphics-2d/LabelConfig", - "references/1.4.2/graphics-2d/Layer", - "references/1.4.2/graphics-2d/LayerConfig", - "references/1.4.2/graphics-2d/Line", - "references/1.4.2/graphics-2d/LineConfig", - "references/1.4.2/graphics-2d/Node_2", - "references/1.4.2/graphics-2d/NodeConfig", - "references/1.4.2/graphics-2d/Path", - "references/1.4.2/graphics-2d/PathConfig", - "references/1.4.2/graphics-2d/Rect", - "references/1.4.2/graphics-2d/RectConfig", - "references/1.4.2/graphics-2d/RegularPolygon", - "references/1.4.2/graphics-2d/RegularPolygonConfig", - "references/1.4.2/graphics-2d/Ring", - "references/1.4.2/graphics-2d/RingConfig", - "references/1.4.2/graphics-2d/Shape", - "references/1.4.2/graphics-2d/ShapeConfig", - "references/1.4.2/graphics-2d/Sprite", - "references/1.4.2/graphics-2d/SpriteConfig", - "references/1.4.2/graphics-2d/Stage", - "references/1.4.2/graphics-2d/StageConfig", - "references/1.4.2/graphics-2d/Star", - "references/1.4.2/graphics-2d/StarConfig", - "references/1.4.2/graphics-2d/Tag", - "references/1.4.2/graphics-2d/TagConfig", - "references/1.4.2/graphics-2d/Text_2", - "references/1.4.2/graphics-2d/TextConfig", - "references/1.4.2/graphics-2d/TextPath", - "references/1.4.2/graphics-2d/TextPathConfig", - "references/1.4.2/graphics-2d/Transform", - "references/1.4.2/graphics-2d/Transformer_2", - "references/1.4.2/graphics-2d/TransformerConfig", - "references/1.4.2/graphics-2d/Tween", - "references/1.4.2/graphics-2d/TweenConfig", - "references/1.4.2/graphics-2d/Util", - "references/1.4.2/graphics-2d/Vector2d", - "references/1.4.2/graphics-2d/Wedge", - "references/1.4.2/graphics-2d/WedgeConfig" - ] - }, - { - "dropdown": "Input", - "pages": [ - "references/1.4.2/input/0-index", - "references/1.4.2/input/InputEnum", - { - "group": "InputLibrary", - "pages": [ - "references/1.4.2/input/InputLibrary/constructor", - "references/1.4.2/input/InputLibrary/getDragState", - "references/1.4.2/input/InputLibrary/getMousePosition", - "references/1.4.2/input/InputLibrary/getMouseState", - "references/1.4.2/input/InputLibrary/getPressedKeys", - "references/1.4.2/input/InputLibrary/getWheelState", - "references/1.4.2/input/InputLibrary/isDragging", - "references/1.4.2/input/InputLibrary/isKeyPressed" - ], - "root": "references/1.4.2/input/InputLibrary" - } - ] - }, - { - "dropdown": "Music", - "pages": [ - "references/1.4.2/music/0-index", - { - "group": "MusicLibrary", - "pages": [ - "references/1.4.2/music/MusicLibrary/load", - "references/1.4.2/music/MusicLibrary/mute", - "references/1.4.2/music/MusicLibrary/play" - ], - "root": "references/1.4.2/music/MusicLibrary" - } - ] - }, - { - "dropdown": "Network-Client", - "pages": [ - "references/1.4.2/network-client/0-index", - { - "group": "NetworkClientLibrary", - "pages": [ - "references/1.4.2/network-client/NetworkClientLibrary/tcp", - "references/1.4.2/network-client/NetworkClientLibrary/udp" - ], - "root": "references/1.4.2/network-client/NetworkClientLibrary" - }, - { - "group": "TCPClient", - "pages": [ - "references/1.4.2/network-client/TCPClient/connect", - "references/1.4.2/network-client/TCPClient/constructor", - "references/1.4.2/network-client/TCPClient/getReceivedPackets", - "references/1.4.2/network-client/TCPClient/isConnected", - "references/1.4.2/network-client/TCPClient/sendData" - ], - "root": "references/1.4.2/network-client/TCPClient" - }, - { - "group": "UDPClient", - "pages": [ - "references/1.4.2/network-client/UDPClient/connect", - "references/1.4.2/network-client/UDPClient/constructor", - "references/1.4.2/network-client/UDPClient/getReceivedPackets", - "references/1.4.2/network-client/UDPClient/isConnected", - "references/1.4.2/network-client/UDPClient/sendData" - ], - "root": "references/1.4.2/network-client/UDPClient" - } - ] - }, - { - "dropdown": "Network-Server", - "pages": [ - "references/1.4.2/network-server/0-index", - { - "group": "NetworkServerLibrary", - "pages": [ - "references/1.4.2/network-server/NetworkServerLibrary/tcp", - "references/1.4.2/network-server/NetworkServerLibrary/udp" - ], - "root": "references/1.4.2/network-server/NetworkServerLibrary" - }, - { - "group": "TCPServer", - "pages": [ - "references/1.4.2/network-server/TCPServer/constructor", - "references/1.4.2/network-server/TCPServer/getConnectedClients", - "references/1.4.2/network-server/TCPServer/getReceivedPackets", - "references/1.4.2/network-server/TCPServer/listen", - "references/1.4.2/network-server/TCPServer/sendToClient", - "references/1.4.2/network-server/TCPServer/sendToEverybody" - ], - "root": "references/1.4.2/network-server/TCPServer" - }, - { - "group": "UDPServer", - "pages": [ - "references/1.4.2/network-server/UDPServer/constructor", - "references/1.4.2/network-server/UDPServer/getConnectedClients", - "references/1.4.2/network-server/UDPServer/getReceivedPackets", - "references/1.4.2/network-server/UDPServer/listen", - "references/1.4.2/network-server/UDPServer/sendToClient", - "references/1.4.2/network-server/UDPServer/sendToEverybody" - ], - "root": "references/1.4.2/network-server/UDPServer" - } - ] - }, - { - "dropdown": "Sound", - "pages": [ - "references/1.4.2/sound/0-index", - { - "group": "SoundLibrary", - "pages": [ - "references/1.4.2/sound/SoundLibrary/load", - "references/1.4.2/sound/SoundLibrary/mute", - "references/1.4.2/sound/SoundLibrary/play" - ], - "root": "references/1.4.2/sound/SoundLibrary" - } - ] - } - ] - }, - { - "version": "1.4.1", - "dropdowns": [ - { - "dropdown": "Asset-Manager", - "pages": [ - "references/1.4.1/asset-manager/0-index", - { - "group": "AssetManagerLibrary", - "pages": [ - "references/1.4.1/asset-manager/AssetManagerLibrary/getAsset_1", - "references/1.4.1/asset-manager/AssetManagerLibrary/getAsset" - ], - "root": "references/1.4.1/asset-manager/AssetManagerLibrary" - } - ] - }, - { - "dropdown": "Common", - "pages": [ - "references/1.4.1/common/0-index", - { - "group": "ApplicationContext", - "pages": [ - "references/1.4.1/common/ApplicationContext/delta", - "references/1.4.1/common/ApplicationContext/isRunning" - ], - "root": "references/1.4.1/common/ApplicationContext" - }, - "references/1.4.1/common/ASSET_MANAGER_LIBRARY", - { - "group": "BaseAssetManagerLibrary", - "pages": [ - "references/1.4.1/common/BaseAssetManagerLibrary/getAsset_1", - "references/1.4.1/common/BaseAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.1/common/BaseAssetManagerLibrary" - }, - "references/1.4.1/common/BaseComponentSystemLibrary", - "references/1.4.1/common/BaseGraphicsLibrary", - "references/1.4.1/common/BaseInputLibrary", - { - "group": "BaseMusicLibrary", - "pages": [ - "references/1.4.1/common/BaseMusicLibrary/mute", - "references/1.4.1/common/BaseMusicLibrary/play" - ], - "root": "references/1.4.1/common/BaseMusicLibrary" - }, - "references/1.4.1/common/BaseNetworkLibrary", - { - "group": "BaseSoundLibrary", - "pages": [ - "references/1.4.1/common/BaseSoundLibrary/mute", - "references/1.4.1/common/BaseSoundLibrary/play" - ], - "root": "references/1.4.1/common/BaseSoundLibrary" - }, - "references/1.4.1/common/ClearContext", - { - "group": "ClientLibraryManager", - "pages": [ - "references/1.4.1/common/ClientLibraryManager/constructor", - "references/1.4.1/common/ClientLibraryManager/get", - "references/1.4.1/common/ClientLibraryManager/getAssetManager", - "references/1.4.1/common/ClientLibraryManager/getComponentSystem", - "references/1.4.1/common/ClientLibraryManager/getGraphics", - "references/1.4.1/common/ClientLibraryManager/getInput", - "references/1.4.1/common/ClientLibraryManager/getMusic", - "references/1.4.1/common/ClientLibraryManager/getNetwork", - "references/1.4.1/common/ClientLibraryManager/getSound" - ], - "root": "references/1.4.1/common/ClientLibraryManager" - }, - "references/1.4.1/common/COMPONENT_SYSTEM_LIBRARY", - { - "group": "Context", - "pages": [ - "references/1.4.1/common/Context/app", - "references/1.4.1/common/Context/constructor", - "references/1.4.1/common/Context/libs" - ], - "root": "references/1.4.1/common/Context" - }, - "references/1.4.1/common/DefaultLibrariesEnum", - "references/1.4.1/common/ExecutionContext", - "references/1.4.1/common/GRAPHICS_LIBRARY", - { - "group": "IAssetManagerLibrary", - "pages": [ - "references/1.4.1/common/IAssetManagerLibrary/getAsset_1", - "references/1.4.1/common/IAssetManagerLibrary/getAsset" - ], - "root": "references/1.4.1/common/IAssetManagerLibrary" - }, - "references/1.4.1/common/IComponentSystemLibrary", - { - "group": "IConfigRegistry", - "pages": [ - "references/1.4.1/common/IConfigRegistry/registerConfig" - ], - "root": "references/1.4.1/common/IConfigRegistry" - }, - "references/1.4.1/common/IExposedLibrary", - "references/1.4.1/common/IGraphicsLibrary", - "references/1.4.1/common/IInputLibrary", - "references/1.4.1/common/ILibrary", - "references/1.4.1/common/IMusicLibrary", - { - "group": "IMutableLibrary", - "pages": [ - "references/1.4.1/common/IMutableLibrary/mute" - ], - "root": "references/1.4.1/common/IMutableLibrary" - }, - "references/1.4.1/common/INetworkLibrary", - { - "group": "InitContext", - "pages": [ - "references/1.4.1/common/InitContext/config", - "references/1.4.1/common/InitContext/constructor", - "references/1.4.1/common/InitContext/container", - "references/1.4.1/common/InitContext/env", - "references/1.4.1/common/InitContext/files" - ], - "root": "references/1.4.1/common/InitContext" - }, - "references/1.4.1/common/INPUT_LIBRARY", - { - "group": "IRunClientOptions", - "pages": [ - "references/1.4.1/common/IRunClientOptions/container", - "references/1.4.1/common/IRunClientOptions/env", - "references/1.4.1/common/IRunClientOptions/files" - ], - "root": "references/1.4.1/common/IRunClientOptions" - }, - "references/1.4.1/common/IRunnerLibrary", - "references/1.4.1/common/IRunOptions", - { - "group": "IRunServerOptions", - "pages": [ - "references/1.4.1/common/IRunServerOptions/env", - "references/1.4.1/common/IRunServerOptions/files" - ], - "root": "references/1.4.1/common/IRunServerOptions" - }, - "references/1.4.1/common/ISoundLibrary", - { - "group": "Library", - "pages": [ - "references/1.4.1/common/Library/_relationship", - "references/1.4.1/common/Library/constructor" - ], - "root": "references/1.4.1/common/Library" - }, - { - "group": "LibraryContext", - "pages": [ - "references/1.4.1/common/LibraryContext/status" - ], - "root": "references/1.4.1/common/LibraryContext" - }, - { - "group": "LibraryHandle", - "pages": [ - "references/1.4.1/common/LibraryHandle/constructor", - "references/1.4.1/common/LibraryHandle/context", - "references/1.4.1/common/LibraryHandle/library", - "references/1.4.1/common/LibraryHandle/symbol" - ], - "root": "references/1.4.1/common/LibraryHandle" - }, - { - "group": "LibraryManager", - "pages": [ - "references/1.4.1/common/LibraryManager/constructor", - "references/1.4.1/common/LibraryManager/getAssetManager", - "references/1.4.1/common/LibraryManager/getComponentSystem", - "references/1.4.1/common/LibraryManager/getGraphics", - "references/1.4.1/common/LibraryManager/getInput", - "references/1.4.1/common/LibraryManager/getMusic", - "references/1.4.1/common/LibraryManager/getNetwork", - "references/1.4.1/common/LibraryManager/getSound" - ], - "root": "references/1.4.1/common/LibraryManager" - }, - "references/1.4.1/common/LibraryStatusEnum", - "references/1.4.1/common/MUSIC_LIBRARY", - "references/1.4.1/common/NETWORK_LIBRARY", - { - "group": "NfConfigException", - "pages": [ - "references/1.4.1/common/NfConfigException/code", - "references/1.4.1/common/NfConfigException/constructor" - ], - "root": "references/1.4.1/common/NfConfigException" - }, - { - "group": "NfFetchException", - "pages": [ - "references/1.4.1/common/NfFetchException/code", - "references/1.4.1/common/NfFetchException/constructor" - ], - "root": "references/1.4.1/common/NfFetchException" - }, - { - "group": "NfFile", - "pages": [ - "references/1.4.1/common/NfFile/arrayBuffer", - "references/1.4.1/common/NfFile/blob", - "references/1.4.1/common/NfFile/bytes", - "references/1.4.1/common/NfFile/constructor", - "references/1.4.1/common/NfFile/formData", - "references/1.4.1/common/NfFile/json", - "references/1.4.1/common/NfFile/path", - "references/1.4.1/common/NfFile/text" - ], - "root": "references/1.4.1/common/NfFile" - }, - { - "group": "NfNotFound", - "pages": [ - "references/1.4.1/common/NfNotFound/code", - "references/1.4.1/common/NfNotFound/constructor" - ], - "root": "references/1.4.1/common/NfNotFound" - }, - { - "group": "NfNotInitializedException", - "pages": [ - "references/1.4.1/common/NfNotInitializedException/code", - "references/1.4.1/common/NfNotInitializedException/constructor" - ], - "root": "references/1.4.1/common/NfNotInitializedException" - }, - "references/1.4.1/common/SOUND_LIBRARY" - ] - }, - { - "dropdown": "Config", - "pages": [ - "references/1.4.1/config/0-index", - "references/1.4.1/config/Default", - "references/1.4.1/config/IsIpOrURL", - "references/1.4.1/config/TransformToBoolean" - ] - }, - { - "dropdown": "Core", - "pages": [ - "references/1.4.1/core/0-index", - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.1/core/NanoforgeClient/useGraphics", - "references/1.4.1/core/NanoforgeClient/useInput", - "references/1.4.1/core/NanoforgeClient/useSound" - ], - "root": "references/1.4.1/core/NanoforgeClient" - }, - "references/1.4.1/core/NanoforgeFactory", - "references/1.4.1/core/NanoforgeServer" - ] - }, - { - "dropdown": "Core-Editor", - "pages": [ - "references/1.4.1/core-editor/0-index", - "references/1.4.1/core-editor/CoreEvents", - "references/1.4.1/core-editor/EditorEvents", - { - "group": "EventEmitter", - "pages": [ - "references/1.4.1/core-editor/EventEmitter/constructor", - "references/1.4.1/core-editor/EventEmitter/emit", - "references/1.4.1/core-editor/EventEmitter/on", - "references/1.4.1/core-editor/EventEmitter/runEvents" - ], - "root": "references/1.4.1/core-editor/EventEmitter" - }, - { - "group": "NanoforgeClient", - "pages": [ - "references/1.4.1/core-editor/NanoforgeClient/useGraphics", - "references/1.4.1/core-editor/NanoforgeClient/useInput", - "references/1.4.1/core-editor/NanoforgeClient/useSound" - ], - "root": "references/1.4.1/core-editor/NanoforgeClient" - }, - "references/1.4.1/core-editor/NanoforgeFactory", - "references/1.4.1/core-editor/NanoforgeServer" - ] - }, - { - "dropdown": "ECS-Client", - "pages": [ - "references/1.4.1/ecs-client/0-index", - { - "group": "ECSClientLibrary", - "pages": [ - "references/1.4.1/ecs-client/ECSClientLibrary/constructor" - ], - "root": "references/1.4.1/ecs-client/ECSClientLibrary" - } - ] - }, - { - "dropdown": "ECS-Lib", - "pages": [ - "references/1.4.1/ecs-lib/0-index", - { - "group": "AbstractECSLibrary", - "pages": [ - "references/1.4.1/ecs-lib/AbstractECSLibrary/_registry", - "references/1.4.1/ecs-lib/AbstractECSLibrary/constructor", - "references/1.4.1/ecs-lib/AbstractECSLibrary/module", - "references/1.4.1/ecs-lib/AbstractECSLibrary/path", - "references/1.4.1/ecs-lib/AbstractECSLibrary/registry" - ], - "root": "references/1.4.1/ecs-lib/AbstractECSLibrary" - }, - "references/1.4.1/ecs-lib/Component", - "references/1.4.1/ecs-lib/EditorComponentManifest", - "references/1.4.1/ecs-lib/EditorSystemManifest", - { - "group": "Entity", - "pages": [ - "references/1.4.1/ecs-lib/Entity/getId" - ], - "root": "references/1.4.1/ecs-lib/Entity" - }, - { - "group": "Registry", - "pages": [ - "references/1.4.1/ecs-lib/Registry/addComponent", - "references/1.4.1/ecs-lib/Registry/addSystem", - "references/1.4.1/ecs-lib/Registry/clearEntities", - "references/1.4.1/ecs-lib/Registry/clearSystems", - "references/1.4.1/ecs-lib/Registry/entityFromIndex", - "references/1.4.1/ecs-lib/Registry/getComponents", - "references/1.4.1/ecs-lib/Registry/getComponentsConst", - "references/1.4.1/ecs-lib/Registry/getEntityComponent", - "references/1.4.1/ecs-lib/Registry/getEntityComponentConst", - "references/1.4.1/ecs-lib/Registry/getIndexedZipper", - "references/1.4.1/ecs-lib/Registry/getZipper", - "references/1.4.1/ecs-lib/Registry/killEntity", - "references/1.4.1/ecs-lib/Registry/maxEntities", - "references/1.4.1/ecs-lib/Registry/registerComponent", - "references/1.4.1/ecs-lib/Registry/removeComponent", - "references/1.4.1/ecs-lib/Registry/removeSystem", - "references/1.4.1/ecs-lib/Registry/runSystems", - "references/1.4.1/ecs-lib/Registry/spawnEntity" - ], - "root": "references/1.4.1/ecs-lib/Registry" - }, - { - "group": "SparseArray", - "pages": [ - "references/1.4.1/ecs-lib/SparseArray/clear", - "references/1.4.1/ecs-lib/SparseArray/empty", - "references/1.4.1/ecs-lib/SparseArray/erase", - "references/1.4.1/ecs-lib/SparseArray/get", - "references/1.4.1/ecs-lib/SparseArray/getConst", - "references/1.4.1/ecs-lib/SparseArray/getIndex", - "references/1.4.1/ecs-lib/SparseArray/insertAt_1", - "references/1.4.1/ecs-lib/SparseArray/insertAt", - "references/1.4.1/ecs-lib/SparseArray/resize", - "references/1.4.1/ecs-lib/SparseArray/set", - "references/1.4.1/ecs-lib/SparseArray/setByCopy", - "references/1.4.1/ecs-lib/SparseArray/setByMove", - "references/1.4.1/ecs-lib/SparseArray/size" - ], - "root": "references/1.4.1/ecs-lib/SparseArray" - }, - "references/1.4.1/ecs-lib/System" - ] - }, - { - "dropdown": "ECS-Server", - "pages": [ - "references/1.4.1/ecs-server/0-index", - { - "group": "ECSServerLibrary", - "pages": [ - "references/1.4.1/ecs-server/ECSServerLibrary/constructor" - ], - "root": "references/1.4.1/ecs-server/ECSServerLibrary" - }, - "references/1.4.1/ecs-server/Module" - ] - }, - { - "dropdown": "Graphics-2d", - "pages": [ - "references/1.4.1/graphics-2d/0-index", - "references/1.4.1/graphics-2d/Animation_2", - "references/1.4.1/graphics-2d/Arc", - "references/1.4.1/graphics-2d/ArcConfig", - "references/1.4.1/graphics-2d/Arrow", - "references/1.4.1/graphics-2d/ArrowConfig", - "references/1.4.1/graphics-2d/Canvas", - "references/1.4.1/graphics-2d/Circle", - "references/1.4.1/graphics-2d/CircleConfig", - "references/1.4.1/graphics-2d/Container", - "references/1.4.1/graphics-2d/ContainerConfig", - "references/1.4.1/graphics-2d/Context", - "references/1.4.1/graphics-2d/DD", - "references/1.4.1/graphics-2d/Easings", - "references/1.4.1/graphics-2d/Ellipse", - "references/1.4.1/graphics-2d/EllipseConfig", - "references/1.4.1/graphics-2d/FastLayer", - "references/1.4.1/graphics-2d/Filters", - { - "group": "Graphics2DLibrary", - "pages": [ - "references/1.4.1/graphics-2d/Graphics2DLibrary/baseLayer", - "references/1.4.1/graphics-2d/Graphics2DLibrary/stage" - ], - "root": "references/1.4.1/graphics-2d/Graphics2DLibrary" - }, - "references/1.4.1/graphics-2d/Group", - "references/1.4.1/graphics-2d/GroupConfig", - "references/1.4.1/graphics-2d/Image_2", - "references/1.4.1/graphics-2d/ImageConfig", - "references/1.4.1/graphics-2d/KonvaEventListener", - "references/1.4.1/graphics-2d/KonvaEventObject", - "references/1.4.1/graphics-2d/KonvaPointerEvent", - "references/1.4.1/graphics-2d/Label", - "references/1.4.1/graphics-2d/LabelConfig", - "references/1.4.1/graphics-2d/Layer", - "references/1.4.1/graphics-2d/LayerConfig", - "references/1.4.1/graphics-2d/Line", - "references/1.4.1/graphics-2d/LineConfig", - "references/1.4.1/graphics-2d/Node_2", - "references/1.4.1/graphics-2d/NodeConfig", - "references/1.4.1/graphics-2d/Path", - "references/1.4.1/graphics-2d/PathConfig", - "references/1.4.1/graphics-2d/Rect", - "references/1.4.1/graphics-2d/RectConfig", - "references/1.4.1/graphics-2d/RegularPolygon", - "references/1.4.1/graphics-2d/RegularPolygonConfig", - "references/1.4.1/graphics-2d/Ring", - "references/1.4.1/graphics-2d/RingConfig", - "references/1.4.1/graphics-2d/Shape", - "references/1.4.1/graphics-2d/ShapeConfig", - "references/1.4.1/graphics-2d/Sprite", - "references/1.4.1/graphics-2d/SpriteConfig", - "references/1.4.1/graphics-2d/Stage", - "references/1.4.1/graphics-2d/StageConfig", - "references/1.4.1/graphics-2d/Star", - "references/1.4.1/graphics-2d/StarConfig", - "references/1.4.1/graphics-2d/Tag", - "references/1.4.1/graphics-2d/TagConfig", - "references/1.4.1/graphics-2d/Text_2", - "references/1.4.1/graphics-2d/TextConfig", - "references/1.4.1/graphics-2d/TextPath", - "references/1.4.1/graphics-2d/TextPathConfig", - "references/1.4.1/graphics-2d/Transform", - "references/1.4.1/graphics-2d/Transformer_2", - "references/1.4.1/graphics-2d/TransformerConfig", - "references/1.4.1/graphics-2d/Tween", - "references/1.4.1/graphics-2d/TweenConfig", - "references/1.4.1/graphics-2d/Util", - "references/1.4.1/graphics-2d/Vector2d", - "references/1.4.1/graphics-2d/Wedge", - "references/1.4.1/graphics-2d/WedgeConfig" - ] - }, - { - "dropdown": "Input", - "pages": [ - "references/1.4.1/input/0-index", - "references/1.4.1/input/InputEnum", - { - "group": "InputLibrary", - "pages": [ - "references/1.4.1/input/InputLibrary/constructor", - "references/1.4.1/input/InputLibrary/getDragState", - "references/1.4.1/input/InputLibrary/getMousePosition", - "references/1.4.1/input/InputLibrary/getMouseState", - "references/1.4.1/input/InputLibrary/getPressedKeys", - "references/1.4.1/input/InputLibrary/getWheelState", - "references/1.4.1/input/InputLibrary/isDragging", - "references/1.4.1/input/InputLibrary/isKeyPressed" - ], - "root": "references/1.4.1/input/InputLibrary" - } - ] - }, - { - "dropdown": "Music", - "pages": [ - "references/1.4.1/music/0-index", - { - "group": "MusicLibrary", - "pages": [ - "references/1.4.1/music/MusicLibrary/load", - "references/1.4.1/music/MusicLibrary/mute", - "references/1.4.1/music/MusicLibrary/play" - ], - "root": "references/1.4.1/music/MusicLibrary" - } - ] - }, - { - "dropdown": "Network-Client", - "pages": [ - "references/1.4.1/network-client/0-index", - { - "group": "NetworkClientLibrary", - "pages": [ - "references/1.4.1/network-client/NetworkClientLibrary/tcp", - "references/1.4.1/network-client/NetworkClientLibrary/udp" - ], - "root": "references/1.4.1/network-client/NetworkClientLibrary" - }, - { - "group": "TCPClient", - "pages": [ - "references/1.4.1/network-client/TCPClient/connect", - "references/1.4.1/network-client/TCPClient/constructor", - "references/1.4.1/network-client/TCPClient/getReceivedPackets", - "references/1.4.1/network-client/TCPClient/isConnected", - "references/1.4.1/network-client/TCPClient/sendData" - ], - "root": "references/1.4.1/network-client/TCPClient" - }, - { - "group": "UDPClient", - "pages": [ - "references/1.4.1/network-client/UDPClient/connect", - "references/1.4.1/network-client/UDPClient/constructor", - "references/1.4.1/network-client/UDPClient/getReceivedPackets", - "references/1.4.1/network-client/UDPClient/isConnected", - "references/1.4.1/network-client/UDPClient/sendData" - ], - "root": "references/1.4.1/network-client/UDPClient" - } - ] - }, - { - "dropdown": "Network-Server", - "pages": [ - "references/1.4.1/network-server/0-index", - { - "group": "NetworkServerLibrary", - "pages": [ - "references/1.4.1/network-server/NetworkServerLibrary/tcp", - "references/1.4.1/network-server/NetworkServerLibrary/udp" - ], - "root": "references/1.4.1/network-server/NetworkServerLibrary" - }, - { - "group": "TCPServer", - "pages": [ - "references/1.4.1/network-server/TCPServer/constructor", - "references/1.4.1/network-server/TCPServer/getConnectedClients", - "references/1.4.1/network-server/TCPServer/getReceivedPackets", - "references/1.4.1/network-server/TCPServer/listen", - "references/1.4.1/network-server/TCPServer/sendToClient", - "references/1.4.1/network-server/TCPServer/sendToEverybody" - ], - "root": "references/1.4.1/network-server/TCPServer" - }, - { - "group": "UDPServer", - "pages": [ - "references/1.4.1/network-server/UDPServer/constructor", - "references/1.4.1/network-server/UDPServer/getConnectedClients", - "references/1.4.1/network-server/UDPServer/getReceivedPackets", - "references/1.4.1/network-server/UDPServer/listen", - "references/1.4.1/network-server/UDPServer/sendToClient", - "references/1.4.1/network-server/UDPServer/sendToEverybody" - ], - "root": "references/1.4.1/network-server/UDPServer" - } - ] - }, - { - "dropdown": "Sound", - "pages": [ - "references/1.4.1/sound/0-index", - { - "group": "SoundLibrary", - "pages": [ - "references/1.4.1/sound/SoundLibrary/load", - "references/1.4.1/sound/SoundLibrary/mute", - "references/1.4.1/sound/SoundLibrary/play" - ], - "root": "references/1.4.1/sound/SoundLibrary" - } - ] - } - ] - }, - { - "version": "1.3.0", - "dropdowns": [ - { - "dropdown": "Asset-Manager", - "pages": [ - "references/1.3.0/asset-manager/index", - { - "group": "Asset-Manager", - "pages": [ - { - "group": "AssetManagerLibrary", - "pages": [ - "references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__init", - "references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__name", - "references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/getAsset" - ], - "root": "references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary" - } - ], - "root": "references/1.3.0/asset-manager/asset-manager" - } - ] - }, - { - "dropdown": "Common", - "pages": [ - "references/1.3.0/common/index", - { - "group": "Common", - "pages": [ - { - "group": "ApplicationContext", - "pages": [ - "references/1.3.0/common/common/ApplicationContext/_delta", - "references/1.3.0/common/common/ApplicationContext/delta", - "references/1.3.0/common/common/ApplicationContext/isRunning", - "references/1.3.0/common/common/ApplicationContext/muteSoundLibraries", - "references/1.3.0/common/common/ApplicationContext/setIsRunning" - ], - "root": "references/1.3.0/common/common/ApplicationContext" - }, - "references/1.3.0/common/common/ASSET_MANAGER_LIBRARY", - { - "group": "BaseAssetManagerLibrary", - "pages": [ - "references/1.3.0/common/common/BaseAssetManagerLibrary/__init", - "references/1.3.0/common/common/BaseAssetManagerLibrary/getAsset" - ], - "root": "references/1.3.0/common/common/BaseAssetManagerLibrary" - }, - { - "group": "BaseComponentSystemLibrary", - "pages": [ - "references/1.3.0/common/common/BaseComponentSystemLibrary/__run" - ], - "root": "references/1.3.0/common/common/BaseComponentSystemLibrary" - }, - { - "group": "BaseGraphicsLibrary", - "pages": [ - "references/1.3.0/common/common/BaseGraphicsLibrary/__run" - ], - "root": "references/1.3.0/common/common/BaseGraphicsLibrary" - }, - { - "group": "BaseInputLibrary", - "pages": [ - "references/1.3.0/common/common/BaseInputLibrary/__run" - ], - "root": "references/1.3.0/common/common/BaseInputLibrary" - }, - { - "group": "BaseMusicLibrary", - "pages": [ - "references/1.3.0/common/common/BaseMusicLibrary/__init", - "references/1.3.0/common/common/BaseMusicLibrary/mute", - "references/1.3.0/common/common/BaseMusicLibrary/play" - ], - "root": "references/1.3.0/common/common/BaseMusicLibrary" - }, - "references/1.3.0/common/common/BaseNetworkLibrary", - { - "group": "BaseSoundLibrary", - "pages": [ - "references/1.3.0/common/common/BaseSoundLibrary/__init", - "references/1.3.0/common/common/BaseSoundLibrary/mute", - "references/1.3.0/common/common/BaseSoundLibrary/play" - ], - "root": "references/1.3.0/common/common/BaseSoundLibrary" - }, - "references/1.3.0/common/common/ClearContext", - { - "group": "ClientLibraryManager", - "pages": [ - "references/1.3.0/common/common/ClientLibraryManager/constructor", - "references/1.3.0/common/common/ClientLibraryManager/get", - "references/1.3.0/common/common/ClientLibraryManager/getAssetManager", - "references/1.3.0/common/common/ClientLibraryManager/getComponentSystem", - "references/1.3.0/common/common/ClientLibraryManager/getGraphics", - "references/1.3.0/common/common/ClientLibraryManager/getInput", - "references/1.3.0/common/common/ClientLibraryManager/getMusic", - "references/1.3.0/common/common/ClientLibraryManager/getNetwork", - "references/1.3.0/common/common/ClientLibraryManager/getSound" - ], - "root": "references/1.3.0/common/common/ClientLibraryManager" - }, - "references/1.3.0/common/common/COMPONENT_SYSTEM_LIBRARY", - { - "group": "Context", - "pages": [ - "references/1.3.0/common/common/Context/app", - "references/1.3.0/common/common/Context/constructor", - "references/1.3.0/common/common/Context/libs" - ], - "root": "references/1.3.0/common/common/Context" - }, - "references/1.3.0/common/common/DefaultLibrariesEnum", - "references/1.3.0/common/common/ExecutionContext", - "references/1.3.0/common/common/GRAPHICS_LIBRARY", - { - "group": "IAssetManagerLibrary", - "pages": [ - "references/1.3.0/common/common/IAssetManagerLibrary/getAsset" - ], - "root": "references/1.3.0/common/common/IAssetManagerLibrary" - }, - "references/1.3.0/common/common/IComponentSystemLibrary", - { - "group": "IConfigRegistry", - "pages": [ - "references/1.3.0/common/common/IConfigRegistry/registerConfig" - ], - "root": "references/1.3.0/common/common/IConfigRegistry" - }, - "references/1.3.0/common/common/IExposedLibrary", - "references/1.3.0/common/common/IGraphicsLibrary", - "references/1.3.0/common/common/IInputLibrary", - { - "group": "ILibrary", - "pages": [ - "references/1.3.0/common/common/ILibrary/__clear", - "references/1.3.0/common/common/ILibrary/__init", - "references/1.3.0/common/common/ILibrary/__name", - "references/1.3.0/common/common/ILibrary/__relationship" - ], - "root": "references/1.3.0/common/common/ILibrary" - }, - "references/1.3.0/common/common/IMusicLibrary", - { - "group": "IMutableLibrary", - "pages": [ - "references/1.3.0/common/common/IMutableLibrary/mute" - ], - "root": "references/1.3.0/common/common/IMutableLibrary" - }, - "references/1.3.0/common/common/INetworkLibrary", - { - "group": "InitContext", - "pages": [ - "references/1.3.0/common/common/InitContext/config", - "references/1.3.0/common/common/InitContext/constructor", - "references/1.3.0/common/common/InitContext/container", - "references/1.3.0/common/common/InitContext/env", - "references/1.3.0/common/common/InitContext/files" - ], - "root": "references/1.3.0/common/common/InitContext" - }, - "references/1.3.0/common/common/INPUT_LIBRARY", - { - "group": "IRunClientOptions", - "pages": [ - "references/1.3.0/common/common/IRunClientOptions/container", - "references/1.3.0/common/common/IRunClientOptions/env", - "references/1.3.0/common/common/IRunClientOptions/files" - ], - "root": "references/1.3.0/common/common/IRunClientOptions" - }, - { - "group": "IRunnerLibrary", - "pages": [ - "references/1.3.0/common/common/IRunnerLibrary/__run" - ], - "root": "references/1.3.0/common/common/IRunnerLibrary" - }, - "references/1.3.0/common/common/IRunOptions", - { - "group": "IRunServerOptions", - "pages": [ - "references/1.3.0/common/common/IRunServerOptions/env", - "references/1.3.0/common/common/IRunServerOptions/files" - ], - "root": "references/1.3.0/common/common/IRunServerOptions" - }, - "references/1.3.0/common/common/ISoundLibrary", - { - "group": "LibraryContext", - "pages": [ - "references/1.3.0/common/common/LibraryContext/_status", - "references/1.3.0/common/common/LibraryContext/status" - ], - "root": "references/1.3.0/common/common/LibraryContext" - }, - { - "group": "LibraryHandle", - "pages": [ - "references/1.3.0/common/common/LibraryHandle/constructor", - "references/1.3.0/common/common/LibraryHandle/context", - "references/1.3.0/common/common/LibraryHandle/library", - "references/1.3.0/common/common/LibraryHandle/symbol" - ], - "root": "references/1.3.0/common/common/LibraryHandle" - }, - { - "group": "LibraryManager", - "pages": [ - "references/1.3.0/common/common/LibraryManager/constructor", - "references/1.3.0/common/common/LibraryManager/getAssetManager", - "references/1.3.0/common/common/LibraryManager/getComponentSystem", - "references/1.3.0/common/common/LibraryManager/getGraphics", - "references/1.3.0/common/common/LibraryManager/getInput", - "references/1.3.0/common/common/LibraryManager/getMusic", - "references/1.3.0/common/common/LibraryManager/getNetwork", - "references/1.3.0/common/common/LibraryManager/getSound" - ], - "root": "references/1.3.0/common/common/LibraryManager" - }, - "references/1.3.0/common/common/LibraryStatusEnum", - "references/1.3.0/common/common/MUSIC_LIBRARY", - "references/1.3.0/common/common/NETWORK_LIBRARY", - { - "group": "NfConfigException", - "pages": [ - "references/1.3.0/common/common/NfConfigException/code", - "references/1.3.0/common/common/NfConfigException/constructor" - ], - "root": "references/1.3.0/common/common/NfConfigException" - }, - { - "group": "NfFetchException", - "pages": [ - "references/1.3.0/common/common/NfFetchException/code", - "references/1.3.0/common/common/NfFetchException/constructor" - ], - "root": "references/1.3.0/common/common/NfFetchException" - }, - { - "group": "NfFile", - "pages": [ - "references/1.3.0/common/common/NfFile/arrayBuffer", - "references/1.3.0/common/common/NfFile/blob", - "references/1.3.0/common/common/NfFile/bytes", - "references/1.3.0/common/common/NfFile/constructor", - "references/1.3.0/common/common/NfFile/formData", - "references/1.3.0/common/common/NfFile/json", - "references/1.3.0/common/common/NfFile/path", - "references/1.3.0/common/common/NfFile/text" - ], - "root": "references/1.3.0/common/common/NfFile" - }, - { - "group": "NfNotFound", - "pages": [ - "references/1.3.0/common/common/NfNotFound/code", - "references/1.3.0/common/common/NfNotFound/constructor" - ], - "root": "references/1.3.0/common/common/NfNotFound" - }, - { - "group": "NfNotInitializedException", - "pages": [ - "references/1.3.0/common/common/NfNotInitializedException/code", - "references/1.3.0/common/common/NfNotInitializedException/constructor" - ], - "root": "references/1.3.0/common/common/NfNotInitializedException" - }, - "references/1.3.0/common/common/SOUND_LIBRARY" - ], - "root": "references/1.3.0/common/common" - } - ] - }, - { - "dropdown": "Config", - "pages": [ - "references/1.3.0/config/index", - { - "group": "Config", - "pages": [ - "references/1.3.0/config/config/Default", - "references/1.3.0/config/config/IsIpOrFQDN", - "references/1.3.0/config/config/TransformToBoolean" - ], - "root": "references/1.3.0/config/config" - } - ] - }, - { - "dropdown": "Core", - "pages": [ - "references/1.3.0/core/index", - { - "group": "Core", - "pages": [ - { - "group": "NanoforgeClient", - "pages": [ - "references/1.3.0/core/core/NanoforgeClient/useGraphics", - "references/1.3.0/core/core/NanoforgeClient/useInput", - "references/1.3.0/core/core/NanoforgeClient/useSound" - ], - "root": "references/1.3.0/core/core/NanoforgeClient" - }, - "references/1.3.0/core/core/NanoforgeFactory", - "references/1.3.0/core/core/NanoforgeServer" - ], - "root": "references/1.3.0/core/core" - } - ] - }, - { - "dropdown": "Core-Editor", - "pages": [ - "references/1.3.0/core-editor/index", - { - "group": "Core-Editor", - "pages": [ - { - "group": "NanoforgeClient", - "pages": [ - "references/1.3.0/core-editor/core-editor/NanoforgeClient/useGraphics", - "references/1.3.0/core-editor/core-editor/NanoforgeClient/useInput", - "references/1.3.0/core-editor/core-editor/NanoforgeClient/useSound" - ], - "root": "references/1.3.0/core-editor/core-editor/NanoforgeClient" - }, - "references/1.3.0/core-editor/core-editor/NanoforgeFactory", - "references/1.3.0/core-editor/core-editor/NanoforgeServer" - ], - "root": "references/1.3.0/core-editor/core-editor" - } - ] - }, - { - "dropdown": "ECS-Client", - "pages": [ - "references/1.3.0/ecs-client/index", - { - "group": "ECS-Client", - "pages": [ - { - "group": "ECSClientLibrary", - "pages": [ - "references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__init", - "references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__name", - "references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/constructor" - ], - "root": "references/1.3.0/ecs-client/ecs-client/ECSClientLibrary" - } - ], - "root": "references/1.3.0/ecs-client/ecs-client" - } - ] - }, - { - "dropdown": "ECS-Lib", - "pages": [ - "references/1.3.0/ecs-lib/index", - { - "group": "ECS-Lib", - "pages": [ - { - "group": "AbstractECSLibrary", - "pages": [ - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__name", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__run", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/_registry", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/constructor", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/module", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/path", - "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/registry" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary" - }, - "references/1.3.0/ecs-lib/ecs-lib/Component", - "references/1.3.0/ecs-lib/ecs-lib/EditorComponentManifest", - "references/1.3.0/ecs-lib/ecs-lib/EditorSystemManifest", - { - "group": "Entity", - "pages": [ - "references/1.3.0/ecs-lib/ecs-lib/Entity/getId" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib/Entity" - }, - { - "group": "Registry", - "pages": [ - "references/1.3.0/ecs-lib/ecs-lib/Registry/addComponent", - "references/1.3.0/ecs-lib/ecs-lib/Registry/addSystem", - "references/1.3.0/ecs-lib/ecs-lib/Registry/clearEntities", - "references/1.3.0/ecs-lib/ecs-lib/Registry/clearSystems", - "references/1.3.0/ecs-lib/ecs-lib/Registry/entityFromIndex", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getComponents", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getComponentsConst", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponent", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponentConst", - "references/1.3.0/ecs-lib/ecs-lib/Registry/getZipper", - "references/1.3.0/ecs-lib/ecs-lib/Registry/killEntity", - "references/1.3.0/ecs-lib/ecs-lib/Registry/maxEntities", - "references/1.3.0/ecs-lib/ecs-lib/Registry/registerComponent", - "references/1.3.0/ecs-lib/ecs-lib/Registry/removeComponent", - "references/1.3.0/ecs-lib/ecs-lib/Registry/removeSystem", - "references/1.3.0/ecs-lib/ecs-lib/Registry/runSystems", - "references/1.3.0/ecs-lib/ecs-lib/Registry/spawnEntity" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib/Registry" - }, - { - "group": "SparseArray", - "pages": [ - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/clear", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/empty", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/erase", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/get", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/getConst", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/getIndex", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt_1", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/resize", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/set", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByCopy", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByMove", - "references/1.3.0/ecs-lib/ecs-lib/SparseArray/size" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib/SparseArray" - }, - "references/1.3.0/ecs-lib/ecs-lib/System" - ], - "root": "references/1.3.0/ecs-lib/ecs-lib" - } - ] - }, - { - "dropdown": "ECS-Server", - "pages": [ - "references/1.3.0/ecs-server/index", - { - "group": "ECS-Server", - "pages": [ - { - "group": "ECSServerLibrary", - "pages": [ - "references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__init", - "references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__name", - "references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/constructor" - ], - "root": "references/1.3.0/ecs-server/ecs-server/ECSServerLibrary" - }, - "references/1.3.0/ecs-server/ecs-server/Module" - ], - "root": "references/1.3.0/ecs-server/ecs-server" - } - ] - }, - { - "dropdown": "Graphics-2d", - "pages": [ - "references/1.3.0/graphics-2d/index", - { - "group": "Graphics-2d", - "pages": [ - "references/1.3.0/graphics-2d/graphics-2d/_global", - "references/1.3.0/graphics-2d/graphics-2d/_injectGlobal", - "references/1.3.0/graphics-2d/graphics-2d/_mouseDblClickPointerId", - "references/1.3.0/graphics-2d/graphics-2d/_mouseInDblClickWindow", - "references/1.3.0/graphics-2d/graphics-2d/_mouseListenClick", - "references/1.3.0/graphics-2d/graphics-2d/_pointerDblClickPointerId", - "references/1.3.0/graphics-2d/graphics-2d/_pointerInDblClickWindow", - "references/1.3.0/graphics-2d/graphics-2d/_pointerListenClick", - "references/1.3.0/graphics-2d/graphics-2d/_renderBackend", - "references/1.3.0/graphics-2d/graphics-2d/_touchDblClickPointerId", - "references/1.3.0/graphics-2d/graphics-2d/_touchInDblClickWindow", - "references/1.3.0/graphics-2d/graphics-2d/_touchListenClick", - "references/1.3.0/graphics-2d/graphics-2d/angleDeg", - "references/1.3.0/graphics-2d/graphics-2d/Animation_2", - "references/1.3.0/graphics-2d/graphics-2d/Arc", - "references/1.3.0/graphics-2d/graphics-2d/ArcConfig", - "references/1.3.0/graphics-2d/graphics-2d/Arrow", - "references/1.3.0/graphics-2d/graphics-2d/ArrowConfig", - "references/1.3.0/graphics-2d/graphics-2d/autoDrawEnabled", - "references/1.3.0/graphics-2d/graphics-2d/Canvas", - "references/1.3.0/graphics-2d/graphics-2d/capturePointerEventsEnabled", - "references/1.3.0/graphics-2d/graphics-2d/Circle", - "references/1.3.0/graphics-2d/graphics-2d/CircleConfig", - "references/1.3.0/graphics-2d/graphics-2d/Container", - "references/1.3.0/graphics-2d/graphics-2d/ContainerConfig", - "references/1.3.0/graphics-2d/graphics-2d/Context", - "references/1.3.0/graphics-2d/graphics-2d/dblClickWindow", - "references/1.3.0/graphics-2d/graphics-2d/DD", - "references/1.3.0/graphics-2d/graphics-2d/document_2", - "references/1.3.0/graphics-2d/graphics-2d/dragButtons", - "references/1.3.0/graphics-2d/graphics-2d/dragDistance", - "references/1.3.0/graphics-2d/graphics-2d/Easings", - "references/1.3.0/graphics-2d/graphics-2d/Ellipse", - "references/1.3.0/graphics-2d/graphics-2d/EllipseConfig", - "references/1.3.0/graphics-2d/graphics-2d/enableTrace", - "references/1.3.0/graphics-2d/graphics-2d/FastLayer", - "references/1.3.0/graphics-2d/graphics-2d/Filters", - "references/1.3.0/graphics-2d/graphics-2d/getAngle", - { - "group": "Graphics2DLibrary", - "pages": [ - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__init", - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__name", - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__run", - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/baseLayer", - "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/stage" - ], - "root": "references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary" - }, - "references/1.3.0/graphics-2d/graphics-2d/Group", - "references/1.3.0/graphics-2d/graphics-2d/GroupConfig", - "references/1.3.0/graphics-2d/graphics-2d/hitOnDragEnabled", - "references/1.3.0/graphics-2d/graphics-2d/Image_2", - "references/1.3.0/graphics-2d/graphics-2d/ImageConfig", - "references/1.3.0/graphics-2d/graphics-2d/isBrowser", - "references/1.3.0/graphics-2d/graphics-2d/isDragging", - "references/1.3.0/graphics-2d/graphics-2d/isDragReady", - "references/1.3.0/graphics-2d/graphics-2d/isTransforming", - "references/1.3.0/graphics-2d/graphics-2d/isUnminified", - "references/1.3.0/graphics-2d/graphics-2d/KonvaEventListener", - "references/1.3.0/graphics-2d/graphics-2d/KonvaEventObject", - "references/1.3.0/graphics-2d/graphics-2d/KonvaPointerEvent", - "references/1.3.0/graphics-2d/graphics-2d/Label", - "references/1.3.0/graphics-2d/graphics-2d/LabelConfig", - "references/1.3.0/graphics-2d/graphics-2d/Layer", - "references/1.3.0/graphics-2d/graphics-2d/LayerConfig", - "references/1.3.0/graphics-2d/graphics-2d/legacyTextRendering", - "references/1.3.0/graphics-2d/graphics-2d/Line", - "references/1.3.0/graphics-2d/graphics-2d/LineConfig", - "references/1.3.0/graphics-2d/graphics-2d/Node_2", - "references/1.3.0/graphics-2d/graphics-2d/NodeConfig", - "references/1.3.0/graphics-2d/graphics-2d/Path", - "references/1.3.0/graphics-2d/graphics-2d/PathConfig", - "references/1.3.0/graphics-2d/graphics-2d/pixelRatio", - "references/1.3.0/graphics-2d/graphics-2d/pointerEventsEnabled", - "references/1.3.0/graphics-2d/graphics-2d/Rect", - "references/1.3.0/graphics-2d/graphics-2d/RectConfig", - "references/1.3.0/graphics-2d/graphics-2d/RegularPolygon", - "references/1.3.0/graphics-2d/graphics-2d/RegularPolygonConfig", - "references/1.3.0/graphics-2d/graphics-2d/releaseCanvasOnDestroy", - "references/1.3.0/graphics-2d/graphics-2d/Ring", - "references/1.3.0/graphics-2d/graphics-2d/RingConfig", - "references/1.3.0/graphics-2d/graphics-2d/Shape", - "references/1.3.0/graphics-2d/graphics-2d/ShapeConfig", - "references/1.3.0/graphics-2d/graphics-2d/shapes", - "references/1.3.0/graphics-2d/graphics-2d/showWarnings", - "references/1.3.0/graphics-2d/graphics-2d/Sprite", - "references/1.3.0/graphics-2d/graphics-2d/SpriteConfig", - "references/1.3.0/graphics-2d/graphics-2d/Stage", - "references/1.3.0/graphics-2d/graphics-2d/StageConfig", - "references/1.3.0/graphics-2d/graphics-2d/stages", - "references/1.3.0/graphics-2d/graphics-2d/Star", - "references/1.3.0/graphics-2d/graphics-2d/StarConfig", - "references/1.3.0/graphics-2d/graphics-2d/Tag", - "references/1.3.0/graphics-2d/graphics-2d/TagConfig", - "references/1.3.0/graphics-2d/graphics-2d/Text_2", - "references/1.3.0/graphics-2d/graphics-2d/TextConfig", - "references/1.3.0/graphics-2d/graphics-2d/TextPath", - "references/1.3.0/graphics-2d/graphics-2d/TextPathConfig", - "references/1.3.0/graphics-2d/graphics-2d/Transform", - "references/1.3.0/graphics-2d/graphics-2d/Transformer_2", - "references/1.3.0/graphics-2d/graphics-2d/TransformerConfig", - "references/1.3.0/graphics-2d/graphics-2d/Tween", - "references/1.3.0/graphics-2d/graphics-2d/TweenConfig", - "references/1.3.0/graphics-2d/graphics-2d/Util", - "references/1.3.0/graphics-2d/graphics-2d/Vector2d", - "references/1.3.0/graphics-2d/graphics-2d/version", - "references/1.3.0/graphics-2d/graphics-2d/Wedge", - "references/1.3.0/graphics-2d/graphics-2d/WedgeConfig" - ], - "root": "references/1.3.0/graphics-2d/graphics-2d" - } - ] - }, - { - "dropdown": "Input", - "pages": [ - "references/1.3.0/input/index", - { - "group": "Input", - "pages": [ - "references/1.3.0/input/input/InputEnum", - { - "group": "InputLibrary", - "pages": [ - "references/1.3.0/input/input/InputLibrary/__init", - "references/1.3.0/input/input/InputLibrary/__name", - "references/1.3.0/input/input/InputLibrary/__run", - "references/1.3.0/input/input/InputLibrary/constructor", - "references/1.3.0/input/input/InputLibrary/getDragState", - "references/1.3.0/input/input/InputLibrary/getMousePosition", - "references/1.3.0/input/input/InputLibrary/getMouseState", - "references/1.3.0/input/input/InputLibrary/getPressedKeys", - "references/1.3.0/input/input/InputLibrary/getWheelState", - "references/1.3.0/input/input/InputLibrary/isDragging", - "references/1.3.0/input/input/InputLibrary/isKeyPressed" - ], - "root": "references/1.3.0/input/input/InputLibrary" - } - ], - "root": "references/1.3.0/input/input" - } - ] - }, - { - "dropdown": "Music", - "pages": [ - "references/1.3.0/music/index", - { - "group": "Music", - "pages": [ - { - "group": "MusicLibrary", - "pages": [ - "references/1.3.0/music/music/MusicLibrary/__init", - "references/1.3.0/music/music/MusicLibrary/__name", - "references/1.3.0/music/music/MusicLibrary/load", - "references/1.3.0/music/music/MusicLibrary/mute", - "references/1.3.0/music/music/MusicLibrary/play" - ], - "root": "references/1.3.0/music/music/MusicLibrary" - } - ], - "root": "references/1.3.0/music/music" - } - ] - }, - { - "dropdown": "Network-Client", - "pages": [ - "references/1.3.0/network-client/index", - { - "group": "Network-Client", - "pages": [ - { - "group": "NetworkClientLibrary", - "pages": [ - "references/1.3.0/network-client/network-client/NetworkClientLibrary/__init", - "references/1.3.0/network-client/network-client/NetworkClientLibrary/__name", - "references/1.3.0/network-client/network-client/NetworkClientLibrary/tcp", - "references/1.3.0/network-client/network-client/NetworkClientLibrary/udp" - ], - "root": "references/1.3.0/network-client/network-client/NetworkClientLibrary" - }, - { - "group": "TCPClient", - "pages": [ - "references/1.3.0/network-client/network-client/TCPClient/connect", - "references/1.3.0/network-client/network-client/TCPClient/constructor", - "references/1.3.0/network-client/network-client/TCPClient/getReceivedPackets", - "references/1.3.0/network-client/network-client/TCPClient/isConnected", - "references/1.3.0/network-client/network-client/TCPClient/sendData" - ], - "root": "references/1.3.0/network-client/network-client/TCPClient" - }, - { - "group": "UDPClient", - "pages": [ - "references/1.3.0/network-client/network-client/UDPClient/connect", - "references/1.3.0/network-client/network-client/UDPClient/constructor", - "references/1.3.0/network-client/network-client/UDPClient/getReceivedPackets", - "references/1.3.0/network-client/network-client/UDPClient/isConnected", - "references/1.3.0/network-client/network-client/UDPClient/sendData" - ], - "root": "references/1.3.0/network-client/network-client/UDPClient" - } - ], - "root": "references/1.3.0/network-client/network-client" - } - ] - }, - { - "dropdown": "Network-Server", - "pages": [ - "references/1.3.0/network-server/index", - { - "group": "Network-Server", - "pages": [ - { - "group": "NetworkServerLibrary", - "pages": [ - "references/1.3.0/network-server/network-server/NetworkServerLibrary/__init", - "references/1.3.0/network-server/network-server/NetworkServerLibrary/__name", - "references/1.3.0/network-server/network-server/NetworkServerLibrary/tcp", - "references/1.3.0/network-server/network-server/NetworkServerLibrary/udp" - ], - "root": "references/1.3.0/network-server/network-server/NetworkServerLibrary" - }, - { - "group": "TCPServer", - "pages": [ - "references/1.3.0/network-server/network-server/TCPServer/constructor", - "references/1.3.0/network-server/network-server/TCPServer/getConnectedClients", - "references/1.3.0/network-server/network-server/TCPServer/getReceivedPackets", - "references/1.3.0/network-server/network-server/TCPServer/listen", - "references/1.3.0/network-server/network-server/TCPServer/sendToClient", - "references/1.3.0/network-server/network-server/TCPServer/sendToEverybody" - ], - "root": "references/1.3.0/network-server/network-server/TCPServer" - }, - { - "group": "UDPServer", - "pages": [ - "references/1.3.0/network-server/network-server/UDPServer/constructor", - "references/1.3.0/network-server/network-server/UDPServer/getConnectedClients", - "references/1.3.0/network-server/network-server/UDPServer/getReceivedPackets", - "references/1.3.0/network-server/network-server/UDPServer/listen", - "references/1.3.0/network-server/network-server/UDPServer/sendToClient", - "references/1.3.0/network-server/network-server/UDPServer/sendToEverybody" - ], - "root": "references/1.3.0/network-server/network-server/UDPServer" - } - ], - "root": "references/1.3.0/network-server/network-server" - } - ] - }, - { - "dropdown": "Sound", - "pages": [ - "references/1.3.0/sound/index", - { - "group": "Sound", - "pages": [ - { - "group": "SoundLibrary", - "pages": [ - "references/1.3.0/sound/sound/SoundLibrary/__init", - "references/1.3.0/sound/sound/SoundLibrary/__name", - "references/1.3.0/sound/sound/SoundLibrary/load", - "references/1.3.0/sound/sound/SoundLibrary/mute", - "references/1.3.0/sound/sound/SoundLibrary/play" - ], - "root": "references/1.3.0/sound/sound/SoundLibrary" - } - ], - "root": "references/1.3.0/sound/sound" - } - ] - } - ] + "group": "Loader", + "pages": { + "$ref": "./docs/loader/navigation.json" + } } ] + }, + { + "dropdown": "Editor", + "icon": "pen-ruler", + "pages": { + "$ref": "./docs/editor/navigation.json" + } } ] + }, + { + "tab": "Guides", + "dropdowns": [ + { + "dropdown": "CLI", + "icon": "terminal", + "pages": { + "$ref": "./guides/cli/navigation.json" + } + } + ] + }, + { + "tab": "API reference", + "versions": { + "$ref": "./references/engine/navigation.json" + } } ] - } -} \ No newline at end of file + }, + "redirects": [ + { + "source": "/docs/cli/getting-started/1-introduction", + "destination": "/docs/cli/getting-started/introduction" + }, + { + "source": "/docs/cli/getting-started/2-installation", + "destination": "/docs/cli/getting-started/installation" + }, + { + "source": "/docs/cli/getting-started/3-quickstart", + "destination": "/docs/cli/getting-started/quickstart" + }, + { + "source": "/docs/cli/getting-started/index", + "destination": "/docs/cli/getting-started/introduction" + }, + { + "source": "/docs/cli/getting-started/usage", + "destination": "/docs/cli/getting-started/introduction" + }, + { + "source": "/docs/cli/commands/1-overview", + "destination": "/docs/cli/commands/overview" + }, + { + "source": "/docs/cli/configuration/1-configuration-file", + "destination": "/docs/cli/configuration/configuration-file" + }, + { + "source": "/docs/cli/configuration/2-environment-variables", + "destination": "/docs/cli/configuration/environment-variables" + }, + { + "source": "/docs/cli/schematics/1-overview", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/commands/2-commands/1-new", + "destination": "/docs/cli/commands/new" + }, + { + "source": "/docs/cli/commands/2-commands/2-dev", + "destination": "/docs/cli/commands/dev" + }, + { + "source": "/docs/cli/commands/2-commands/3-build", + "destination": "/docs/cli/commands/build" + }, + { + "source": "/docs/cli/commands/2-commands/4-start", + "destination": "/docs/cli/commands/start" + }, + { + "source": "/docs/cli/commands/2-commands/5-create", + "destination": "/docs/cli/commands/create" + }, + { + "source": "/docs/cli/commands/2-commands/6-install", + "destination": "/docs/cli/commands/install" + }, + { + "source": "/docs/cli/commands/2-commands/7-install", + "destination": "/docs/cli/commands/install" + }, + { + "source": "/docs/cli/commands/2-commands/7-editor", + "destination": "/docs/cli/commands/editor" + }, + { + "source": "/docs/cli/commands/2-commands/8-editor", + "destination": "/docs/cli/commands/editor" + }, + { + "source": "/docs/cli/commands/2-commands/8-registry", + "destination": "/docs/cli/commands/registry" + }, + { + "source": "/docs/cli/commands/2-commands/9-registry", + "destination": "/docs/cli/commands/registry" + }, + { + "source": "/docs/cli/schematics/2-schematics/1-workspace", + "destination": "/docs/cli/schematics/workspace" + }, + { + "source": "/docs/cli/schematics/2-schematics/2-project", + "destination": "/docs/cli/schematics/project" + }, + { + "source": "/docs/cli/schematics/2-schematics/3-component", + "destination": "/docs/cli/schematics/component" + }, + { + "source": "/docs/cli/schematics/2-schematics/4-system", + "destination": "/docs/cli/schematics/system" + }, + { + "source": "/docs/cli/schematics/2-schematics/1-application", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/2-configuration", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/3-part-base", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/4-part-main", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/5-docker", + "destination": "/docs/cli/schematics/overview" + }, + { + "source": "/docs/cli/schematics/2-schematics/6-component", + "destination": "/docs/cli/schematics/component" + }, + { + "source": "/docs/cli/schematics/2-schematics/7-system", + "destination": "/docs/cli/schematics/system" + }, + { + "source": "/docs/cli/loader/1-overview", + "destination": "/docs/loader/overview" + }, + { + "source": "/docs/cli/loader/2-client", + "destination": "/docs/loader/client" + }, + { + "source": "/docs/cli/loader/3-website", + "destination": "/docs/loader/website" + }, + { + "source": "/docs/cli/loader/4-server", + "destination": "/docs/loader/server" + }, + { + "source": "/guides/cli/cli/1-overview", + "destination": "/guides/cli/overview" + }, + { + "source": "/guides/cli/cli/2-create-a-project", + "destination": "/guides/cli/create-a-project" + }, + { + "source": "/guides/cli/cli/3-develop-locally", + "destination": "/guides/cli/develop-locally" + }, + { + "source": "/guides/cli/cli/4-build-and-deploy", + "destination": "/guides/cli/build-and-deploy" + }, + { + "source": "/guides/cli/cli/5-components-and-systems", + "destination": "/guides/cli/components-and-systems" + }, + { + "source": "/guides/cli/cli/6-publish-a-package", + "destination": "/guides/cli/publish-a-package" + }, + { + "source": "/references/1.3.0/:slug*", + "destination": "/index" + }, + { + "source": "/references/1.4.0/:slug*", + "destination": "/index" + }, + { + "source": "/references/1.4.1/:slug*", + "destination": "/index" + }, + { + "source": "/references/1.4.2/:slug*", + "destination": "/index" + } + ] +} diff --git a/docs/cli/commands/1-overview.mdx b/docs/cli/commands/1-overview.mdx deleted file mode 100644 index 4d3915f..0000000 --- a/docs/cli/commands/1-overview.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Commands -description: Overview of every NanoForge CLI command ---- - -import { Card, CardGroup } from "mintlify/components"; - -## Using the CLI - -Every command follows the same shape: - -```bash -nf [command] [options] -``` - -Most commands accept `-d, --directory ` to set the working directory and -`-c, --config ` to point at a specific configuration file. Run any command with `--help` to -see its full option list: - -```bash -nf --help -``` - -## Available commands - - - - Scaffold a brand new NanoForge project. - - - Run your project in development mode with watching. - - - Compile your client and server for production. - - - Serve a built project, optionally over HTTPS. - - - Create a single component or system. - - - Add components, systems, or libraries from the registry. - - - Launch the NanoForge visual editor. - - - Authenticate, publish, and unpublish packages. - - diff --git a/docs/cli/commands/2-commands/1-new.mdx b/docs/cli/commands/2-commands/1-new.mdx deleted file mode 100644 index dd11d75..0000000 --- a/docs/cli/commands/2-commands/1-new.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: new -description: Create a new NanoForge project ---- - -## Overview - -`nf new` scaffolds a brand new NanoForge project. Run without flags it is fully interactive, -prompting for everything it needs. Any answer can be supplied up front as a flag to skip the -corresponding prompt. - -## Usage - -```bash -nf new -``` - -## Options - -| Option | Description | -| ---------------------------------------------- | ----------------------------------------------------------------------- | -| `-d, --directory ` | Working directory of the command. | -| `--name ` | Name of your project. | -| `--path ` | Relative path where the project is created (default: the project name). | -| `--package-manager ` | Package manager: `npm`, `yarn`, `pnpm`, or `bun`. | -| `--language ` | Project language: `ts` or `js`. | -| `--strict` / `--no-strict` | Enable or disable strict mode. | -| `--server` / `--no-server` | Generate a server alongside the client. | -| `--init-functions` / `--no-init-functions` | Add lifecycle init functions. | -| `--skip-install` / `--no-skip-install` | Skip installing dependencies after scaffolding. | -| `--docker` / `--no-docker` | Generate Docker files. | -| `--no-lint` | Skip generating lint configuration files. | -| `--editor` | Add editor dependencies. | -| `--git` / `--no-git` | Initialize a git repository. | -| `--git-remote ` / `--no-git-remote` | Set up a git remote (requires `--git`). | - -## Examples - -**Interactive:** - -```bash -nf new -``` - -**Non-interactive TypeScript project with a server:** - -```bash -nf new \ - --name my-game \ - --language ts \ - --package-manager pnpm \ - --server \ - --no-docker -``` diff --git a/docs/cli/commands/2-commands/2-dev.mdx b/docs/cli/commands/2-commands/2-dev.mdx deleted file mode 100644 index af69747..0000000 --- a/docs/cli/commands/2-commands/2-dev.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: dev -description: Run your NanoForge project in development mode ---- - -## Overview - -`nf dev` runs your NanoForge project in development mode. It is the command you keep open while -working - it serves the game and reacts to changes. - -## Usage - -```bash -nf dev -``` - -## Options - -| Option | Description | -| ----------------------------- | --------------------------------- | -| `-d, --directory ` | Working directory of the command. | -| `-c, --config ` | Path to the configuration file. | - -## Examples - -**Standard dev run:** - -```bash -nf dev -``` diff --git a/docs/cli/commands/2-commands/3-build.mdx b/docs/cli/commands/2-commands/3-build.mdx deleted file mode 100644 index 930f210..0000000 --- a/docs/cli/commands/2-commands/3-build.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: build -description: Build your NanoForge project for production ---- - -## Overview - -`nf build` compiles your NanoForge project. The client and server entry points, static directories, -and output directories all default to the values in your -[configuration file](../../configuration/1-configuration-file) and can be overridden per run. - -## Usage - -```bash -nf build -``` - -## Options - -| Option | Description | -| --------------------------------------- | -------------------------------------- | -| `-d, --directory ` | Working directory of the command. | -| `-c, --config ` | Path to the configuration file. | -| `--client-entry ` | Entry file of the client. | -| `--server-entry ` | Entry file of the server. | -| `--client-static-dir ` | Static directory of the client. | -| `--server-static-dir ` | Static directory of the server. | -| `--client-out-dir ` | Output directory of the client. | -| `--server-out-dir ` | Output directory of the server. | -| `--editor` | Build with the editor configuration. | -| `--watch` | Build in watch mode. Default: `false`. | - -## Examples - -**Build using the configuration defaults:** - -```bash -nf build -``` - -**Rebuild on change with a custom client output directory:** - -```bash -nf build --watch --client-out-dir dist/client -``` diff --git a/docs/cli/commands/2-commands/4-start.mdx b/docs/cli/commands/2-commands/4-start.mdx deleted file mode 100644 index cf1f49e..0000000 --- a/docs/cli/commands/2-commands/4-start.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: start -description: Start a built NanoForge project ---- - -import { Note } from "mintlify/components"; - -## Overview - -`nf start` serves a previously built NanoForge project. It launches the loader (the website that -loads the game) and, when enabled, the server. It can also serve over HTTPS when given a -certificate and key. - -## Usage - -```bash -nf start -``` - -## Options - -| Option | Description | -| -------------------------------- | ----------------------------------------------------------------- | -| `-d, --directory ` | Working directory of the command. | -| `-c, --config ` | Path to the configuration file. Default: `nanoforge.config.json`. | -| `-p, --port ` | Port of the loader (the website that loads the game). | -| `--client-dir ` | Directory of the built client. | -| `--server-dir ` | Directory of the built server. | -| `--watch` | Run in watch mode. Default: `false`. | -| `--cert ` | Path to the TLS certificate for HTTPS. | -| `--key ` | Path to the TLS key for HTTPS. | - -## Examples - -**Start on a custom port:** - -```bash -nf start --port 8080 -``` - -**Start over HTTPS:** - -```bash -nf start --cert ./certs/cert.pem --key ./certs/key.pem -``` - - - Environment variables (for example server addresses and ports) are read from a `.env` file at the - project root when the game starts. See [Environment - variables](../../configuration/2-environment-variables). - diff --git a/docs/cli/commands/2-commands/5-create.mdx b/docs/cli/commands/2-commands/5-create.mdx deleted file mode 100644 index e63ebcf..0000000 --- a/docs/cli/commands/2-commands/5-create.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: create -description: Create a NanoForge component or system ---- - -## Overview - -`nf create` scaffolds a single ECS **component** or **system** in your project. By default it -creates files for the client; pass `--server` to target the server instead. - -## Usage - -```bash -nf create -``` - -`` is either `component` or `system`. - -## Options - -| Option | Description | -| ----------------------------- | ------------------------------------------------------------- | -| `` | The type to create: `component` or `system`. | -| `-d, --directory ` | Working directory of the command. | -| `-c, --config ` | Path to the configuration file. | -| `-n, --name ` | Name of the component or system. | -| `-s, --server` | Create on the server instead of the client. Default: `false`. | -| `-p, --path ` | Path to the component/system folder. | - -## Examples - -**Create a client component:** - -```bash -nf create component --name Position -``` - -**Create a server system:** - -```bash -nf create system --name Movement --server -``` diff --git a/docs/cli/commands/2-commands/6-install.mdx b/docs/cli/commands/2-commands/6-install.mdx deleted file mode 100644 index f08fccc..0000000 --- a/docs/cli/commands/2-commands/6-install.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: install / add -description: Add components, systems, or libraries to your project ---- - -import { Note } from "mintlify/components"; - -## Overview - -`nf install` (aliased as `nf add`) pulls components, systems, or libraries from the NanoForge -registry into your project. By default it installs components and systems for the client; use -`--lib` for libraries and `--server` to target the server. - -## Usage - -```bash -nf install [names...] -``` - -## Options - -| Option | Description | -| ----------------------------- | ------------------------------------------------------------------ | -| `[names...]` | Names of the components/systems/libraries to install. | -| `-d, --directory ` | Working directory of the command. | -| `-l, --lib` | Install a library instead of a component/system. Default: `false`. | -| `-s, --server` | Install on the server instead of the client. Default: `false`. | - -## Examples - -**Install a component for the client:** - -```bash -nf install my-org/health-bar -``` - -**Install a library on the server:** - -```bash -nf add my-org/physics --lib --server -``` - - - Installing from a private scope may require authentication. See the [registry - commands](./9-registry) to log in first. - diff --git a/docs/cli/commands/2-commands/7-editor.mdx b/docs/cli/commands/2-commands/7-editor.mdx deleted file mode 100644 index 4e752f4..0000000 --- a/docs/cli/commands/2-commands/7-editor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: editor -description: Launch the NanoForge visual editor ---- - -## Overview - -`nf editor` starts the NanoForge editor - a visual environment for inspecting and authoring your -game. When a project `path` is given, the editor opens that project; by default it then opens in -your browser. - -## Usage - -```bash -nf editor [path] -``` - -## Options - -| Option | Description | -| ----------------------------- | --------------------------------------------------------------------------------------------- | -| `[path]` | Path to the project to open in the editor. | -| `-d, --directory ` | Working directory of the command. | -| `--open` | Open the editor in the default web browser. Default: `true` when `path` is set, else `false`. | -| `--no-open` | Do not open the editor in the browser. | - -## Examples - -**Open the editor for the current project:** - -```bash -nf editor . -``` - -**Start the editor without opening a browser tab:** - -```bash -nf editor --no-open -``` diff --git a/docs/cli/commands/2-commands/7-install.mdx b/docs/cli/commands/2-commands/7-install.mdx deleted file mode 100644 index f08fccc..0000000 --- a/docs/cli/commands/2-commands/7-install.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: install / add -description: Add components, systems, or libraries to your project ---- - -import { Note } from "mintlify/components"; - -## Overview - -`nf install` (aliased as `nf add`) pulls components, systems, or libraries from the NanoForge -registry into your project. By default it installs components and systems for the client; use -`--lib` for libraries and `--server` to target the server. - -## Usage - -```bash -nf install [names...] -``` - -## Options - -| Option | Description | -| ----------------------------- | ------------------------------------------------------------------ | -| `[names...]` | Names of the components/systems/libraries to install. | -| `-d, --directory ` | Working directory of the command. | -| `-l, --lib` | Install a library instead of a component/system. Default: `false`. | -| `-s, --server` | Install on the server instead of the client. Default: `false`. | - -## Examples - -**Install a component for the client:** - -```bash -nf install my-org/health-bar -``` - -**Install a library on the server:** - -```bash -nf add my-org/physics --lib --server -``` - - - Installing from a private scope may require authentication. See the [registry - commands](./9-registry) to log in first. - diff --git a/docs/cli/commands/2-commands/8-editor.mdx b/docs/cli/commands/2-commands/8-editor.mdx deleted file mode 100644 index 4e752f4..0000000 --- a/docs/cli/commands/2-commands/8-editor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: editor -description: Launch the NanoForge visual editor ---- - -## Overview - -`nf editor` starts the NanoForge editor - a visual environment for inspecting and authoring your -game. When a project `path` is given, the editor opens that project; by default it then opens in -your browser. - -## Usage - -```bash -nf editor [path] -``` - -## Options - -| Option | Description | -| ----------------------------- | --------------------------------------------------------------------------------------------- | -| `[path]` | Path to the project to open in the editor. | -| `-d, --directory ` | Working directory of the command. | -| `--open` | Open the editor in the default web browser. Default: `true` when `path` is set, else `false`. | -| `--no-open` | Do not open the editor in the browser. | - -## Examples - -**Open the editor for the current project:** - -```bash -nf editor . -``` - -**Start the editor without opening a browser tab:** - -```bash -nf editor --no-open -``` diff --git a/docs/cli/commands/2-commands/8-registry.mdx b/docs/cli/commands/2-commands/8-registry.mdx deleted file mode 100644 index bba7010..0000000 --- a/docs/cli/commands/2-commands/8-registry.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: registry -description: Authenticate with and publish to the NanoForge registry ---- - -## Overview - -These commands manage your relationship with the NanoForge registry: authenticating, then publishing -or removing packages. Authentication can be **global** (default, stored for your user) or **local** -(scoped to the current project) with `-l, --local`. - -## login - -Log in to the NanoForge registry. - -```bash -nf login -``` - -| Option | Description | -| ----------------------------- | ------------------------------------------------------ | -| `-d, --directory ` | Working directory of the command. | -| `-l, --local` | Log in only for the current project. Default: `false`. | -| `-k, --api-key ` | API key for the NanoForge registry. | - -```bash -nf login --api-key -``` - -## logout - -Log out from the NanoForge registry. - -```bash -nf logout -``` - -| Option | Description | -| ----------------------------- | ------------------------------------- | -| `-d, --directory ` | Working directory of the command. | -| `-l, --local` | Log out only for the current project. | - -## publish - -Publish a package to the NanoForge registry. - -```bash -nf publish -``` - -| Option | Description | -| ----------------------------- | --------------------------------- | -| `-d, --directory ` | Working directory of the command. | - -## unpublish - -Unpublish a package from the NanoForge registry. - -```bash -nf unpublish -``` - -| Option | Description | -| ----------------------------- | --------------------------------- | -| `-d, --directory ` | Working directory of the command. | diff --git a/docs/cli/commands/2-commands/9-registry.mdx b/docs/cli/commands/2-commands/9-registry.mdx deleted file mode 100644 index bba7010..0000000 --- a/docs/cli/commands/2-commands/9-registry.mdx +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: registry -description: Authenticate with and publish to the NanoForge registry ---- - -## Overview - -These commands manage your relationship with the NanoForge registry: authenticating, then publishing -or removing packages. Authentication can be **global** (default, stored for your user) or **local** -(scoped to the current project) with `-l, --local`. - -## login - -Log in to the NanoForge registry. - -```bash -nf login -``` - -| Option | Description | -| ----------------------------- | ------------------------------------------------------ | -| `-d, --directory ` | Working directory of the command. | -| `-l, --local` | Log in only for the current project. Default: `false`. | -| `-k, --api-key ` | API key for the NanoForge registry. | - -```bash -nf login --api-key -``` - -## logout - -Log out from the NanoForge registry. - -```bash -nf logout -``` - -| Option | Description | -| ----------------------------- | ------------------------------------- | -| `-d, --directory ` | Working directory of the command. | -| `-l, --local` | Log out only for the current project. | - -## publish - -Publish a package to the NanoForge registry. - -```bash -nf publish -``` - -| Option | Description | -| ----------------------------- | --------------------------------- | -| `-d, --directory ` | Working directory of the command. | - -## unpublish - -Unpublish a package from the NanoForge registry. - -```bash -nf unpublish -``` - -| Option | Description | -| ----------------------------- | --------------------------------- | -| `-d, --directory ` | Working directory of the command. | diff --git a/docs/cli/configuration/1-configuration-file.mdx b/docs/cli/configuration/1-configuration-file.mdx deleted file mode 100644 index 51a89b9..0000000 --- a/docs/cli/configuration/1-configuration-file.mdx +++ /dev/null @@ -1,140 +0,0 @@ ---- -title: Configuration file -description: The nanoforge.config.ts (or .js) file consumed by the CLI ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -Every NanoForge workspace, project, or lib has a `nanoforge.config.ts` (or `.js`) at its root, -exporting its configuration wrapped in `defineConfig` from `@nanoforge-dev/config`. The CLI reads -this file to know how to build and start your game, and — for a workspace root — to discover the -projects and libs it contains. - -Commands accept `-c, --config ` to point at a different directory to read the config -from (default: the current directory). The CLI looks for `nanoforge.config.ts` in that directory -first, falls back to `nanoforge.config.js` when no `.ts` file exists, and fails if neither is -present. - -## `type` - -A config's `type` field discriminates between four shapes: - -- `workspace` — a monorepo root listing its `packages`. -- `lib` — a shared library consumed by clients/servers. -- `client` — a browser-side NanoForge app. -- `server` — a server-side NanoForge app. - -The config at the root directory the CLI is pointed at must be a `workspace` or a `client`/`server` -project — a bare `lib` config is not valid there. Inside a `workspace`, none of the packages it -resolves may themselves be of type `workspace`; nesting workspaces isn't supported. - -## Defining a config - -Wrap your config in `defineConfig` to get type-checking and editor autocompletion on its fields: - -```ts -import { defineConfig } from "@nanoforge-dev/config"; - -export default defineConfig({ - type: "client", - entryFile: "src/main.ts", - libs: ["../../libs/my-lib"], -}); -``` - -`defineConfig` is an identity function — it returns its argument unchanged. - -## `workspace` - -| Field | Type | Default | Description | -| ---------- | ---------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `packages` | `string[]` | `[]` | Glob patterns matched against directories relative to the workspace root, each expected to hold its own `client`, `server`, or `lib` config. | - -A directory matched by a pattern but missing a `nanoforge.config.ts`/`.js` is skipped without -error. A pattern that matches no project or lib at all only logs a warning, rather than failing -the whole resolution. A matched directory whose config is itself of type `workspace` throws. - -### Example - -```ts -import { defineConfig } from "@nanoforge-dev/config"; - -export default defineConfig({ - type: "workspace", - packages: ["apps/*", "libs/*"], -}); -``` - -## `lib` - -| Field | Type | Default | Description | -| ---------------- | -------- | ------------------- | ------------------------ | -| `dir.assets` | `string` | `assets` | Where assets live. | -| `dir.shared` | `string` | `shared` | Where shared code lives. | -| `dir.components` | `string` | `shared/components` | Used by the editor only. | -| `dir.systems` | `string` | `shared/systems` | Used by the editor only. | -| `dir.scenes` | `string` | `shared/scenes` | Used by the editor only. | - -### Example - -```ts -import { defineConfig } from "@nanoforge-dev/config"; - -export default defineConfig({ type: "lib" }); -``` - -## `client` / `server` - -`client` and `server` share the exact same fields and defaults — `type` is the only thing that -tells them apart. - -| Field | Type | Default | Description | -| ---------------- | ---------- | ---------------- | ------------------------------------------------------ | -| `entryFile` | `string` | `src/main.ts` | Entry file. | -| `out.dir` | `string` | `dist` | Build output directory. | -| `out.mainFile` | `string` | `main.js` | Build output entry file name. | -| `dir.assets` | `string` | `assets` | Where assets live. | -| `dir.packages` | `string` | `nf_modules` | Where downloaded package dependencies are installed. | -| `dir.components` | `string` | `src/components` | Used by the editor only. | -| `dir.systems` | `string` | `src/systems` | Used by the editor only. | -| `dir.scenes` | `string` | `src/scenes` | Used by the editor only. | -| `libs` | `string[]` | `[]` | Relative paths to shared libs this project depends on. | - -### Example - -```ts -import { defineConfig } from "@nanoforge-dev/config"; - -export default defineConfig({ - type: "server", - entryFile: "src/main.ts", - dir: { assets: "static" }, - libs: ["../../libs/shared"], -}); -``` - -## Resolving defaults - -Missing fields are filled in with the defaults for the config's `type`, deep-merging nested -objects like `dir` and `out`: - -```ts -import { resolveConfig } from "@nanoforge-dev/config"; - -const resolved = resolveConfig({ type: "client", dir: { assets: "static" } }); -// resolved.dir.assets === "static" -// resolved.dir.packages === "nf_modules" (default, not overridden) -``` - -Array fields (`packages`, `libs`) are replaced wholesale by an override rather than concatenated -with the defaults. - -## Errors - -- `ConfigNotFoundError` — thrown by the CLI when neither `nanoforge.config.ts` nor - `nanoforge.config.js` exists in the directory it was pointed at. -- `ConfigParseError` (from `@nanoforge-dev/config`) — thrown while loading or validating a config - file's default export. Its `code` identifies the failure: `not-found`, `load-failed`, - `no-default-export`, or `invalid-type`. diff --git a/docs/cli/configuration/2-environment-variables.mdx b/docs/cli/configuration/2-environment-variables.mdx deleted file mode 100644 index 74991af..0000000 --- a/docs/cli/configuration/2-environment-variables.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Environment variables -description: Pass configuration to the client and server at runtime ---- - -import { Note } from "mintlify/components"; - -## Overview - -When running a NanoForge game (via `nf start`), environment variables can be passed to the client -and server through a `.env` file at the root of the project, or directly from the environment. - -```dotenv -NANOFORGE_CLIENT_SERVER_TCP_PORT=4445 -NANOFORGE_CLIENT_SERVER_UDP_PORT=4444 -NANOFORGE_CLIENT_SERVER_ADDRESS=127.0.0.1 -``` - -## Scoping by prefix - -Variables are scoped by their prefix, which controls where they are available: - -| Prefix | Availability | -| ------------------- | ----------------------------------- | -| `NANOFORGE_CLIENT_` | Available in the client only | -| `NANOFORGE_SERVER_` | Available in the server only | -| `NANOFORGE_` | Available in both client and server | - - - Prefixes are stripped before the variable is exposed to libraries. For example, - `NANOFORGE_CLIENT_SERVER_ADDRESS` is exposed to the client as `SERVER_ADDRESS`. - - -For full documentation on how libraries consume these variables, see -[`@nanoforge-dev/config`](https://github.com/NanoForge-dev/Engine/tree/main/packages/config). diff --git a/docs/cli/getting-started/1-introduction.mdx b/docs/cli/getting-started/1-introduction.mdx deleted file mode 100644 index 6616b17..0000000 --- a/docs/cli/getting-started/1-introduction.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Introduction -description: What the NanoForge CLI is and what you can do with it ---- - -import { Card, CardGroup } from "mintlify/components"; - -## What is the NanoForge CLI? - -The NanoForge CLI (`nf`) is the main entry point for building, running, and deploying games made -with [NanoForge](https://github.com/NanoForge-dev) - a powerful game engine for the web browser. - -It wraps every step of the development lifecycle behind a single command: scaffolding a new project, -generating ECS components and systems, running your game in development mode, building for -production, and publishing reusable packages to the NanoForge registry. - -## What can it do? - - - - Create a fully configured project - client, optional server, linting, and Docker - in one - command. - - - Run your game locally with hot reloading, then start it as you would in production. - - - Publish and consume components, systems, and libraries through the NanoForge registry. - - - -## Where to go next - -- New to NanoForge? Start with [Installation](./2-installation) then the - [Quickstart](./3-quickstart). -- Looking for a specific flag? See the [Commands reference](../commands/1-overview). -- Want a task-oriented walkthrough? Browse the [Guides](../../guides/cli/1-overview). - -See the [changelog](https://github.com/NanoForge-dev/CLI/blob/main/CHANGELOG.md) for the full -release history. diff --git a/docs/cli/getting-started/2-installation.mdx b/docs/cli/getting-started/2-installation.mdx deleted file mode 100644 index 1bdbbb8..0000000 --- a/docs/cli/getting-started/2-installation.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Installation -description: Install the NanoForge CLI and verify your setup ---- - -import { Tab, Tabs } from "mintlify/components"; - -## Requirements - -- **Node.js** 20 or later -- A package manager: `npm`, `yarn`, `pnpm`, or `bun` - -## Install globally - -Installing the CLI globally exposes the `nf` command everywhere on your machine. - - - ```bash npm install -g @nanoforge-dev/cli ``` - ```bash pnpm add -g @nanoforge-dev/cli ``` - ```bash yarn global add @nanoforge-dev/cli ``` - ```bash bun add -g @nanoforge-dev/cli ``` - - -## Verify the installation - -```bash -nf --version -nf --help -``` - -`nf --help` lists every available command. To see the options for a specific command, append -`--help` to it: - -```bash -nf new --help -``` - -## Next steps - -Continue to the [Quickstart](./3-quickstart) to create and run your first project. diff --git a/docs/cli/getting-started/3-quickstart.mdx b/docs/cli/getting-started/3-quickstart.mdx deleted file mode 100644 index be335af..0000000 --- a/docs/cli/getting-started/3-quickstart.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Quickstart -description: Create, run, and build your first NanoForge project ---- - -import { Step, Steps } from "mintlify/components"; - -This quickstart takes you from an empty folder to a running game in a few minutes. - - - - Run the interactive scaffolder and answer the prompts (project name, language, package manager, - whether to include a server, and so on): - - ```bash - nf new - ``` - - Prefer a non-interactive run? Pass the answers as flags: - - ```bash - nf new --name my-game --language ts --package-manager pnpm --server - ``` - - - - - ```bash - cd my-game - ``` - - The scaffolder generates a `nanoforge.config.json` at the root. See - [Configuration](../configuration/1-configuration-file) for what every field means. - - - - - Start the game locally with file watching: - - ```bash - nf dev - ``` - - - - - ```bash - nf build - ``` - - Then start the built game: - - ```bash - nf start - ``` - - - - -## Where to go next - -- Learn each command in detail in the [Commands reference](../commands/1-overview). -- Follow task-oriented [Guides](/guides/cli/1-overview) for common workflows. diff --git a/docs/cli/getting-started/index.mdx b/docs/cli/getting-started/index.mdx deleted file mode 100644 index 609b2a6..0000000 --- a/docs/cli/getting-started/index.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: CLI ---- - -# CLI - -The nanoforge CLI is the main tool to use when building or deploying a NanoForge application. - -To install the NanoForge CLI use: - -```bash -npm install -g @nanoforge-dev/cli -``` - -For usage information see [Usage](./usage.mdx). diff --git a/docs/cli/getting-started/usage.mdx b/docs/cli/getting-started/usage.mdx deleted file mode 100644 index 2e0b36f..0000000 --- a/docs/cli/getting-started/usage.mdx +++ /dev/null @@ -1,179 +0,0 @@ ---- -title: Usage ---- - -# Usage - -## Creating a new project - -In order to create a new project you need to run: - -```bash -nf new -``` - -## Commands - -Multiple commands exist in the CLI: - -- [build](#build) -- [create](#create) -- [dev](#dev) -- [editor](#editor) -- [generate](#generate) -- [install/add](#install/add) -- [login](#login) -- [logout](#logout) -- [new](#new) -- [publish](#publish) -- [start](#start) -- [unpublish](#unpublish) - -## build - -Used to build your nanoforge project. - -- `-d, --directory ` specify the working directory of the command. -- `-c, --config ` path to the config file. ([Schema](./config.schema.json)) -- `--client-entry ` specify the entry file of the client. -- `--server-entry ` specify the entry file of the server. -- `--client-static-dir ` specify the static directory of the client. -- `--server-static-dir ` specify the static directory of the server. -- `--client-out-dir ` specify the output directory of the client. -- `--server-out-dir ` specify the output directory of the server. -- `--editor` build with editor config. -- `--watch` build app in watching mode. (default: `false`) - -## create - -Used to create nanoforge components or systems. - -- `` the type to create (component or system). -- `-d, --directory ` specify the working directory of the command. -- `-c, --config ` path to the config file. ([Schema](./config.schema.json)) -- `-n, --name ` name of the component/system. -- `-s, --server` create on server instead of client. (default: `false`) -- `-p, --path ` path to the component/system folder. - -## dev - -Used to run your nanoforge project in dev mode. - -- `-d, --directory ` specify the working directory of the command. -- `-c, --config ` path to the config file. ([Schema](./config.schema.json)) -- `--generate` generate app files from config, like generate command in dev mode. (default: `false`) - -## editor - -Used to start the nanoforge editor. - -- `[path]` path to the project to open in the editor. -- `-d, --directory ` specify the working directory of the command. -- `--open` open the editor in the default web browser (default: `true` if path is specified, `false` otherwise). -- `--no-open` do not open the editor in the default web browser. - -## generate - -Used to generate nanoforge project files from config. - -- `-d, --directory ` specify the working directory of the command. -- `-c, --config ` path to the config file. ([Schema](./config.schema.json)) -- `--editor` generate the editor main file. -- `--watch` generate app in watching mode. (default: `false`) - -## install/add - -Used to add nanoforge components, systems or libraries to your project. - -- `[names...]` names of the components/systems/libraries to install. -- `-d, --directory ` specify the working directory of the command. -- `-l, --lib` install a library instead of a component/system. (default: `false`) -- `-s, --server` install on server instead of client. (default: `false`) - -## login - -Used to log in to the Nanoforge registry. - -- `-d, --directory ` specify the working directory of the command. -- `-l, --local` log in only for the current project. (default: `false`) -- `-k, --api-key ` API key for the Nanoforge registry. - -## logout - -Used to log out from the Nanoforge registry. - -- `-d, --directory ` specify the working directory of the command. -- `-l, --local` log out only for the current project. - -## new - -Used to create a new nanoforge project. - -- `-d, --directory ` specify the working directory of the command. -- `--name ` specify the name of your project. -- `--path ` specify the relative path where your project will be created (default: name of the project). -- `--package-manager ` specify the package manager of your project. -- `--language ` specify the language of your project. -- `--strict` use strict mode. -- `--no-strict` do not use strict mode. -- `--server` create a server. -- `--no-server` do not create a server. -- `--init-functions` initialize functions. -- `--no-init-functions` do not initialize functions. -- `--skip-install` skip installing dependencies. -- `--no-skip-install` do not skip installing dependencies. -- `--docker` generate docker files. -- `--no-docker` do not generate docker files. -- `--no-lint` do not generate lint files. -- `--editor` add editor dependencies. -- `--git` generate a git repository. -- `--no-git` do not generate a git repository. -- `--git-remote ` set up a git remote (required if `--git` is used). -- `--no-git-remote` do not set up a git remote. - -## publish - -Used to publish a package to the Nanoforge registry. - -- `-d, --directory ` specify the working directory of the command. - -## start - -Used to start your nanoforge project. - -- `-d, --directory ` specify the working directory of the command. -- `-c, --config ` path to the config file (default: "nanoforge.config.json"). ([Schema](./config.schema.json)) -- `-p, --port ` specify the port of the loader (the website to load the game). -- `--client-dir ` specify the directory of the client. -- `--server-dir ` specify the directory of the server. -- `--watch` run app in watching mode. (default: `false`) -- `--cert ` path to the SSL certificate for HTTPS. -- `--key ` path to the SSL key for HTTPS. - -## unpublish - -Used to unpublish a package from the Nanoforge registry. - -- `-d, --directory ` specify the working directory of the command. - -## Environment Variables - -When running a NanoForge game (via `nf start`), environment variables can be passed to the client and server applications through a `.env` file at the root of the project or directly in the environment. - -```dotenv -NANOFORGE_CLIENT_SERVER_TCP_PORT=4445 -NANOFORGE_CLIENT_SERVER_UDP_PORT=4444 -NANOFORGE_CLIENT_SERVER_ADDRESS=127.0.0.1 -``` - -Variables are scoped by prefix: - -| Prefix | Availability | -| ------------------- | ----------------------------------- | -| `NANOFORGE_CLIENT_` | Available in the client only | -| `NANOFORGE_SERVER_` | Available in the server only | -| `NANOFORGE_` | Available in both client and server | - -> **Note:** Prefixes are stripped before the variable is exposed to libraries. - -For full documentation on how libraries consume these variables, see `@nanoforge-dev/config `\_\_. diff --git a/docs/cli/loader/1-overview.mdx b/docs/cli/loader/1-overview.mdx deleted file mode 100644 index 0c03bab..0000000 --- a/docs/cli/loader/1-overview.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: Loader -description: Overview of the @nanoforge-dev/loader packages ---- - -import { Card, CardGroup } from "mintlify/components"; - -## What is the Loader? - -The NanoForge Loader is the runtime layer that starts a NanoForge project. It is invoked by the [NanoForge CLI](https://github.com/NanoForge-dev/CLI) when you run `nf start`, and handles both sides of a game simultaneously: the **client side** delivered to the browser and the **server side** running in Bun. - -The Loader is a monorepo of three packages, each with a distinct responsibility at runtime: - -- **`loader-client`** — the Bun HTTP server that serves the browser with the loader UI and the compiled game files. -- **`loader-server`** — the Bun process that runs the compiled server game code in an isolated worker. -- **`loader-website`** — the browser application that displays the loading screen, caches game files locally, and bootstraps the game. - -The NanoForge CLI orchestrates all three; as a game developer you never interact with these packages directly. - -## Installation - -```bash -npm install -g @nanoforge-dev/cli -``` - -The loader packages are dependencies of the CLI and do not need to be installed separately. If you want to invoke the loaders directly outside of the CLI: - -```bash -npm install @nanoforge-dev/loader-client -npm install @nanoforge-dev/loader-server -``` - -Then run them with: - -```bash -npx loader-client --dir .nanoforge/client -npx loader-server --dir .nanoforge/server -``` - -## Packages - - - - Bun HTTP server that serves the loader website and the compiled client game files. Exposes the - manifest, environment variables, and game assets. Supports HTTPS and hot-reload. - - - Browser application bundled as static assets. Displays the loading screen, downloads and caches - game files via the browser Origin Private File System, then bootstraps the game. - - - Bun process that runs the server-side game code in an isolated worker process. Supports - live-reload by restarting the worker on file changes. - - - -see the [changelog](https://github.com/NanoForge-dev/Loader/blob/main/CHANGELOG.md) for the full release history. diff --git a/docs/cli/loader/2-client.mdx b/docs/cli/loader/2-client.mdx deleted file mode 100644 index 7a9c4ed..0000000 --- a/docs/cli/loader/2-client.mdx +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: Client -description: Bun HTTP server that serves the browser-side of a NanoForge project ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -`loader-client` is a Bun HTTP server that bridges the browser and the compiled game client. It serves the `loader-website` frontend, exposes the game file manifest, delivers the compiled game assets, and forwards environment variables to the browser. It is the single entry point for everything the player's browser contacts. - -## Usage - -```bash -nf start -``` - -Or invoke directly after building the loader packages: - -```bash -npx loader-client --dir .nanoforge/client --port 3000 -``` - -## Routes - -| Route | Description | -| --------------- | --------------------------------------------------------------------- | -| `GET /` | Serves the `loader-website` HTML application | -| `GET /*` | Serves static assets bundled with `loader-website` | -| `GET /manifest` | Returns the list of game files and the current version as JSON | -| `GET /env` | Returns `NANOFORGE_*` environment variables (prefix stripped) as JSON | -| `GET /game/*` | Serves compiled game client files from the configured game directory | - -## Options - -| Option | Type | Default | Description | -| -------------------------- | --------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `-p, --port ` | `string` | `3000` | Port the HTTP server listens on | -| `-d, --dir ` | `string` | `.nanoforge/client` | Directory of compiled client game files | -| `--watch` | `boolean` | `false` | Enable file watcher and browser hot-reload | -| `--watch-port ` | `string` | auto | Port for the WebSocket watch server | -| `--watch-server-dir ` | `string` | — | Also watch a server game directory for changes | -| `--cert ` | `string` | — | TLS certificate file (enables HTTPS) | -| `--key ` | `string` | — | TLS private key file (enables HTTPS) | - -## Watch mode - -When `--watch` is enabled, `loader-client` starts a WebSocket server on `--watch-port` (or a random free port) and sets the `watch.url` field in the manifest response. Any file change in the game directory causes the server to broadcast an `update` message. The `loader-website` frontend connects to that WebSocket and reloads the page on receipt. - -Pass `--watch-server-dir` to also reload when the server game directory changes — useful when client and server are compiled in one step. - -## HTTPS / TLS - -Pass `--cert` and `--key` to enable HTTPS. The server reads both files with Bun's native TLS support. The `/env` response will include `tlsEnabled: true` so the game can detect the protocol at runtime. - -HTTPS is required when the browser enforces a secure context — for example when using the Origin Private File System API used by `loader-website` to cache game files. - -## Examples - -**Start on port 8080:** - -```bash -npx loader-client --port 8080 -``` - -**Start with watch mode:** - -```bash -npx loader-client --watch --watch-server-dir .nanoforge/server -``` - -**Start with HTTPS:** - -```bash -npx loader-client --cert ./certs/server.crt --key ./certs/server.key -``` - -**Point to a custom game directory:** - -```bash -npx loader-client --dir ./dist/client -``` diff --git a/docs/cli/loader/3-website.mdx b/docs/cli/loader/3-website.mdx deleted file mode 100644 index 1d0827c..0000000 --- a/docs/cli/loader/3-website.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: Website -description: Browser application that loads and bootstraps a NanoForge game ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -`loader-website` is a browser application (HTML + TypeScript) bundled as static assets and served by `loader-client`. It is the loading screen the player sees before the game starts. It fetches the game's file list from the server, downloads and caches each file locally in the browser, then dynamically imports the game entry point and starts it. - -This package is a dependency of `loader-client` and is not consumed directly. - -## Loading sequence - -When the browser opens the loader URL, the following steps happen in order: - -1. **Fetch manifest** — requests `/manifest` to get the game version and the list of files to download. -2. **Verify cache** — checks whether the game files from the previous session are still present in the browser's Origin Private File System (OPFS). The loading screen shows _"Verifying application integrity"_. -3. **Download files** — if the cache is stale or missing, downloads each game file from `/game/*` and writes it into OPFS. The loading screen shows a progress bar and the name of the current file. -4. **Fetch environment** — requests `/env` to get the `NANOFORGE_*` variables forwarded by `loader-client`. -5. **Bootstrap game** — dynamically imports `/main.js` from the local OPFS cache, calls its exported `main({ files, env, container })`, and fades out the loading screen. - -If any step fails, the error message is displayed on screen instead of a blank page or an unhandled rejection. - -## Game interface - -`loader-website` calls the game's `main` export with the following shape: - -| Field | Type | Description | -| ----------- | ------------------------------------- | ------------------------------------------------------------------------------ | -| `files` | `Map` | Map of logical game paths (`/assets/sprite.png`, etc.) to their OPFS blob URLs | -| `env` | `Record` | Environment variables fetched from `/env` (prefix stripped) | -| `container` | `HTMLDivElement` | The DOM element the game should render into | - -## Watch mode - -When `loader-client` starts with `--watch`, the manifest response includes a `watch.url` WebSocket URL. `loader-website` connects to that URL and listens for messages. When it receives an `update` message it reloads the page, giving the developer an automatic live-reload experience. - -## Error display - -`loader-website` installs global handlers for `error` and `unhandledrejection` window events. If the game throws or rejects after starting, the error message is surfaced on the loading screen instead of failing silently. - -## Requirements - -`loader-website` uses the browser's [Origin Private File System](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API/Origin_private_file_system) (OPFS) API to cache game files locally. This API is only available in a **secure context** — either `localhost` or a page served over HTTPS. - -Start `loader-client` with `--cert` and `--key` to enable HTTPS when running on a non-localhost address. - -## Examples - -The website loader is not invoked directly. Start it via the CLI or `loader-client`: - -```bash -nf start -``` - -Or: - -```bash -npx loader-client --port 3000 --cert ./certs/server.crt --key ./certs/server.key -``` - -Then open the printed URL in a browser. The loader screen will appear, followed by the game. diff --git a/docs/cli/loader/4-server.mdx b/docs/cli/loader/4-server.mdx deleted file mode 100644 index a9af398..0000000 --- a/docs/cli/loader/4-server.mdx +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Server -description: Bun process that runs the server-side game code of a NanoForge project ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -`loader-server` is a Bun process that runs the compiled server-side game code. It scans a built game directory, locates `/main.js`, then forks an isolated child process — the worker — that loads the game and calls its exported `main()` function. The parent process manages the worker lifecycle and restarts it when files change in watch mode. - -## Usage - -```bash -nf start -``` - -Or invoke directly after building the loader packages: - -```bash -npx loader-server --dir .nanoforge/server -``` - -## How it works - -The server loader runs as two processes: - -1. **Server** (`server.js`) — the entry point. Scans the game directory, finds `/main.js`, and forks the worker. In `--watch` mode it restarts the worker on any file change. -2. **Worker** (`worker.js`) — an isolated child process forked by the server. It requires the game's `main.js` via `createRequire` and calls `main({ files, env })` to start the game. - -This two-process split ensures that a game crash or `process.exit()` call in the game code does not terminate the loader itself. - -## Options - -| Option | Type | Default | Description | -| ----------------- | --------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `-d, --dir ` | `string` | `.nanoforge/server` | Directory of compiled server game files | -| `--watch` | `boolean` | `false` | Enable file watcher and worker restart on change | - -## Watch mode - -When `--watch` is enabled, the loader watches the game directory recursively. On any file change the running worker is killed and a new worker is immediately forked with a clean state. Changes are debounced to 100 ms to avoid redundant restarts during bulk builds. - -## Environment variables - -The server loader collects all environment variables whose name starts with `NANOFORGE_`, strips the prefix, and passes the resulting object to the game via the `env` field of `main()`: - -``` -NANOFORGE_MY_VAR=hello → { MY_VAR: "hello" } -``` - -The game receives these inside the worker: - -```ts -export const main = async ({ - files, - env, -}: { - files: Map; - env: Record; -}) => { - console.log(env.MY_VAR); // "hello" -}; -``` - -## Game interface - -The worker calls the game's `main` export with the following shape: - -| Field | Type | Description | -| ------- | ------------------------------------- | --------------------------------------------------------------------------- | -| `files` | `Map` | Map of logical game paths (`/main.js`, etc.) to their full filesystem paths | -| `env` | `Record` | Environment variables forwarded from the host (prefix stripped) | - -## Examples - -**Start with a custom game directory:** - -```bash -npx loader-server --dir ./dist/server -``` - -**Start in watch mode:** - -```bash -npx loader-server --watch -``` - -**Pass environment variables to the game:** - -```bash -NANOFORGE_PORT=4000 NANOFORGE_DEBUG=true npx loader-server -``` diff --git a/docs/cli/schematics/1-overview.mdx b/docs/cli/schematics/1-overview.mdx deleted file mode 100644 index 1b14655..0000000 --- a/docs/cli/schematics/1-overview.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Schematics -description: Overview of the @nanoforge-dev/schematics package ---- - -import { Card, CardGroup } from "mintlify/components"; - -## What are schematics? - -NanoForge schematics are code generators built on [Angular DevKit](https://github.com/angular/angular-cli/tree/main/packages/angular_devkit/schematics). They produce the boilerplate files that every NanoForge project needs — from the initial application scaffold down to individual ECS components and systems. - -The NanoForge CLI (`nf`) calls these schematics internally whenever you run commands like `nf new` or `nf create`. You can also invoke them directly via the `schematics` CLI for advanced use cases. - -## Installation - -```bash -npm install -g @nanoforge-dev/cli -``` - -The schematics package is a dependency of the CLI and does not need to be installed separately. If you want to run schematics without the CLI: - -```bash -npm install -g @angular-devkit/schematics-cli -npm install @nanoforge-dev/schematics -``` - -Then invoke directly: - -```bash -schematics @nanoforge-dev/schematics: [options] -``` - -## Available schematics - - - - Scaffold the root of a NanoForge monorepo: `nanoforge.config.ts`, `package.json`, TypeScript or - JavaScript config, and linting. - - - Generate a client or server project under `apps/` inside a workspace, including its - `main.ts` entry point, example component/system, and optional Dockerfile. - - - Scaffold an ECS component class with an editor manifest for use in the NanoForge editor. - - - Scaffold an ECS system function with an editor manifest for use in the NanoForge editor. - - - -see the [changelog](https://github.com/NanoForge-dev/schematics/blob/main/CHANGELOG.md) for the full release history. diff --git a/docs/cli/schematics/2-schematics/1-application.mdx b/docs/cli/schematics/2-schematics/1-application.mdx deleted file mode 100644 index 9554bc3..0000000 --- a/docs/cli/schematics/2-schematics/1-application.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Application -description: Generate a complete NanoForge application scaffold ---- - -import { ToolTip } from "mintlify/components"; - -## Overview - -The `application` schematic creates a fully structured NanoForge project with all the base files needed to start development — `package.json`, linting configuration, TypeScript or JavaScript setup, and optionally `.env` for server-enabled apps. - -## Usage - -```bash -nf new -``` - -Or via Angular DevKit schematics directly: - -```bash -schematics @nanoforge-dev/schematics:application --name=my-app -``` - -## Options - -| Option | Type | Default | Description | -| ---------------- | ------------------------------------ | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | `nanoforge-app` | The name of the application | -| `version` | `string` | `0.0.0` | Initial version in `package.json` | -| `author` | `string` | `""` | Author field in `package.json` | -| `description` | `string` | `""` | Description field in `package.json` | -| `directory` | `string` | `name` | Destination directory for the generated files | -| `language` | `"ts" \| "js"` | `ts` | Language to use for generated source files | -| `strict` | `boolean` | `true` | Enable strict mode | -| `lint` | `boolean` | `true` | Generate linting configuration files | -| `packageManager` | `"npm" \| "yarn" \| "pnpm" \| "bun"` | `npm` | Package manager to target in scripts and lockfile references | -| `server` | `boolean` | `false` | Configure a server for the application | -| `editor` | `boolean` | `false` | Include editor dependencies | -| `initFunctions` | `boolean` | `false` | Add init function lifecycle hooks | - -## Generated structure - -``` -my-app/ -├── package.json -├── tsconfig.json # TypeScript only -├── jsconfig.json # JavaScript only -├── eslint.config.js # if lint: true -├── prettier.config.js # if lint: true -├── .prettierignore # if lint: true -├── .env # if server: true -├── .gitignore -└── README.md -``` - -## Examples - -**Minimal TypeScript app:** - -```bash -schematics @nanoforge-dev/schematics:application --name=my-game -``` - -**JavaScript app with pnpm and server:** - -```bash -schematics @nanoforge-dev/schematics:application \ - --name=my-game \ - --language=js \ - --packageManager=pnpm \ - --server=true -``` - -**TypeScript app without linting:** - -```bash -schematics @nanoforge-dev/schematics:application \ - --name=my-game \ - --lint=false -``` diff --git a/docs/cli/schematics/2-schematics/1-workspace.mdx b/docs/cli/schematics/2-schematics/1-workspace.mdx deleted file mode 100644 index 5f836f2..0000000 --- a/docs/cli/schematics/2-schematics/1-workspace.mdx +++ /dev/null @@ -1,69 +0,0 @@ ---- -title: Workspace -description: Generate a NanoForge workspace (monorepo root) ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -The `workspace` schematic creates the root of a NanoForge monorepo: the `nanoforge.config.ts` workspace declaration, `package.json`, and TypeScript or JavaScript base config. A workspace holds one or more projects generated with the [`project`](./2-project) schematic under `apps/`. - -`@nanoforge-dev/cli`, `@nanoforge-dev/config` (using the engine version resolved from `@nanoforge-dev/core`) and (for TypeScript) `typescript` are pinned to the newest registry version published at least 48h ago at generation time, mirroring pnpm's own `minimumReleaseAge` supply-chain protection so a freshly (and potentially compromised) published release isn't picked up immediately. Non-nanoforge packages like `typescript` are pinned to a specific version rather than a range; `typescript` is also kept on its `6.x` line rather than jumping to the `7.x` native rewrite. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:workspace --name=my-game -``` - -## Options - -| Option | Type | Default | Description | -| ---------------- | ------------------------------------ | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | `nanoforge-workspace` | The name of the workspace | -| `directory` | `string` | `name` | Destination directory for the generated files | -| `language` | `"ts" \| "js"` | `ts` | Language to use for generated source files | -| `strict` | `boolean` | `true` | Enable strict mode | -| `packageManager` | `"npm" \| "yarn" \| "pnpm" \| "bun"` | `npm` | Package manager to target | -| `allowBuilds` | `string[]` | `[]` | Packages allowed to run install/build scripts, in addition to `bun` | - -## Generated structure - -``` -my-game/ -├── package.json -├── tsconfig.json # TypeScript only -├── tsconfig.spec.json # TypeScript only -├── jsconfig.json # JavaScript only -├── pnpm-workspace.yaml # if packageManager: pnpm — allowBuilds map -├── nanoforge.config.ts # (or .js) -├── .gitignore -├── README.md -└── apps/ # generated with the `project` schematic -``` - -## Examples - -**Minimal TypeScript workspace:** - -```bash -schematics @nanoforge-dev/schematics:workspace --name=my-game -``` - -**pnpm workspace:** - -```bash -schematics @nanoforge-dev/schematics:workspace \ - --name=my-game \ - --packageManager=pnpm -``` - -**pnpm workspace allowing an extra dependency's build scripts (bun is always allowed):** - -```bash -schematics @nanoforge-dev/schematics:workspace \ - --name=my-game \ - --packageManager=pnpm \ - --allowBuilds=esbuild -``` diff --git a/docs/cli/schematics/2-schematics/2-configuration.mdx b/docs/cli/schematics/2-schematics/2-configuration.mdx deleted file mode 100644 index 8514f09..0000000 --- a/docs/cli/schematics/2-schematics/2-configuration.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Configuration -description: Generate a NanoForge configuration file ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -The `configuration` schematic creates a `nanoforge.config.json` file at the root of your project. This file is the central configuration consumed by the NanoForge CLI for builds, starts, and other operations. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:configuration -``` - -## Options - -| Option | Type | Default | Description | -| --------------- | -------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | `nanoforge-app` | The name of the application | -| `directory` | `string` | `.` | Destination directory | -| `server` | `boolean` | `false` | Include server configuration | -| `language` | `"ts" \| "js"` | `ts` | Language used in the project | -| `initFunctions` | `boolean` | `false` | Reference init functions in configuration | - -## Generated file - -``` -nanoforge.config.json -``` - -The generated file is an empty JSON object `{}` that you populate with the fields the NanoForge CLI expects. Refer to the [CLI documentation](https://github.com/NanoForge-dev/CLI) for the full list of supported fields. - -## Examples - -**Generate configuration at the project root:** - -```bash -schematics @nanoforge-dev/schematics:configuration --name=my-game -``` - -**Generate configuration for a server-enabled project:** - -```bash -schematics @nanoforge-dev/schematics:configuration \ - --name=my-game \ - --server=true -``` diff --git a/docs/cli/schematics/2-schematics/2-project.mdx b/docs/cli/schematics/2-schematics/2-project.mdx deleted file mode 100644 index 1ba4517..0000000 --- a/docs/cli/schematics/2-schematics/2-project.mdx +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Project -description: Generate a NanoForge client or server project inside a workspace ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -The `project` schematic generates a complete client or server project under `directory` (e.g. `apps/client`) inside a [`workspace`](./1-workspace): its own `package.json`, `nanoforge.config.ts`, `tsconfig.json`, example ECS component and system, `src/main.ts` entry point, and optionally a `Dockerfile` and lifecycle init functions. `directory` is the full destination path — it isn't appended with `part` automatically, so generating a client and a server side by side means passing e.g. `--directory=apps/client` and `--directory=apps/server` in two separate invocations. - -For a standalone project (`workspace: false`), engine dependency versions are pinned to the newest release published at least 48h ago, mirroring pnpm's own `minimumReleaseAge` supply-chain protection. `@nanoforge-dev/ecs` and `@nanoforge-dev/network` are resolved directly under those same names — no aliasing to a different registry package. A standalone project also generates its own `allowBuilds` config (`pnpm-workspace.yaml`'s `allowBuilds` map, `package.json`'s `allowScripts` or `trustedDependencies`, depending on `packageManager`) since it has no parent workspace root to provide one — see `allowBuilds` below. - -Engine packages are declared as `devDependencies`, except `@nanoforge-dev/network` on a server project, which is declared in `dependencies` because the server needs it at runtime. Every project gets `@nanoforge-dev/cli`, `@nanoforge-dev/core`, `@nanoforge-dev/common`, `@nanoforge-dev/config`, `@nanoforge-dev/asset` and `@nanoforge-dev/ecs`; a client project additionally gets `@nanoforge-dev/env`, `@nanoforge-dev/graphics-2d`, `@nanoforge-dev/input` and `@nanoforge-dev/network`. The engine packages (`core`, `common`, `config`, `asset`, `env`) share a single version, resolved from `@nanoforge-dev/core`. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:project --part=client --workspaceName=my-game --directory=apps/client -``` - -## Options - -| Option | Type | Default | Description | -| ---------------- | ------------------------------------ | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `part` | `"client" \| "server"` | _(required)_ | The type of project to generate | -| `workspaceName` | `string` | _(required)_ | Name of the parent workspace | -| `directory` | `string` | `apps` | Full destination path for this project | -| `language` | `"ts" \| "js"` | `ts` | Language to use for generated source files | -| `strict` | `boolean` | `true` | Enable strict mode | -| `packageManager` | `"npm" \| "yarn" \| "pnpm" \| "bun"` | `npm` | Package manager to target | -| `workspace` | `boolean` | `true` | Generated inside an existing NanoForge workspace | -| `initFunctions` | `boolean` | `false` | Add lifecycle init function hooks | -| `hasServer` | `boolean` | `false` | Sync the client's position with a companion server | -| `docker` | `boolean` | `false` | Generate a Dockerfile and .dockerignore | -| `editor` | `boolean` | `false` | Reserved for future editor build support | -| `libs` | `string[]` | `[]` | Relative paths to shared libs this project depends on, written into `nanoforge.config.ts` | -| `allowBuilds` | `string[]` | `[]` | Packages allowed to run install/build scripts (standalone projects only) | - -## Generated structure - -``` -/ -├── package.json -├── tsconfig.json # TypeScript only -├── jsconfig.json # JavaScript only -├── nanoforge.config.ts # (or .js) -├── pnpm-workspace.yaml # if !workspace && packageManager: pnpm && allowBuilds.length > 0 -├── Dockerfile # if docker: true -├── .dockerignore # if docker: true -├── src/ -│ ├── main.ts -│ ├── components/ -│ │ ├── position-2d.component.ts # both parts -│ │ └── drawable-circle-2d.component.ts # client only -│ └── systems/ -│ ├── draw-2d.system.ts # client only -│ ├── position-sync.system.ts # client only, if hasServer: true -│ └── move-2d.system.ts # server only -└── assets/ -``` - -## Examples - -**Generate a client project:** - -```bash -schematics @nanoforge-dev/schematics:project --part=client --workspaceName=my-game --directory=apps/client -``` - -**Generate a server project with Docker, syncing position with the client:** - -```bash -schematics @nanoforge-dev/schematics:project \ - --part=server \ - --workspaceName=my-game \ - --directory=apps/server \ - --docker=true -``` - -**Generate a client that syncs its position from that server:** - -```bash -schematics @nanoforge-dev/schematics:project \ - --part=client \ - --workspaceName=my-game \ - --directory=apps/client \ - --hasServer=true -``` - -**Generate a JavaScript client depending on a shared lib:** - -```bash -schematics @nanoforge-dev/schematics:project \ - --part=client \ - --workspaceName=my-game \ - --directory=apps/client \ - --language=js \ - --libs=../../libs/shared -``` diff --git a/docs/cli/schematics/2-schematics/3-component.mdx b/docs/cli/schematics/2-schematics/3-component.mdx deleted file mode 100644 index 9b14080..0000000 --- a/docs/cli/schematics/2-schematics/3-component.mdx +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: Component -description: Generate a NanoForge ECS component ---- - -import Tooltip from "mint/Tooltip"; - -## Overview - -The `component` schematic scaffolds a new ECS component class for a NanoForge client or server part. The generated file includes the component class, a default export required for code generation, and an `EDITOR_COMPONENT_MANIFEST` required for the NanoForge editor to display and configure the component. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:component --part=client --name=health -``` - -## Options - -| Option | Type | Default | Description | -| ----------- | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | `example` | Component name | -| `part` | `"client" \| "server"` | _(required)_ | The part of the application this component belongs to | -| `directory` | `string` | `.` | Destination directory for the generated file | -| `language` | `"ts" \| "js"` | `ts` | Language to use for the generated file | - -## Generated file - -`{directory}/{name}.component.ts` - -```ts -import { type EditorComponentManifest } from "@nanoforge-dev/ecs-client"; - -export class HealthComponent { - name = this.constructor.name; - - constructor( - public paramA: string, - public paramB: number, - public paramC: boolean = false, - ) {} - - get foo() { - return "bar"; - } - - get paramAOrDefault() { - return this.paramC ? this.paramA : "default"; - } - - addOne() { - this.paramB += 1; - } -} - -// Required to generate code -export default HealthComponent.name; - -// Required for the editor to display the component and generate code -export const EDITOR_COMPONENT_MANIFEST: EditorComponentManifest = { - name: "Health", - description: "Health component description", - params: [ - { - type: "string", - name: "paramA", - description: "Param A description", - example: "Example value", - }, - { - type: "number", - name: "paramB", - description: "Param B description", - example: 3, - }, - { - type: "boolean", - name: "paramC", - description: "Param C description", - example: true, - default: false, - optional: true, - }, - ], -}; -``` - -## Editor manifest - -The `EDITOR_COMPONENT_MANIFEST` export is required for the NanoForge editor to discover the component, render its configuration panel, and generate code. Each `params` entry describes one constructor parameter: - -| Field | Required | Description | -| ------------- | -------- | ------------------------------------------------------------ | -| `type` | Yes | Parameter type: `"string"`, `"number"`, or `"boolean"` | -| `name` | Yes | Constructor parameter name | -| `description` | Yes | Human-readable description shown in the editor | -| `example` | Yes | Example value used in code generation | -| `default` | No | Default value when the parameter is optional | -| `optional` | No | When `true`, the editor treats the parameter as non-required | - -## Examples - -**Generate a `PlayerComponent` for the client:** - -```bash -schematics @nanoforge-dev/schematics:component \ - --part=client \ - --name=player \ - --directory=client/components -``` - -**Generate a JavaScript server component:** - -```bash -schematics @nanoforge-dev/schematics:component \ - --part=server \ - --name=network-player \ - --language=js \ - --directory=server/components -``` diff --git a/docs/cli/schematics/2-schematics/3-part-base.mdx b/docs/cli/schematics/2-schematics/3-part-base.mdx deleted file mode 100644 index eec16aa..0000000 --- a/docs/cli/schematics/2-schematics/3-part-base.mdx +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: Part Base -description: Generate the base structure for a NanoForge client or server part ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -The `part-base` schematic generates the foundational folder structure for a NanoForge **client** or **server** part. It creates example components and systems, the `.nanoforge` save file used to track ECS state, and optionally lifecycle init functions. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:part-base --part=client -``` - -## Options - -| Option | Type | Default | Description | -| --------------- | ---------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `part` | `"client" \| "server"` | _(required)_ | The part of the application to generate | -| `directory` | `string` | `.` | Destination directory for the generated files | -| `language` | `"ts" \| "js"` | `ts` | Language to use for generated source files | -| `server` | `boolean` | `false` | Whether the application has a server | -| `initFunctions` | `boolean` | `false` | Add lifecycle init function hooks | - -## Generated structure - -``` -{directory}/ -├── {part}/ -│ ├── components/ -│ │ └── example.component.ts -│ ├── systems/ -│ │ └── example.system.ts -│ └── init/ # if initFunctions: true -│ ├── before-init.ts -│ ├── after-init.ts -│ ├── before-registry-init.ts -│ ├── after-registry-init.ts -│ ├── before-run.ts -│ └── after-run.ts -└── .nanoforge/ - └── {part}.save.json -``` - -## Save file - -The `.nanoforge/{part}.save.json` file is the source of truth for ECS state. It lists the libraries, components, systems, and entities registered for this part. The `part-main` schematic reads this file to generate the `main.ts` entry point. - -```json -{ - "libraries": [ ... ], - "components": [ - { - "name": "ExampleComponent", - "path": "./components/example.component.ts", - "paramsNames": ["paramA", "paramB", "paramC"] - } - ], - "systems": [ - { - "name": "exampleSystem", - "path": "./systems/example.system.ts" - } - ], - "entities": [ - { - "id": "exampleEntity", - "components": { - "ExampleComponent": { "paramA": "example", "paramB": 10 } - } - } - ] -} -``` - -## Init functions - -When `initFunctions` is `true`, the following lifecycle hooks are scaffolded: - -| File | Hook | Called | -| ------------------------- | -------------------- | ----------------------------------- | -| `before-init.ts` | `beforeInit` | Before the app initializes | -| `after-init.ts` | `afterInit` | After the app initializes | -| `before-registry-init.ts` | `beforeRegistryInit` | Before the ECS registry initializes | -| `after-registry-init.ts` | `afterRegistryInit` | After the ECS registry initializes | -| `before-run.ts` | `beforeRun` | Before the game loop starts | -| `after-run.ts` | `afterRun` | After the game loop ends | - -## Examples - -**Generate a TypeScript client part:** - -```bash -schematics @nanoforge-dev/schematics:part-base --part=client -``` - -**Generate a server part with init hooks:** - -```bash -schematics @nanoforge-dev/schematics:part-base \ - --part=server \ - --initFunctions=true -``` - -**Generate a JavaScript client in a specific directory:** - -```bash -schematics @nanoforge-dev/schematics:part-base \ - --part=client \ - --language=js \ - --directory=./my-game -``` diff --git a/docs/cli/schematics/2-schematics/4-part-main.mdx b/docs/cli/schematics/2-schematics/4-part-main.mdx deleted file mode 100644 index 60a88dc..0000000 --- a/docs/cli/schematics/2-schematics/4-part-main.mdx +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Part Main -description: Generate the main entry point for a NanoForge client or server part ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -The `part-main` schematic reads the `.nanoforge/{part}.save.json` file produced by `part-base` and generates a fully wired `main.ts` (or `main.js`) entry point. It registers all libraries, components, systems, and entities declared in the save file. - - - This schematic must be run after `part-base`. - - -## Usage - -```bash -schematics @nanoforge-dev/schematics:part-main --part=client -``` - -## Options - -| Option | Type | Default | Description | -| --------------- | ---------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `part` | `"client" \| "server"` | _(required)_ | The part of the application to generate | -| `directory` | `string` | `.` | Project root directory | -| `language` | `"ts" \| "js"` | `ts` | Language of the generated entry point | -| `initFunctions` | `boolean` | `false` | Wire init lifecycle functions into the main file | -| `saveFile` | `string` | — | Custom path to the save JSON file | -| `outFile` | `string` | — | Custom output path for the generated main file | -| `editor` | `boolean` | `false` | Generate the editor variant of the main file | - -## Output path resolution - -The generated file is placed at one of the following paths, in priority order: - -1. `outFile` — if provided explicitly -2. `.nanoforge/editor/{part}/main.{language}` — if `editor: true` -3. `{part}/main.{language}` — default - -## How it works - -`part-main` reads `{directory}/.nanoforge/{part}.save.json`, builds the full application bootstrap code, then writes the result as the entry point. Every time you add a component, system, or entity through the NanoForge CLI or editor, regenerating `part-main` keeps the entry point in sync with the save file. - -## Examples - -**Generate a client main file:** - -```bash -schematics @nanoforge-dev/schematics:part-main --part=client -``` - -**Generate a server main file with init hooks:** - -```bash -schematics @nanoforge-dev/schematics:part-main \ - --part=server \ - --initFunctions=true -``` - -**Generate with a custom save file and output path:** - -```bash -schematics @nanoforge-dev/schematics:part-main \ - --part=client \ - --saveFile=./custom.save.json \ - --outFile=./src/client/main.ts -``` - -**Regenerate the editor entry point:** - -```bash -schematics @nanoforge-dev/schematics:part-main \ - --part=client \ - --editor=true -``` diff --git a/docs/cli/schematics/2-schematics/4-system.mdx b/docs/cli/schematics/2-schematics/4-system.mdx deleted file mode 100644 index 51ecf8d..0000000 --- a/docs/cli/schematics/2-schematics/4-system.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: System -description: Generate a NanoForge ECS system ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -The `system` schematic scaffolds a new ECS system function for a NanoForge client or server part. The generated file includes the system function, a default export required for code generation, and an `EDITOR_SYSTEM_MANIFEST` required for the NanoForge editor to display and configure the system. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:system --part=client --name=movement -``` - -## Options - -| Option | Type | Default | Description | -| ----------- | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `name` | `string` | `example` | System name | -| `part` | `"client" \| "server"` | _(required)_ | The part of the application this system belongs to | -| `directory` | `string` | `.` | Destination directory for the generated file | -| `language` | `"ts" \| "js"` | `ts` | Language to use for the generated file | - -## Generated file - -`{directory}/{name}.system.ts` - -```ts -import { type Context } from "@nanoforge-dev/common"; -import { type EditorSystemManifest, type Registry } from "@nanoforge-dev/ecs-client"; - -import { ExampleComponent } from "../components/example.component"; - -export const movementSystem = (registry: Registry, ctx: Context) => { - const entities = registry.getZipper([ExampleComponent]); - - entities.forEach((entity) => { - if (entity.ExampleComponent.paramA === "end") { - ctx.app.setIsRunning(false); - return; - } - - if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end"; - - if (entity.ExampleComponent.paramB >= 0) - entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1; - }); -}; - -// Required to generate code -export default movementSystem.name; - -// Required for the editor to display the system and generate code -export const EDITOR_SYSTEM_MANIFEST: EditorSystemManifest = { - name: "movement", - description: - "This system end the game when paramB reaches 0 for any entity with ExampleComponent", - dependencies: ["ExampleComponent"], -}; -``` - -## Editor manifest - -The `EDITOR_SYSTEM_MANIFEST` export is required for the NanoForge editor to discover the system and wire it into the game loop. - -| Field | Required | Description | -| -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | Yes | System name as displayed in the editor | -| `description` | Yes | Human-readable description of what the system does | -| `dependencies` | Yes | Component names this system depends on | - -## System signature - -Every NanoForge system follows the same function signature: - -```ts -(registry: Registry, ctx: Context) => void -``` - -- **`registry`** — the ECS registry; use `registry.getZipper([...])` to query entities with specific components. -- **`ctx`** — the application context; provides access to `ctx.app`, `ctx.assets`, and other engine services. - -## Examples - -**Generate a `PhysicsSystem` for the client:** - -```bash -schematics @nanoforge-dev/schematics:system \ - --part=client \ - --name=physics \ - --directory=client/systems -``` - -**Generate a JavaScript server system:** - -```bash -schematics @nanoforge-dev/schematics:system \ - --part=server \ - --name=sync-state \ - --language=js \ - --directory=server/systems -``` diff --git a/docs/cli/schematics/2-schematics/5-docker.mdx b/docs/cli/schematics/2-schematics/5-docker.mdx deleted file mode 100644 index ce32b7d..0000000 --- a/docs/cli/schematics/2-schematics/5-docker.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Docker -description: Generate a Dockerfile for a NanoForge application ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -The `docker` schematic generates a production-ready `Dockerfile` and a `.dockerignore` at the specified directory. The Dockerfile is tailored to the package manager you use — selecting the correct base image, lockfile, and install command automatically. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:docker -``` - -## Options - -| Option | Type | Default | Description | -| ---------------- | ------------------------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `directory` | `string` | `.` | Destination directory for the generated files | -| `packageManager` | `"npm" \| "yarn" \| "pnpm" \| "bun"` | `npm` | Package manager used by the application | - -## Generated files - -``` -{directory}/ -├── Dockerfile -└── .dockerignore -``` - -## Dockerfile behaviour by package manager - -| Package manager | Base image | Install command | -| --------------- | -------------- | -------------------------------------------------- | -| `npm` | `node:25-slim` | `npm install --no-lockfile` | -| `yarn` | `node:25-slim` | `yarn install --frozen-lockfile` | -| `pnpm` | `node:25-slim` | `pnpm install --frozen-lockfile --allow-build=bun` | -| `bun` | `oven/bun:1.3` | `bun install --frozen-lockfile` | - -The Dockerfile follows a standard multi-step approach: - -1. Copy `package.json` and the lockfile. -2. Install dependencies with frozen lockfile for reproducible builds. -3. Copy the rest of the source. -4. Run `build`. -5. Start with `start`. - -## Examples - -**Generate a Dockerfile for an npm project:** - -```bash -schematics @nanoforge-dev/schematics:docker -``` - -**Generate a Dockerfile for a pnpm project:** - -```bash -schematics @nanoforge-dev/schematics:docker --packageManager=pnpm -``` - -**Generate in a specific directory:** - -```bash -schematics @nanoforge-dev/schematics:docker \ - --packageManager=bun \ - --directory=./my-game -``` diff --git a/docs/cli/schematics/2-schematics/6-component.mdx b/docs/cli/schematics/2-schematics/6-component.mdx deleted file mode 100644 index 9b14080..0000000 --- a/docs/cli/schematics/2-schematics/6-component.mdx +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: Component -description: Generate a NanoForge ECS component ---- - -import Tooltip from "mint/Tooltip"; - -## Overview - -The `component` schematic scaffolds a new ECS component class for a NanoForge client or server part. The generated file includes the component class, a default export required for code generation, and an `EDITOR_COMPONENT_MANIFEST` required for the NanoForge editor to display and configure the component. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:component --part=client --name=health -``` - -## Options - -| Option | Type | Default | Description | -| ----------- | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | `string` | `example` | Component name | -| `part` | `"client" \| "server"` | _(required)_ | The part of the application this component belongs to | -| `directory` | `string` | `.` | Destination directory for the generated file | -| `language` | `"ts" \| "js"` | `ts` | Language to use for the generated file | - -## Generated file - -`{directory}/{name}.component.ts` - -```ts -import { type EditorComponentManifest } from "@nanoforge-dev/ecs-client"; - -export class HealthComponent { - name = this.constructor.name; - - constructor( - public paramA: string, - public paramB: number, - public paramC: boolean = false, - ) {} - - get foo() { - return "bar"; - } - - get paramAOrDefault() { - return this.paramC ? this.paramA : "default"; - } - - addOne() { - this.paramB += 1; - } -} - -// Required to generate code -export default HealthComponent.name; - -// Required for the editor to display the component and generate code -export const EDITOR_COMPONENT_MANIFEST: EditorComponentManifest = { - name: "Health", - description: "Health component description", - params: [ - { - type: "string", - name: "paramA", - description: "Param A description", - example: "Example value", - }, - { - type: "number", - name: "paramB", - description: "Param B description", - example: 3, - }, - { - type: "boolean", - name: "paramC", - description: "Param C description", - example: true, - default: false, - optional: true, - }, - ], -}; -``` - -## Editor manifest - -The `EDITOR_COMPONENT_MANIFEST` export is required for the NanoForge editor to discover the component, render its configuration panel, and generate code. Each `params` entry describes one constructor parameter: - -| Field | Required | Description | -| ------------- | -------- | ------------------------------------------------------------ | -| `type` | Yes | Parameter type: `"string"`, `"number"`, or `"boolean"` | -| `name` | Yes | Constructor parameter name | -| `description` | Yes | Human-readable description shown in the editor | -| `example` | Yes | Example value used in code generation | -| `default` | No | Default value when the parameter is optional | -| `optional` | No | When `true`, the editor treats the parameter as non-required | - -## Examples - -**Generate a `PlayerComponent` for the client:** - -```bash -schematics @nanoforge-dev/schematics:component \ - --part=client \ - --name=player \ - --directory=client/components -``` - -**Generate a JavaScript server component:** - -```bash -schematics @nanoforge-dev/schematics:component \ - --part=server \ - --name=network-player \ - --language=js \ - --directory=server/components -``` diff --git a/docs/cli/schematics/2-schematics/7-system.mdx b/docs/cli/schematics/2-schematics/7-system.mdx deleted file mode 100644 index 51ecf8d..0000000 --- a/docs/cli/schematics/2-schematics/7-system.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: System -description: Generate a NanoForge ECS system ---- - -import { Tooltip } from "mintlify/components"; - -## Overview - -The `system` schematic scaffolds a new ECS system function for a NanoForge client or server part. The generated file includes the system function, a default export required for code generation, and an `EDITOR_SYSTEM_MANIFEST` required for the NanoForge editor to display and configure the system. - -## Usage - -```bash -schematics @nanoforge-dev/schematics:system --part=client --name=movement -``` - -## Options - -| Option | Type | Default | Description | -| ----------- | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `name` | `string` | `example` | System name | -| `part` | `"client" \| "server"` | _(required)_ | The part of the application this system belongs to | -| `directory` | `string` | `.` | Destination directory for the generated file | -| `language` | `"ts" \| "js"` | `ts` | Language to use for the generated file | - -## Generated file - -`{directory}/{name}.system.ts` - -```ts -import { type Context } from "@nanoforge-dev/common"; -import { type EditorSystemManifest, type Registry } from "@nanoforge-dev/ecs-client"; - -import { ExampleComponent } from "../components/example.component"; - -export const movementSystem = (registry: Registry, ctx: Context) => { - const entities = registry.getZipper([ExampleComponent]); - - entities.forEach((entity) => { - if (entity.ExampleComponent.paramA === "end") { - ctx.app.setIsRunning(false); - return; - } - - if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end"; - - if (entity.ExampleComponent.paramB >= 0) - entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1; - }); -}; - -// Required to generate code -export default movementSystem.name; - -// Required for the editor to display the system and generate code -export const EDITOR_SYSTEM_MANIFEST: EditorSystemManifest = { - name: "movement", - description: - "This system end the game when paramB reaches 0 for any entity with ExampleComponent", - dependencies: ["ExampleComponent"], -}; -``` - -## Editor manifest - -The `EDITOR_SYSTEM_MANIFEST` export is required for the NanoForge editor to discover the system and wire it into the game loop. - -| Field | Required | Description | -| -------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | Yes | System name as displayed in the editor | -| `description` | Yes | Human-readable description of what the system does | -| `dependencies` | Yes | Component names this system depends on | - -## System signature - -Every NanoForge system follows the same function signature: - -```ts -(registry: Registry, ctx: Context) => void -``` - -- **`registry`** — the ECS registry; use `registry.getZipper([...])` to query entities with specific components. -- **`ctx`** — the application context; provides access to `ctx.app`, `ctx.assets`, and other engine services. - -## Examples - -**Generate a `PhysicsSystem` for the client:** - -```bash -schematics @nanoforge-dev/schematics:system \ - --part=client \ - --name=physics \ - --directory=client/systems -``` - -**Generate a JavaScript server system:** - -```bash -schematics @nanoforge-dev/schematics:system \ - --part=server \ - --name=sync-state \ - --language=js \ - --directory=server/systems -``` diff --git a/docs/engine/getting-started/1-index.mdx b/docs/engine/getting-started/1-index.mdx deleted file mode 100644 index 1432013..0000000 --- a/docs/engine/getting-started/1-index.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Engine" -icon: "book" -description: "Nanoforge engine documentation" ---- - -# Engine - -This documentation covers the engine, its packages, and the surrounding usage guides. - -## Start Here - -- [Documentation](documentation) -- [How to Use](how_to_use) - -## Packages - -- [Registry](../registry) -- [Network](../network) diff --git a/docs/engine/getting-started/documentation.mdx b/docs/engine/getting-started/documentation.mdx deleted file mode 100644 index cd5dbce..0000000 --- a/docs/engine/getting-started/documentation.mdx +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Documentation" -icon: "book" -description: "Overview of the engine documentation" ---- - -# Documentation - -The documentation for the engine is separated across the different libraries of the engine. Everything is then gathered into this site and published from the repository automatically. - -This documentation is written in reStructuredText and is now being migrated to MDX so it is easier to maintain alongside the rest of the site. Sphinx is used to generate the rendered documentation. diff --git a/docs/engine/getting-started/how_to_use.mdx b/docs/engine/getting-started/how_to_use.mdx deleted file mode 100644 index d3992cd..0000000 --- a/docs/engine/getting-started/how_to_use.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "Introduction to using the Engine" -icon: "book" -description: "Getting started with the engine" ---- - -# Introduction to using the Engine - -Whether you work on this engine as a developer or you want to use it, you will want a test project. This page is a walkthrough for setting up a basic project. - -## As a developer on the engine - -As a developer you want to be able to use your changes in your own project. Therefore it is recommended to use the provided [CLI](https://github.com/NanoForge-dev/CLI). - -## As a user - -As a user you can either use the template and change the dependency location, or create a project and add the Nanoforge dependencies. It is recommended to use Bun as a package manager. diff --git a/docs/engine/network/index.mdx b/docs/engine/network/index.mdx deleted file mode 100644 index 7c1e3c9..0000000 --- a/docs/engine/network/index.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Network Overview" -icon: "book" -description: "Overview of the engine networking docs" ---- - -# Network Overview - -This page describes the engine's networking libraries: `network-server` and `network-client`. Together they provide a small, pragmatic networking layer used by the example `pong-network` game. - -## Goals - -- Keep the protocol minimal and predictable for multiplayer games. -- Use well-understood transports: TCP for reliable control messages and UDP for low-latency, best-effort state updates. -- Provide clear validation hooks such as magic values and versioning so malformed packets are ignored early. - -## Related Pages - -- [Network Client](network-client) -- [Network Server](network-server) -- [Packet Framing](packet-framing) -- [Network Server API](network-server-api) -- [Network Client API](network-client-api) diff --git a/docs/engine/network/network-client-api.mdx b/docs/engine/network/network-client-api.mdx deleted file mode 100644 index d90df6e..0000000 --- a/docs/engine/network/network-client-api.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "network-client API" -icon: "book" -description: "API reference for the client networking package" ---- - -# network-client API - -## TCPClient - -### connect() - -Initiate a WebSocket connection to the server, for example `ws://:`. - -Returns: `Promise` - -### isConnected() - -Return `true` when the underlying WebSocket is open. - -Returns: `boolean` - -### sendData(data) - -Send a payload to the server. - -Parameter `data`: `Uint8Array` raw payload bytes. - -Returns: `void` - -### getReceivedPackets() - -Return an array of complete packets that were reassembled from received chunks. - -Returns: `Uint8Array[]` - -## UDPClient - -### connect() - -Open a WebSocket for signaling, create an `RTCPeerConnection`, and initiate an SDP offer. - -Returns: `Promise` - -### isConnected() - -Return `true` when the `RTCDataChannel` is open. - -Returns: `boolean` - -### sendData(data) - -Send a payload on the data channel. - -Parameter `data`: `Uint8Array` raw payload bytes. - -Returns: `void` - -### getReceivedPackets() - -Return an array of complete packets reassembled from received data-channel chunks. - -Returns: `Uint8Array[]` diff --git a/docs/engine/network/network-client.mdx b/docs/engine/network/network-client.mdx deleted file mode 100644 index 4bd4061..0000000 --- a/docs/engine/network/network-client.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "Client Networking (network-client)" -icon: "book" -description: "How the client-side networking package works" ---- - -# Client Networking (network-client) - -This document describes how the `network-client` package connects to a `network-server` instance and the concrete APIs used from client-side code. - -## Overview - -A client connects to a single server instance. The package uses one TCP/WebSocket control channel and can also negotiate a single WebRTC data channel for unreliable traffic. - -Client responsibilities in a game are typically: - -- Initiate a TCP connection and send control commands such as join, play, and input. -- Optionally negotiate a WebRTC data channel for receiving server snapshots or sending low-latency updates. - -## Example - -It works the same with UDP: - -```javascript -// Wait for connection to be established -async function waitForConnection() { - if (network.tcp?.isConnected()) return; - - return new Promise((resolve) => { - const check = () => { - if (network.tcp.isConnected()) { - resolve(); - } else { - setTimeout(check, 50); - } - }; - - check(); - }); -} - -await waitForConnection(); - -// Send a JSON-encoded packet -network.tcp.sendData(new TextEncoder().encode(JSON.stringify({ hello: "world" }))); - -// Receive raw server packets -const latestPackets = getReceivedPackets(); - -// Decode packets if encoded as JSON -const decodedPackets = latestPackets.map((packet) => { - return JSON.parse(new TextDecoder().decode(packet)); -}); -``` - -## Notes - -- See [Network Client API](network-client-api) for the full list of available functions. -- For packet framing and terminator semantics, see [Packet Framing](packet-framing). diff --git a/docs/engine/network/network-server-api.mdx b/docs/engine/network/network-server-api.mdx deleted file mode 100644 index c824399..0000000 --- a/docs/engine/network/network-server-api.mdx +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "network-server API" -icon: "book" -description: "API reference for the server networking package" ---- - -# network-server API - -## TCPServer - -### listen() - -Start the WebSocket server and begin accepting clients. - -Returns: `void` - -### getConnectedClients() - -Return a snapshot array of numeric client IDs currently connected. - -Returns: `number[]` - -### sendToEverybody(data) - -Send a payload to every connected client. - -Parameter `data`: `Uint8Array` raw payload bytes. - -Returns: `void` - -### sendToClient(clientId, data) - -Send a payload to the client identified by `clientId`. - -Parameter `clientId`: `number` numeric client identifier. - -Parameter `data`: `Uint8Array` payload bytes. - -Returns: `void` - -### getReceivedPackets() - -Parse and return complete packets received from each client. Each packet is a `Uint8Array` buffer. - -Returns: `Map` - -## UDPServer - -### listen() - -Start the signaling WebSocket and accept incoming client offers. - -Returns: `void` - -### getConnectedClients() - -Return a snapshot array of client IDs with active data channels. - -Returns: `number[]` - -### sendToEverybody(data) - -Send a payload to every connected data channel. - -Parameter `data`: `Uint8Array` raw payload bytes. - -Returns: `void` - -### sendToClient(clientId, data) - -Send a payload to a single client data channel. - -Parameter `clientId`: `number` - -Parameter `data`: `Uint8Array` - -Returns: `void` - -### getReceivedPackets() - -Parse incoming channel chunks and return a map of complete packets per client. - -Returns: `Map` diff --git a/docs/engine/network/network-server.mdx b/docs/engine/network/network-server.mdx deleted file mode 100644 index 3166d13..0000000 --- a/docs/engine/network/network-server.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Server Networking (network-server)" -icon: "book" -description: "How the server-side networking package works" ---- - -# Server Networking (network-server) - -This document explains the `network-server` package implementation and the APIs used from server-side code. - -## Overview - -The server listens on configured ports and accepts client connections. A single server process can accept many clients, and typical responsibilities in a game are: - -- Accept reliable control messages from clients over the TCP/WebSocket channel. -- Optionally establish `RTCPeerConnection`s via WebSocket signaling to receive unreliable, unordered data channels for low-latency state updates. - -## Example - -It works the same with UDP: - -```javascript -// Send everybody a JSON-encoded packet -network.tcp.sendToEverybody(new TextEncoder().encode(JSON.stringify({ type: "are you here" }))); - -// Check connected clients -const connectedClients = getConnectedClients(); - -// Receive all packets -const allPackets = network.tcp.getReceivedPackets(); - -// Get first client packets -const firstClientPackets = map.get(connectedClients[0]); - -// Decode packets if encoded as JSON -const decodedPackets = firstClientPackets.map((packet) => { - return JSON.parse(new TextDecoder().decode(packet)); -}); -``` - -## Notes - -- See [Network Server API](network-server-api) for the full list of available functions. -- For packet framing and terminator semantics, see [Packet Framing](packet-framing). diff --git a/docs/engine/network/packet-framing.mdx b/docs/engine/network/packet-framing.mdx deleted file mode 100644 index 871678f..0000000 --- a/docs/engine/network/packet-framing.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Packet Framing" -icon: "book" -description: "How packets are framed and reassembled" ---- - -# Packet Framing - -This note explains how packets are framed and reassembled in the network packages. The framing strategy is simple and robust against transport fragmentation or aggregation. - -## Concept - -- Each logical packet is a payload of bytes that the application wants to send, whether JSON or binary. -- Before sending, the library appends a configurable terminator string, or magic value, to the end of the payload. The default value in the project config is `PACKET_END`. -- The terminator is applied as bytes using UTF-8 encoding, so it becomes a unique byte suffix that marks the end of a logical packet. - -## Why Use an End Terminator - -- Transports like WebSocket and RTC DataChannel may split or combine application messages into arbitrary chunks. A terminator lets a receiver reliably detect the end of each logical packet regardless of how the transport fragments or aggregates bytes. -- A short, human-readable terminator makes debugging easier. -- The terminator is configurable so you can choose a value that does not collide with your payload contents, which matters especially for raw or binary payloads. - -## Sender Logic - -1. Serialize the application message into bytes, for example JSON to UTF-8 bytes or a binary codec output. -2. Append the configured terminator bytes to the end of the payload. -3. Send the resulting buffer on the transport, either WebSocket or DataChannel. - -## Receiver Logic - -1. Accumulate incoming chunks of bytes into a per-connection buffer. -2. Repeatedly search the accumulated buffer for the terminator sequence. -3. For each occurrence, extract bytes from the start of the buffer up to, but not including, the terminator. That is a complete logical packet. -4. Remove the extracted packet and trailing terminator from the buffer, then continue searching. Keep any leftover bytes, which represent a partial packet, for the next incoming chunk. diff --git a/docs/engine/registry/index.mdx b/docs/engine/registry/index.mdx deleted file mode 100644 index ac8647b..0000000 --- a/docs/engine/registry/index.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Registry" -icon: "book" -description: "Registry and WebAssembly notes" ---- - -# Registry - -The registry class is written in C++ and exposed to WebAssembly using Emscripten. That choice keeps the performance benefits of C++ for entity and component management while still making the code available to web applications. - -## Design Choices - -This design makes some trade-offs between performance and ease of use. A pure C++ ECS would be easier to use on its own, but exposing it to WebAssembly means the interface has to balance clarity and browser-friendly integration. - -### Const Correctness - -In a regular C++ ECS, const correctness is a given, but when exposing C++ to WebAssembly the boundaries do not map perfectly to JavaScript. Methods that would typically return const references in C++ may return non-const references or copies when exposed to WebAssembly. We keep the const correctness in the C++ code to preserve intent and clarity within the C++ domain, even if it does not fully carry over to the WebAssembly interface. - -### Error Handling - -Any thrown exceptions in C++ will result in a runtime error in JavaScript. That can make error messages less descriptive or user-friendly than native JavaScript errors. To mitigate that, thorough testing and validation in the C++ code is recommended before issues reach the WebAssembly layer. diff --git a/docs/engine/registry/writing_web_assembly.mdx b/docs/engine/registry/writing_web_assembly.mdx deleted file mode 100644 index 6515dc8..0000000 --- a/docs/engine/registry/writing_web_assembly.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Writing Web Assembly" -icon: "book" -description: "Guidance for WebAssembly modules" ---- - -# Writing Web Assembly - -## Code Splitting - -When writing WebAssembly modules, it is important to consider code splitting for readability and maintainability. We try to split binding and logic into separate files wherever possible. That keeps the codebase organized and makes it easier to navigate. - -For example, in the ECS package, the binding logic is in `.cpp` files while the core logic resides in `.hpp` files. That separation lets developers focus on either the bindings or the logic without having to work through both at the same time. - -## Documentation - -When documenting WebAssembly modules, we follow the same general approach as C++ documentation. Doxygen-style comments are used to provide clear explanations of classes, methods, and parameters. That documentation is important for developers who will use or maintain the modules because it provides the necessary context and usage information. - -## Logging - -Logging in WebAssembly is costly in memory because of the interaction between C++ and JavaScript. For that reason, logging from the JavaScript side is preferred whenever possible. If logging from C++ is necessary, be aware of the performance implications and the risk of memory leaks. WebAssembly memory is limited, so excessive logging can lead to out-of-memory errors. diff --git a/guides/cli/cli/1-overview.mdx b/guides/cli/cli/1-overview.mdx deleted file mode 100644 index 0f987de..0000000 --- a/guides/cli/cli/1-overview.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Guides -description: Task-oriented walkthroughs for common NanoForge CLI workflows ---- - -import { Card, CardGroup } from "mintlify/components"; - -The [Commands reference](/docs/commands/1-overview) documents what each command does. These guides -take the opposite angle: they follow the **paths a user actually walks** when building a game with -the CLI, stitching commands together end to end. - - - - Scaffold a project, understand what was generated, and run it. - - - Use dev mode and regenerate files as you change your configuration. - - - Produce a production build and serve it, optionally over HTTPS. - - - Create your own ECS pieces or install shared ones from the registry. - - - Authenticate and share a component, system, or library with others. - - diff --git a/guides/cli/cli/2-create-a-project.mdx b/guides/cli/cli/2-create-a-project.mdx deleted file mode 100644 index a21027c..0000000 --- a/guides/cli/cli/2-create-a-project.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Create your first project -description: Scaffold a NanoForge project and understand the result ---- - -import { Step, Steps } from "mintlify/components"; - -This guide walks the most common starting point: turning an idea into a runnable project. - - - - The interactive scaffolder is the easiest way to start: - - ```bash - nf new - ``` - - You'll be asked for a name, language, package manager, and whether to include a server, Docker - files, git, and so on. To skip the prompts, pass the answers as flags: - - ```bash - nf new --name my-game --language ts --package-manager pnpm --server - ``` - - See [`nf new`](/docs/commands/2-commands/1-new) for the full flag list. - - - - - Move into the project and inspect it: - - ```bash - cd my-game - ``` - - The most important file is `nanoforge.config.json`, the central configuration the CLI reads for - every command. Each field is documented in - [Configuration file](/docs/configuration/1-configuration-file). - - - - - ```bash - nf dev - ``` - - Your game now runs locally in development mode. The next guide, - [Develop locally](./3-develop-locally), goes deeper into the dev workflow. - - - diff --git a/guides/cli/cli/3-develop-locally.mdx b/guides/cli/cli/3-develop-locally.mdx deleted file mode 100644 index 3dcda03..0000000 --- a/guides/cli/cli/3-develop-locally.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Develop locally -description: Iterate on your game with dev mode and file generation ---- - -import { Note, Step, Steps } from "mintlify/components"; - -Once a project exists, most of your time is spent in the develop-and-iterate loop. - - - - ```bash - nf dev - ``` - - `nf dev` serves the game and watches your files, so changes are picked up as you work. Keep it - running in a dedicated terminal. - - - - - Working in a monorepo or with multiple configs? Every command accepts `-d` and `-c`: - - ```bash - nf dev -d ./packages/game -c nanoforge.dev.json - ``` - - - - - - Need runtime values like a server address or ports? Put them in a `.env` file - see [Environment - variables](/docs/configuration/2-environment-variables). - diff --git a/guides/cli/cli/4-build-and-deploy.mdx b/guides/cli/cli/4-build-and-deploy.mdx deleted file mode 100644 index 9fbb2d2..0000000 --- a/guides/cli/cli/4-build-and-deploy.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Build & deploy -description: Produce a production build and serve it ---- - -import { Note, Step, Steps } from "mintlify/components"; - -When your game is ready to ship, the build-and-serve path takes it from source to a running -production instance. - - - - ```bash - nf build - ``` - - The client and server are compiled into the output directories defined in your - [configuration](/docs/configuration/1-configuration-file) (`.nanoforge/client` and - `.nanoforge/server` by default). Override any path per run, for example: - - ```bash - nf build --client-out-dir dist/client --server-out-dir dist/server - ``` - - - - - ```bash - nf start - ``` - - `nf start` launches the loader (the website that loads the game) and the server when enabled. - Choose the loader port with `-p`: - - ```bash - nf start --port 8080 - ``` - - - - - Provide a certificate and key to serve securely: - - ```bash - nf start --cert ./certs/cert.pem --key ./certs/key.pem - ``` - - - - - - Scaffolding with `nf new --docker` generates Docker files so you can containerize the build for - deployment. - diff --git a/guides/cli/cli/5-components-and-systems.mdx b/guides/cli/cli/5-components-and-systems.mdx deleted file mode 100644 index 6da1f6a..0000000 --- a/guides/cli/cli/5-components-and-systems.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Add components & systems -description: Create your own ECS pieces or install shared ones ---- - -import { Step, Steps } from "mintlify/components"; - -NanoForge games are built from ECS **components** and **systems**. You can author your own or pull -ready-made ones from the registry. - -## Create your own - - - - ```bash - nf create component --name Position - ``` - - Files are created under the client's component directory by default. Target the server with - `--server`. - - - - - ```bash - nf create system --name Movement --server - ``` - - See [`nf create`](/docs/commands/2-commands/6-create) for all options. - - - - -## Install shared ones - -To reuse components, systems, or libraries published to the NanoForge registry: - -```bash -# a component or system -nf install my-org/health-bar - -# a library, on the server -nf add my-org/physics --lib --server -``` - -If the package lives in a private scope, [log in](../../docs/commands/2-commands/9-registry) first: - -```bash -nf login --api-key -``` - -See [`nf install`](../../docs/commands/2-commands/7-install) for the full reference. diff --git a/guides/cli/cli/6-publish-a-package.mdx b/guides/cli/cli/6-publish-a-package.mdx deleted file mode 100644 index fc26ef0..0000000 --- a/guides/cli/cli/6-publish-a-package.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Publish a package -description: Share a component, system, or library through the registry ---- - -import { Note, Step, Steps } from "mintlify/components"; - -Once you've built something reusable, you can publish it to the NanoForge registry so other projects -can `nf install` it. - - - - Log in with your API key. Authentication is global by default; use `-l` to scope it to the - current project only: - - ```bash - nf login --api-key - ``` - - - - - From the package directory: - - ```bash - nf publish - ``` - - - -```bash nf unpublish ``` - - - ```bash - nf logout - ``` - - - - - All four commands are documented together under [registry - commands](/docs/commands/2-commands/9-registry). - diff --git a/index.mdx b/index.mdx new file mode 100644 index 0000000..56f33d4 --- /dev/null +++ b/index.mdx @@ -0,0 +1,29 @@ +--- +title: "NanoForge" +description: "Build browser games with the NanoForge engine, CLI and editor" +--- + +NanoForge is a game engine for the web browser, built around an ECS (entities, components, systems), with a CLI to create, run and ship games and a visual editor. + +## Start here + + + + The engine packages and modules: core, ECS, graphics, input, network, sound. + + + Install `nf`, create a project, develop locally, build and deploy. + + + Edit scenes, entities, components and systems visually, and write plugins. + + + Task-oriented walkthroughs for common workflows. + + + +## How this site is made + +Each page belongs to the repository of the product it documents (`engine`, `cli`, `loader`, `editor`), in its `docs/docs` folder. Every release of that repository copies its pages here, and the API reference is generated from the engine's TSDoc comments. + +Found a mistake? Open an issue or a pull request in the repository of that product. diff --git a/references/1.3.0/.tsdocs/client/ValidRefs.js b/references/1.3.0/.tsdocs/client/ValidRefs.js deleted file mode 100644 index c60e691..0000000 --- a/references/1.3.0/.tsdocs/client/ValidRefs.js +++ /dev/null @@ -1,22 +0,0 @@ -// @ts-nocheck -/** - * Valid API Reference IDs - * Auto-generated by mint-tsdocs during documentation build. - * Used by RefLink component for runtime validation. - * - * @generated - */ - -// Expose VALID_REFS on window for use by RefLink component -// This avoids ES6 module import issues with .jsx MIME types -if (typeof window !== 'undefined') { - window.VALID_REFS = new Set([ - "core-editor", - "core-editor.NanoforgeClient", - "core-editor.NanoforgeClient.useGraphics", - "core-editor.NanoforgeClient.useInput", - "core-editor.NanoforgeClient.useSound", - "core-editor.NanoforgeFactory", - "core-editor.NanoforgeServer" -]); -} diff --git a/references/1.3.0/.tsdocs/client/tsdocs-config.js b/references/1.3.0/.tsdocs/client/tsdocs-config.js deleted file mode 100644 index db361c4..0000000 --- a/references/1.3.0/.tsdocs/client/tsdocs-config.js +++ /dev/null @@ -1,28 +0,0 @@ -/** - * TSDocs Runtime Configuration - * Auto-generated by mint-tsdocs during documentation build. - * Loaded globally as a custom script for all documentation pages. - * - * This provides runtime configuration to TSDocs components (RefLink, PageLink, etc.) - * without requiring imports between snippet files. - * - * @generated - */ -(function() { - 'use strict'; - - // Global TSDocs configuration accessible to all components - window.TSDOCS_CONFIG = { - basePath: "/core-editor", - packageName: "core-editor", - generatedAt: "2026-06-04T02:49:10.360Z" - }; - - // Helper function to generate absolute path for an API reference - window.getRefPath = function(refId) { - var segments = refId.split('.').filter(function(s) { return s.length > 0; }); - return segments.length > 0 - ? window.TSDOCS_CONFIG.basePath + '/' + segments.join('/') - : window.TSDOCS_CONFIG.basePath; - }; -})(); diff --git a/references/1.3.0/.tsdocs/client/tsdocs-styles.css b/references/1.3.0/.tsdocs/client/tsdocs-styles.css deleted file mode 100644 index 0541fd9..0000000 --- a/references/1.3.0/.tsdocs/client/tsdocs-styles.css +++ /dev/null @@ -1,65 +0,0 @@ -/** - * TSDocs Default Styles - * Auto-generated by mint-tsdocs during documentation generation - * - * To override any style, add more specific selectors in docs/style.css: - * - * Example: - * .prose .tsdocs-reflink.broken-link { - * border-bottom: 3px solid orange !important; - * } - */ - -/* ============================================================================ - * Broken Link Indicators - * ============================================================================ - * Used by RefLink and PageLink components to highlight invalid references - */ - -/* RefLink broken links */ -.prose .tsdocs-reflink.broken-link { - border-bottom: 2px dotted #ef4444 !important; - color: #ef4444 !important; - text-decoration: wavy underline !important; -} - -/* PageLink broken links */ -.prose .tsdocs-pagelink.broken-link { - border-bottom: 2px dotted #ef4444 !important; - color: #ef4444 !important; - text-decoration: wavy underline !important; -} - -/* Dark mode variants */ -.dark .prose .tsdocs-reflink.broken-link { - border-bottom-color: #f87171 !important; - color: #f87171 !important; -} - -.dark .prose .tsdocs-pagelink.broken-link { - border-bottom-color: #f87171 !important; - color: #f87171 !important; -} - -/* ============================================================================ - * TypeTree Component Styles - * ============================================================================ - * Currently uses Mintlify's native ResponseField and Expandable components - * Use this selector for custom TypeTree styling: - * [data-component="tsdocs-typetree"] { } - */ - -/* ============================================================================ - * Preview Component Styles - * ============================================================================ - * Wrapper for code examples and previews - * Use this selector for custom Preview styling: - * [data-component="tsdocs-preview"] { } - */ - -/* ============================================================================ - * Feature Component Styles - * ============================================================================ - * The Feature component now uses Tailwind CSS classes directly. - * No custom styles needed - matches Mintlify Card component styling. - */ diff --git a/references/1.3.0/.tsdocs/global.d.ts b/references/1.3.0/.tsdocs/global.d.ts deleted file mode 100644 index 397b26d..0000000 --- a/references/1.3.0/.tsdocs/global.d.ts +++ /dev/null @@ -1,138 +0,0 @@ -/** - * Global type declarations for mint-tsdocs - * Auto-generated during documentation build. - * - * This file provides: - * - Mintlify component type declarations (ResponseField, Expandable) - * - Window object augmentations for runtime scripts - * - Type-safe ValidRefId and ValidPageId unions - * - * @generated - */ - -// ============================================================================ -// Mintlify Component Declarations -// ============================================================================ - -/** - * Global type declarations for Mintlify components. - * These components are provided by Mintlify at runtime. - */ -declare namespace JSX { - interface IntrinsicElements { - ResponseField: any; - Expandable: any; - } -} - -// Also declare as global React components -declare const ResponseField: React.FC; -declare const Expandable: React.FC; - -// ============================================================================ -// ValidRefs Types -// ============================================================================ - -/** - * Union type of all valid API reference IDs - * - * Generated from the API model structure during documentation build. - * Used by RefLink component for type-safe reference validation. - */ -export type ValidRefId = - | "core-editor" - | "core-editor.NanoforgeClient" - | "core-editor.NanoforgeClient.useGraphics" - | "core-editor.NanoforgeClient.useInput" - | "core-editor.NanoforgeClient.useSound" - | "core-editor.NanoforgeFactory" - | "core-editor.NanoforgeServer"; - -/** - * Check if a RefId is valid - * - * @param refId - The reference ID to check - * @returns True if the refId is valid - */ -export function isValidRef(refId: string): refId is ValidRefId; - -// ============================================================================ -// ValidPages Types -// ============================================================================ - -/** - * Union type of all valid page IDs from docs.json - * - * Generated from docs.json navigation structure during documentation build. - * Used by PageLink component for type-safe page validation. - */ -export type ValidPageId = - never; - -/** - * Check if a PageId is valid - * - * @param pageId - The page ID to check - * @returns True if the pageId is valid - */ -export function isValidPage(pageId: string): pageId is ValidPageId; - -// ============================================================================ -// TsdocsConfig Types -// ============================================================================ - -/** - * Runtime configuration for TSDocs components - * - * Available via window.TSDOCS_CONFIG after tsdocs-config.js loads. - */ -export interface TsdocsConfig { - /** Base path for API reference pages (e.g., "/reference") */ - basePath: string; - - /** Package name */ - packageName: string; - - /** Generated timestamp (ISO 8601) */ - generatedAt: string; -} - -// ============================================================================ -// Window Object Augmentation -// ============================================================================ - -declare global { - interface Window { - /** - * Set of all valid RefIds in the documentation - * Populated by ValidRefs.js at runtime - */ - VALID_REFS?: Set; - - /** - * Set of all valid PageIds in the documentation - * Populated by ValidPages.js at runtime - */ - VALID_PAGES?: Set; - - /** - * Runtime configuration object - * Populated by tsdocs-config.js at runtime - */ - TSDOCS_CONFIG?: TsdocsConfig; - - /** - * Get absolute path for an API reference - * - * @param refId - The RefId (e.g., "mint-tsdocs.MarkdownDocumenter") - * @returns Absolute path (e.g., "/reference/mint-tsdocs/MarkdownDocumenter") - * - * @example - * getRefPath("mint-tsdocs.MarkdownDocumenter") - * // Returns: "/reference/mint-tsdocs/MarkdownDocumenter" - */ - getRefPath?: (refId: string) => string; - } -} - -export {}; diff --git a/references/1.3.0/asset-manager/asset-manager.mdx b/references/1.3.0/asset-manager/asset-manager.mdx deleted file mode 100644 index 1d70162..0000000 --- a/references/1.3.0/asset-manager/asset-manager.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "asset-manager package" -icon: "package" -description: "@nanoforge-dev/asset-manager API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/asset-manager -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary.mdx b/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary.mdx deleted file mode 100644 index 4b93be7..0000000 --- a/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "AssetManagerLibrary class" -icon: "box" -description: "AssetManagerLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# AssetManagerLibrary -## Signature - -```typescript -declare class AssetManagerLibrary extends BaseAssetManagerLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -## Methods - -### __init - - - -### getAsset - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__init.mdx b/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__init.mdx deleted file mode 100644 index 2a476bf..0000000 --- a/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__name.mdx b/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/getAsset.mdx b/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/getAsset.mdx deleted file mode 100644 index 86031d3..0000000 --- a/references/1.3.0/asset-manager/asset-manager/AssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset -## Signature - -```typescript -getAsset(path: string): NfFile; -``` - -## Parameters - -### path -**Type**:`string` - - - -## Returns - -**Type**:`NfFile` \ No newline at end of file diff --git a/references/1.3.0/asset-manager/index.mdx b/references/1.3.0/asset-manager/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/asset-manager/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/common/common.mdx b/references/1.3.0/common/common.mdx deleted file mode 100644 index 61d11e1..0000000 --- a/references/1.3.0/common/common.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "common package" -icon: "package" -description: "@nanoforge-dev/common API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/common -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ASSET_MANAGER_LIBRARY.mdx b/references/1.3.0/common/common/ASSET_MANAGER_LIBRARY.mdx deleted file mode 100644 index 2fd5668..0000000 --- a/references/1.3.0/common/common/ASSET_MANAGER_LIBRARY.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ASSET_MANAGER_LIBRARY variable" -icon: "variable" -description: "ASSET_MANAGER_LIBRARY API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ASSET_MANAGER_LIBRARY - - -## Signature - -```typescript -ASSET_MANAGER_LIBRARY: unique symbol -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ApplicationContext.mdx b/references/1.3.0/common/common/ApplicationContext.mdx deleted file mode 100644 index eb3f7a5..0000000 --- a/references/1.3.0/common/common/ApplicationContext.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "ApplicationContext class" -icon: "box" -description: "ApplicationContext API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ApplicationContext -## Signature - -```typescript -declare abstract class ApplicationContext -``` - -## Constructors - -*No constructors defined.* - -## Properties - -### _delta -**Modifiers**: protected -**Type**:`protected _delta: number;` -**Default**: `` - - - -### delta -**Modifiers**: readonly -**Type**:`get delta(): number;` -**Default**: `` - - - -### isRunning -**Modifiers**: readonly -**Type**:`get isRunning(): boolean;` -**Default**: `` - - - -## Methods - -### muteSoundLibraries -**Modifiers**: abstract - - - -### setIsRunning - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ApplicationContext/_delta.mdx b/references/1.3.0/common/common/ApplicationContext/_delta.mdx deleted file mode 100644 index 06e8fde..0000000 --- a/references/1.3.0/common/common/ApplicationContext/_delta.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "_delta" -icon: "variable" -description: "_delta API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _delta - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ApplicationContext/delta.mdx b/references/1.3.0/common/common/ApplicationContext/delta.mdx deleted file mode 100644 index bf00daa..0000000 --- a/references/1.3.0/common/common/ApplicationContext/delta.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "delta" -icon: "variable" -description: "delta API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# delta - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ApplicationContext/isRunning.mdx b/references/1.3.0/common/common/ApplicationContext/isRunning.mdx deleted file mode 100644 index a00a2b4..0000000 --- a/references/1.3.0/common/common/ApplicationContext/isRunning.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "isRunning" -icon: "variable" -description: "isRunning API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isRunning - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ApplicationContext/muteSoundLibraries.mdx b/references/1.3.0/common/common/ApplicationContext/muteSoundLibraries.mdx deleted file mode 100644 index ac2173b..0000000 --- a/references/1.3.0/common/common/ApplicationContext/muteSoundLibraries.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "muteSoundLibraries" -icon: "function" -description: "muteSoundLibraries API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# muteSoundLibraries -## Signature - -```typescript -abstract muteSoundLibraries(): void; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/common/common/ApplicationContext/setIsRunning.mdx b/references/1.3.0/common/common/ApplicationContext/setIsRunning.mdx deleted file mode 100644 index 734aef0..0000000 --- a/references/1.3.0/common/common/ApplicationContext/setIsRunning.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "setIsRunning" -icon: "function" -description: "setIsRunning API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setIsRunning -## Signature - -```typescript -setIsRunning(value: boolean): void; -``` - -## Parameters - -### value -**Type**:`boolean` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseAssetManagerLibrary.mdx b/references/1.3.0/common/common/BaseAssetManagerLibrary.mdx deleted file mode 100644 index 504718d..0000000 --- a/references/1.3.0/common/common/BaseAssetManagerLibrary.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "BaseAssetManagerLibrary class" -icon: "box" -description: "BaseAssetManagerLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseAssetManagerLibrary -## Signature - -```typescript -declare abstract class BaseAssetManagerLibrary extends Library implements IAssetManagerLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -### __init -**Modifiers**: abstract - - - -### getAsset -**Modifiers**: abstract - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseAssetManagerLibrary/__init.mdx b/references/1.3.0/common/common/BaseAssetManagerLibrary/__init.mdx deleted file mode 100644 index 83b190a..0000000 --- a/references/1.3.0/common/common/BaseAssetManagerLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -abstract __init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseAssetManagerLibrary/getAsset.mdx b/references/1.3.0/common/common/BaseAssetManagerLibrary/getAsset.mdx deleted file mode 100644 index dac86a2..0000000 --- a/references/1.3.0/common/common/BaseAssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset -## Signature - -```typescript -abstract getAsset(path: string): NfFile; -``` - -## Parameters - -### path -**Type**:`string` - - - -## Returns - -**Type**:`NfFile` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseComponentSystemLibrary.mdx b/references/1.3.0/common/common/BaseComponentSystemLibrary.mdx deleted file mode 100644 index 6c5cbdb..0000000 --- a/references/1.3.0/common/common/BaseComponentSystemLibrary.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "BaseComponentSystemLibrary class" -icon: "box" -description: "BaseComponentSystemLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseComponentSystemLibrary -## Signature - -```typescript -declare abstract class BaseComponentSystemLibrary extends Library implements IComponentSystemLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -### __run -**Modifiers**: abstract - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseComponentSystemLibrary/__run.mdx b/references/1.3.0/common/common/BaseComponentSystemLibrary/__run.mdx deleted file mode 100644 index b0ae323..0000000 --- a/references/1.3.0/common/common/BaseComponentSystemLibrary/__run.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__run" -icon: "function" -description: "__run API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __run -## Signature - -```typescript -abstract __run(context: Context): Promise; -``` - -## Parameters - -### context -**Type**:`Context` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseGraphicsLibrary.mdx b/references/1.3.0/common/common/BaseGraphicsLibrary.mdx deleted file mode 100644 index 62f7c27..0000000 --- a/references/1.3.0/common/common/BaseGraphicsLibrary.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "BaseGraphicsLibrary class" -icon: "box" -description: "BaseGraphicsLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseGraphicsLibrary -## Signature - -```typescript -declare abstract class BaseGraphicsLibrary extends Library implements IGraphicsLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -### __run -**Modifiers**: abstract - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseGraphicsLibrary/__run.mdx b/references/1.3.0/common/common/BaseGraphicsLibrary/__run.mdx deleted file mode 100644 index b0ae323..0000000 --- a/references/1.3.0/common/common/BaseGraphicsLibrary/__run.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__run" -icon: "function" -description: "__run API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __run -## Signature - -```typescript -abstract __run(context: Context): Promise; -``` - -## Parameters - -### context -**Type**:`Context` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseInputLibrary.mdx b/references/1.3.0/common/common/BaseInputLibrary.mdx deleted file mode 100644 index c677e46..0000000 --- a/references/1.3.0/common/common/BaseInputLibrary.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "BaseInputLibrary class" -icon: "box" -description: "BaseInputLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseInputLibrary -## Signature - -```typescript -declare abstract class BaseInputLibrary extends Library implements IInputLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -### __run -**Modifiers**: abstract - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseInputLibrary/__run.mdx b/references/1.3.0/common/common/BaseInputLibrary/__run.mdx deleted file mode 100644 index fab6d2e..0000000 --- a/references/1.3.0/common/common/BaseInputLibrary/__run.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__run" -icon: "function" -description: "__run API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __run -## Signature - -```typescript -abstract __run(_context: Context): Promise; -``` - -## Parameters - -### _context -**Type**:`Context` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseMusicLibrary.mdx b/references/1.3.0/common/common/BaseMusicLibrary.mdx deleted file mode 100644 index a55c0ab..0000000 --- a/references/1.3.0/common/common/BaseMusicLibrary.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "BaseMusicLibrary class" -icon: "box" -description: "BaseMusicLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseMusicLibrary -## Signature - -```typescript -declare abstract class BaseMusicLibrary extends Library implements IMusicLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -### __init -**Modifiers**: abstract - - - -### mute -**Modifiers**: abstract - -mutes or unmutes the sound. - -### play -**Modifiers**: abstract - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseMusicLibrary/__init.mdx b/references/1.3.0/common/common/BaseMusicLibrary/__init.mdx deleted file mode 100644 index 83b190a..0000000 --- a/references/1.3.0/common/common/BaseMusicLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -abstract __init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseMusicLibrary/mute.mdx b/references/1.3.0/common/common/BaseMusicLibrary/mute.mdx deleted file mode 100644 index 1d0f5b6..0000000 --- a/references/1.3.0/common/common/BaseMusicLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "mutes or unmutes the sound." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -mutes or unmutes the sound. -## Signature - -```typescript -abstract mute(): void; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`void` - -mutes or unmutes the sound. \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseMusicLibrary/play.mdx b/references/1.3.0/common/common/BaseMusicLibrary/play.mdx deleted file mode 100644 index 99f0fab..0000000 --- a/references/1.3.0/common/common/BaseMusicLibrary/play.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "play" -icon: "function" -description: "play API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play -## Signature - -```typescript -abstract play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseNetworkLibrary.mdx b/references/1.3.0/common/common/BaseNetworkLibrary.mdx deleted file mode 100644 index aae9a60..0000000 --- a/references/1.3.0/common/common/BaseNetworkLibrary.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "BaseNetworkLibrary class" -icon: "box" -description: "BaseNetworkLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseNetworkLibrary -## Signature - -```typescript -declare abstract class BaseNetworkLibrary extends Library implements INetworkLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseSoundLibrary.mdx b/references/1.3.0/common/common/BaseSoundLibrary.mdx deleted file mode 100644 index 5c1821c..0000000 --- a/references/1.3.0/common/common/BaseSoundLibrary.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "BaseSoundLibrary class" -icon: "box" -description: "BaseSoundLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseSoundLibrary -## Signature - -```typescript -declare abstract class BaseSoundLibrary extends Library implements ISoundLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -### __init -**Modifiers**: abstract - - - -### mute -**Modifiers**: abstract - -mutes or unmutes the sound. - -### play -**Modifiers**: abstract - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseSoundLibrary/__init.mdx b/references/1.3.0/common/common/BaseSoundLibrary/__init.mdx deleted file mode 100644 index 83b190a..0000000 --- a/references/1.3.0/common/common/BaseSoundLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -abstract __init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseSoundLibrary/mute.mdx b/references/1.3.0/common/common/BaseSoundLibrary/mute.mdx deleted file mode 100644 index 1d0f5b6..0000000 --- a/references/1.3.0/common/common/BaseSoundLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "mutes or unmutes the sound." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -mutes or unmutes the sound. -## Signature - -```typescript -abstract mute(): void; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`void` - -mutes or unmutes the sound. \ No newline at end of file diff --git a/references/1.3.0/common/common/BaseSoundLibrary/play.mdx b/references/1.3.0/common/common/BaseSoundLibrary/play.mdx deleted file mode 100644 index 99f0fab..0000000 --- a/references/1.3.0/common/common/BaseSoundLibrary/play.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "play" -icon: "function" -description: "play API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play -## Signature - -```typescript -abstract play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/common/common/COMPONENT_SYSTEM_LIBRARY.mdx b/references/1.3.0/common/common/COMPONENT_SYSTEM_LIBRARY.mdx deleted file mode 100644 index b0dc2bc..0000000 --- a/references/1.3.0/common/common/COMPONENT_SYSTEM_LIBRARY.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "COMPONENT_SYSTEM_LIBRARY variable" -icon: "variable" -description: "COMPONENT_SYSTEM_LIBRARY API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# COMPONENT_SYSTEM_LIBRARY - - -## Signature - -```typescript -COMPONENT_SYSTEM_LIBRARY: unique symbol -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ClearContext.mdx b/references/1.3.0/common/common/ClearContext.mdx deleted file mode 100644 index e5c94e9..0000000 --- a/references/1.3.0/common/common/ClearContext.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "ClearContext class" -icon: "box" -description: "ClearContext API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ClearContext -## Signature - -```typescript -declare class ClearContext extends BaseContext -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager.mdx b/references/1.3.0/common/common/ClientLibraryManager.mdx deleted file mode 100644 index de62fc7..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "ClientLibraryManager class" -icon: "box" -description: "ClientLibraryManager API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ClientLibraryManager -## Signature - -```typescript -declare class ClientLibraryManager -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -*No properties defined.* - -## Methods - -### get - - - -### getAssetManager - - - -### getComponentSystem - - - -### getGraphics - - - -### getInput - - - -### getMusic - - - -### getNetwork - - - -### getSound - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/constructor.mdx b/references/1.3.0/common/common/ClientLibraryManager/constructor.mdx deleted file mode 100644 index 6be22bf..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/constructor.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ClientLibraryManager class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ClientLibraryManager` class -## Signature - -```typescript -constructor(libraryManager: LibraryManager); -``` - -## Parameters - -### libraryManager -- **Type**:`LibraryManager` \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/get.mdx b/references/1.3.0/common/common/ClientLibraryManager/get.mdx deleted file mode 100644 index c0c705d..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/get.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "get" -icon: "function" -description: "get API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# get -## Signature - -```typescript -get(sym: symbol): T; -``` - -## Parameters - -### sym -**Type**:`symbol` - - - -## Returns - -**Type**:`T` \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/getAssetManager.mdx b/references/1.3.0/common/common/ClientLibraryManager/getAssetManager.mdx deleted file mode 100644 index edc0d57..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/getAssetManager.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getAssetManager" -icon: "function" -description: "getAssetManager API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAssetManager -## Signature - -```typescript -getAssetManager(): T; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`T` \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/getComponentSystem.mdx b/references/1.3.0/common/common/ClientLibraryManager/getComponentSystem.mdx deleted file mode 100644 index adf4017..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/getComponentSystem.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getComponentSystem" -icon: "function" -description: "getComponentSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentSystem -## Signature - -```typescript -getComponentSystem(): T; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`T` \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/getGraphics.mdx b/references/1.3.0/common/common/ClientLibraryManager/getGraphics.mdx deleted file mode 100644 index bf6633b..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/getGraphics.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getGraphics" -icon: "function" -description: "getGraphics API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getGraphics -## Signature - -```typescript -getGraphics(): T; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`T` \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/getInput.mdx b/references/1.3.0/common/common/ClientLibraryManager/getInput.mdx deleted file mode 100644 index f535c62..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/getInput.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getInput" -icon: "function" -description: "getInput API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getInput -## Signature - -```typescript -getInput(): T; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`T` \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/getMusic.mdx b/references/1.3.0/common/common/ClientLibraryManager/getMusic.mdx deleted file mode 100644 index 572942d..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/getMusic.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getMusic" -icon: "function" -description: "getMusic API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMusic -## Signature - -```typescript -getMusic(): T; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`T` \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/getNetwork.mdx b/references/1.3.0/common/common/ClientLibraryManager/getNetwork.mdx deleted file mode 100644 index 7a568c2..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/getNetwork.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getNetwork" -icon: "function" -description: "getNetwork API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getNetwork -## Signature - -```typescript -getNetwork(): T; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`T` \ No newline at end of file diff --git a/references/1.3.0/common/common/ClientLibraryManager/getSound.mdx b/references/1.3.0/common/common/ClientLibraryManager/getSound.mdx deleted file mode 100644 index 74e05e8..0000000 --- a/references/1.3.0/common/common/ClientLibraryManager/getSound.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getSound" -icon: "function" -description: "getSound API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getSound -## Signature - -```typescript -getSound(): T; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`T` \ No newline at end of file diff --git a/references/1.3.0/common/common/Context.mdx b/references/1.3.0/common/common/Context.mdx deleted file mode 100644 index 77f4917..0000000 --- a/references/1.3.0/common/common/Context.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Context class" -icon: "box" -description: "Context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Context -## Signature - -```typescript -declare class Context -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### app -**Modifiers**: readonly -**Type**:`get app(): ApplicationContext;` -**Default**: `` - - - -### libs -**Modifiers**: readonly -**Type**:`get libs(): ClientLibraryManager;` -**Default**: `` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/Context/app.mdx b/references/1.3.0/common/common/Context/app.mdx deleted file mode 100644 index f219cdf..0000000 --- a/references/1.3.0/common/common/Context/app.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "app" -icon: "variable" -description: "app API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# app - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/Context/constructor.mdx b/references/1.3.0/common/common/Context/constructor.mdx deleted file mode 100644 index 5688f33..0000000 --- a/references/1.3.0/common/common/Context/constructor.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the Context class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `Context` class -## Signature - -```typescript -constructor(applicationContext: ApplicationContext, libraryManager: ClientLibraryManager); -``` - -## Parameters - -### applicationContext -- **Type**:`ApplicationContext` - - - -### libraryManager -- **Type**:`ClientLibraryManager` \ No newline at end of file diff --git a/references/1.3.0/common/common/Context/libs.mdx b/references/1.3.0/common/common/Context/libs.mdx deleted file mode 100644 index ea51fb0..0000000 --- a/references/1.3.0/common/common/Context/libs.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "libs" -icon: "variable" -description: "libs API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# libs - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/DefaultLibrariesEnum.mdx b/references/1.3.0/common/common/DefaultLibrariesEnum.mdx deleted file mode 100644 index 3822f46..0000000 --- a/references/1.3.0/common/common/DefaultLibrariesEnum.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "DefaultLibrariesEnum enum" -icon: "list" -description: "DefaultLibrariesEnum API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# DefaultLibrariesEnum -## Members - -| Member | Description | -| ------ | ----------- | -| `ASSET_MANAGER` | | -| `COMPONENT_SYSTEM` | | -| `GRAPHICS` | | -| `INPUT` | | -| `MUSIC` | | -| `NETWORK` | | -| `SOUND` | | \ No newline at end of file diff --git a/references/1.3.0/common/common/ExecutionContext.mdx b/references/1.3.0/common/common/ExecutionContext.mdx deleted file mode 100644 index 19d6391..0000000 --- a/references/1.3.0/common/common/ExecutionContext.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "ExecutionContext class" -icon: "box" -description: "ExecutionContext API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ExecutionContext -## Signature - -```typescript -declare class ExecutionContext extends BaseContext -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/GRAPHICS_LIBRARY.mdx b/references/1.3.0/common/common/GRAPHICS_LIBRARY.mdx deleted file mode 100644 index 60941d1..0000000 --- a/references/1.3.0/common/common/GRAPHICS_LIBRARY.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "GRAPHICS_LIBRARY variable" -icon: "variable" -description: "GRAPHICS_LIBRARY API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# GRAPHICS_LIBRARY - - -## Signature - -```typescript -GRAPHICS_LIBRARY: unique symbol -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IAssetManagerLibrary.mdx b/references/1.3.0/common/common/IAssetManagerLibrary.mdx deleted file mode 100644 index 1c12834..0000000 --- a/references/1.3.0/common/common/IAssetManagerLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IAssetManagerLibrary interface" -icon: "plug" -description: "IAssetManagerLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IAssetManagerLibrary -## Signature - -```typescript -interface IAssetManagerLibrary extends IExposedLibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IAssetManagerLibrary/getAsset.mdx b/references/1.3.0/common/common/IAssetManagerLibrary/getAsset.mdx deleted file mode 100644 index 9698eef..0000000 --- a/references/1.3.0/common/common/IAssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getAsset" -icon: "file" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/IComponentSystemLibrary.mdx b/references/1.3.0/common/common/IComponentSystemLibrary.mdx deleted file mode 100644 index 2f7fef4..0000000 --- a/references/1.3.0/common/common/IComponentSystemLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IComponentSystemLibrary interface" -icon: "plug" -description: "IComponentSystemLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IComponentSystemLibrary -## Signature - -```typescript -interface IComponentSystemLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IConfigRegistry.mdx b/references/1.3.0/common/common/IConfigRegistry.mdx deleted file mode 100644 index 5574519..0000000 --- a/references/1.3.0/common/common/IConfigRegistry.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IConfigRegistry interface" -icon: "plug" -description: "IConfigRegistry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IConfigRegistry -## Signature - -```typescript -interface IConfigRegistry -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IConfigRegistry/registerConfig.mdx b/references/1.3.0/common/common/IConfigRegistry/registerConfig.mdx deleted file mode 100644 index 9a4f2af..0000000 --- a/references/1.3.0/common/common/IConfigRegistry/registerConfig.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "registerConfig" -icon: "file" -description: "registerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registerConfig - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/IExposedLibrary.mdx b/references/1.3.0/common/common/IExposedLibrary.mdx deleted file mode 100644 index 748e25c..0000000 --- a/references/1.3.0/common/common/IExposedLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IExposedLibrary interface" -icon: "plug" -description: "IExposedLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IExposedLibrary -## Signature - -```typescript -interface IExposedLibrary extends ILibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IGraphicsLibrary.mdx b/references/1.3.0/common/common/IGraphicsLibrary.mdx deleted file mode 100644 index 2da9e4a..0000000 --- a/references/1.3.0/common/common/IGraphicsLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IGraphicsLibrary interface" -icon: "plug" -description: "IGraphicsLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IGraphicsLibrary -## Signature - -```typescript -interface IGraphicsLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IInputLibrary.mdx b/references/1.3.0/common/common/IInputLibrary.mdx deleted file mode 100644 index a6edbdf..0000000 --- a/references/1.3.0/common/common/IInputLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IInputLibrary interface" -icon: "plug" -description: "IInputLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IInputLibrary -## Signature - -```typescript -interface IInputLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ILibrary.mdx b/references/1.3.0/common/common/ILibrary.mdx deleted file mode 100644 index 073b62f..0000000 --- a/references/1.3.0/common/common/ILibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "ILibrary interface" -icon: "plug" -description: "ILibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ILibrary -## Signature - -```typescript -interface ILibrary -``` - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` - - - -### __relationship -**Modifiers**: readonly -**Type**:`get __relationship(): RelationshipHandler;` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ILibrary/__clear.mdx b/references/1.3.0/common/common/ILibrary/__clear.mdx deleted file mode 100644 index b54ccbe..0000000 --- a/references/1.3.0/common/common/ILibrary/__clear.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__clear" -icon: "file" -description: "__clear API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __clear - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/ILibrary/__init.mdx b/references/1.3.0/common/common/ILibrary/__init.mdx deleted file mode 100644 index ba9d68a..0000000 --- a/references/1.3.0/common/common/ILibrary/__init.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__init" -icon: "file" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/ILibrary/__name.mdx b/references/1.3.0/common/common/ILibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/common/common/ILibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/ILibrary/__relationship.mdx b/references/1.3.0/common/common/ILibrary/__relationship.mdx deleted file mode 100644 index 55c8a6b..0000000 --- a/references/1.3.0/common/common/ILibrary/__relationship.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__relationship" -icon: "variable" -description: "__relationship API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __relationship - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IMusicLibrary.mdx b/references/1.3.0/common/common/IMusicLibrary.mdx deleted file mode 100644 index 569ca8f..0000000 --- a/references/1.3.0/common/common/IMusicLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IMusicLibrary interface" -icon: "plug" -description: "IMusicLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IMusicLibrary -## Signature - -```typescript -interface IMusicLibrary extends IExposedLibrary, IMutableLibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IMutableLibrary.mdx b/references/1.3.0/common/common/IMutableLibrary.mdx deleted file mode 100644 index 7b534cc..0000000 --- a/references/1.3.0/common/common/IMutableLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IMutableLibrary interface" -icon: "plug" -description: "IMutableLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IMutableLibrary -## Signature - -```typescript -interface IMutableLibrary extends ILibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IMutableLibrary/mute.mdx b/references/1.3.0/common/common/IMutableLibrary/mute.mdx deleted file mode 100644 index 0853a22..0000000 --- a/references/1.3.0/common/common/IMutableLibrary/mute.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "mute" -icon: "file" -description: "mutes or unmutes the sound." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -mutes or unmutes the sound. - -## Description - -mutes or unmutes the sound. \ No newline at end of file diff --git a/references/1.3.0/common/common/INPUT_LIBRARY.mdx b/references/1.3.0/common/common/INPUT_LIBRARY.mdx deleted file mode 100644 index d01572b..0000000 --- a/references/1.3.0/common/common/INPUT_LIBRARY.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "INPUT_LIBRARY variable" -icon: "variable" -description: "INPUT_LIBRARY API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# INPUT_LIBRARY - - -## Signature - -```typescript -INPUT_LIBRARY: unique symbol -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/common/common/INetworkLibrary.mdx b/references/1.3.0/common/common/INetworkLibrary.mdx deleted file mode 100644 index d4aae7d..0000000 --- a/references/1.3.0/common/common/INetworkLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "INetworkLibrary interface" -icon: "plug" -description: "INetworkLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# INetworkLibrary -## Signature - -```typescript -interface INetworkLibrary extends IExposedLibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunClientOptions.mdx b/references/1.3.0/common/common/IRunClientOptions.mdx deleted file mode 100644 index b8857ca..0000000 --- a/references/1.3.0/common/common/IRunClientOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IRunClientOptions interface" -icon: "plug" -description: "IRunClientOptions API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunClientOptions -## Signature - -```typescript -interface IRunClientOptions -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunClientOptions/container.mdx b/references/1.3.0/common/common/IRunClientOptions/container.mdx deleted file mode 100644 index c6e9d7a..0000000 --- a/references/1.3.0/common/common/IRunClientOptions/container.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "container" -icon: "file" -description: "container API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# container - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunClientOptions/env.mdx b/references/1.3.0/common/common/IRunClientOptions/env.mdx deleted file mode 100644 index 5a25b5f..0000000 --- a/references/1.3.0/common/common/IRunClientOptions/env.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "env" -icon: "file" -description: "env API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunClientOptions/files.mdx b/references/1.3.0/common/common/IRunClientOptions/files.mdx deleted file mode 100644 index dfa0f6b..0000000 --- a/references/1.3.0/common/common/IRunClientOptions/files.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "files" -icon: "file" -description: "files API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunOptions.mdx b/references/1.3.0/common/common/IRunOptions.mdx deleted file mode 100644 index 0e7ef42..0000000 --- a/references/1.3.0/common/common/IRunOptions.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "IRunOptions type" -icon: "file-code" -description: "IRunOptions API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunOptions - - -## Signature - -```typescript -type IRunOptions = IRunClientOptions | IRunServerOptions; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunServerOptions.mdx b/references/1.3.0/common/common/IRunServerOptions.mdx deleted file mode 100644 index 66df27a..0000000 --- a/references/1.3.0/common/common/IRunServerOptions.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IRunServerOptions interface" -icon: "plug" -description: "IRunServerOptions API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunServerOptions -## Signature - -```typescript -interface IRunServerOptions -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunServerOptions/env.mdx b/references/1.3.0/common/common/IRunServerOptions/env.mdx deleted file mode 100644 index 5a25b5f..0000000 --- a/references/1.3.0/common/common/IRunServerOptions/env.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "env" -icon: "file" -description: "env API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunServerOptions/files.mdx b/references/1.3.0/common/common/IRunServerOptions/files.mdx deleted file mode 100644 index dfa0f6b..0000000 --- a/references/1.3.0/common/common/IRunServerOptions/files.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "files" -icon: "file" -description: "files API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunnerLibrary.mdx b/references/1.3.0/common/common/IRunnerLibrary.mdx deleted file mode 100644 index 4bd0d3c..0000000 --- a/references/1.3.0/common/common/IRunnerLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "IRunnerLibrary interface" -icon: "plug" -description: "IRunnerLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunnerLibrary -## Signature - -```typescript -interface IRunnerLibrary extends ILibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/IRunnerLibrary/__run.mdx b/references/1.3.0/common/common/IRunnerLibrary/__run.mdx deleted file mode 100644 index 7dae3c0..0000000 --- a/references/1.3.0/common/common/IRunnerLibrary/__run.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__run" -icon: "file" -description: "__run API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __run - -## Description \ No newline at end of file diff --git a/references/1.3.0/common/common/ISoundLibrary.mdx b/references/1.3.0/common/common/ISoundLibrary.mdx deleted file mode 100644 index 6a8c5d0..0000000 --- a/references/1.3.0/common/common/ISoundLibrary.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "ISoundLibrary interface" -icon: "plug" -description: "ISoundLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ISoundLibrary -## Signature - -```typescript -interface ISoundLibrary extends IExposedLibrary, IMutableLibrary -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/InitContext.mdx b/references/1.3.0/common/common/InitContext.mdx deleted file mode 100644 index 174e892..0000000 --- a/references/1.3.0/common/common/InitContext.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "InitContext class" -icon: "box" -description: "InitContext API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InitContext -## Signature - -```typescript -declare class InitContext extends BaseContext -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### config -**Modifiers**: readonly -**Type**:`get config(): IConfigRegistry;` -**Default**: `` - - - -### container -**Modifiers**: readonly -**Type**:`get container(): IRunClientOptions["container"] | undefined;` -**Default**: `` - - - -### env -**Modifiers**: readonly -**Type**:`get env(): Record;` -**Default**: `` - - - -### files -**Modifiers**: readonly -**Type**:`get files(): IRunOptions["files"];` -**Default**: `` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/InitContext/config.mdx b/references/1.3.0/common/common/InitContext/config.mdx deleted file mode 100644 index d57235b..0000000 --- a/references/1.3.0/common/common/InitContext/config.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "config" -icon: "variable" -description: "config API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# config - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/InitContext/constructor.mdx b/references/1.3.0/common/common/InitContext/constructor.mdx deleted file mode 100644 index 6eb2942..0000000 --- a/references/1.3.0/common/common/InitContext/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the InitContext class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `InitContext` class -## Signature - -```typescript -constructor(context: ApplicationContext, libraryManager: LibraryManager, configRegistry: IConfigRegistry, options: IRunOptions); -``` - -## Parameters - -### context -- **Type**:`ApplicationContext` - - - -### libraryManager -- **Type**:`LibraryManager` - - - -### configRegistry -- **Type**:`IConfigRegistry` - - - -### options -- **Type**:`IRunOptions` \ No newline at end of file diff --git a/references/1.3.0/common/common/InitContext/container.mdx b/references/1.3.0/common/common/InitContext/container.mdx deleted file mode 100644 index 9be783f..0000000 --- a/references/1.3.0/common/common/InitContext/container.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "container" -icon: "variable" -description: "container API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# container - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/InitContext/env.mdx b/references/1.3.0/common/common/InitContext/env.mdx deleted file mode 100644 index 868d1be..0000000 --- a/references/1.3.0/common/common/InitContext/env.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "env" -icon: "variable" -description: "env API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/InitContext/files.mdx b/references/1.3.0/common/common/InitContext/files.mdx deleted file mode 100644 index 9e82e95..0000000 --- a/references/1.3.0/common/common/InitContext/files.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "files" -icon: "variable" -description: "files API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryContext.mdx b/references/1.3.0/common/common/LibraryContext.mdx deleted file mode 100644 index ca8be0f..0000000 --- a/references/1.3.0/common/common/LibraryContext.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "LibraryContext class" -icon: "box" -description: "LibraryContext API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryContext -## Signature - -```typescript -declare class LibraryContext -``` - -## Constructors - -*No constructors defined.* - -## Properties - -### _status -**Modifiers**: protected -**Type**:`protected _status: LibraryStatusEnum;` -**Default**: `` - - - -### status -**Modifiers**: readonly -**Type**:`get status(): LibraryStatusEnum;` -**Default**: `` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryContext/_status.mdx b/references/1.3.0/common/common/LibraryContext/_status.mdx deleted file mode 100644 index 11349d9..0000000 --- a/references/1.3.0/common/common/LibraryContext/_status.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "_status" -icon: "variable" -description: "_status API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _status - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryContext/status.mdx b/references/1.3.0/common/common/LibraryContext/status.mdx deleted file mode 100644 index 25f1dde..0000000 --- a/references/1.3.0/common/common/LibraryContext/status.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "status" -icon: "variable" -description: "status API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# status - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryHandle.mdx b/references/1.3.0/common/common/LibraryHandle.mdx deleted file mode 100644 index 4823fc9..0000000 --- a/references/1.3.0/common/common/LibraryHandle.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: "LibraryHandle class" -icon: "box" -description: "LibraryHandle API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryHandle -## Signature - -```typescript -declare class LibraryHandle -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### context -**Modifiers**: readonly -**Type**:`get context(): LibraryContext;` -**Default**: `` - - - -### library -**Modifiers**: readonly -**Type**:`get library(): T;` -**Default**: `` - - - -### symbol -**Modifiers**: readonly -**Type**:`get symbol(): symbol;` -**Default**: `` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryHandle/constructor.mdx b/references/1.3.0/common/common/LibraryHandle/constructor.mdx deleted file mode 100644 index 5efd08e..0000000 --- a/references/1.3.0/common/common/LibraryHandle/constructor.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the LibraryHandle class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `LibraryHandle` class -## Signature - -```typescript -constructor(sym: symbol, library: T, defaultContext: LibraryContext); -``` - -## Parameters - -### sym -- **Type**:`symbol` - - - -### library -- **Type**:`T` - - - -### defaultContext -- **Type**:`LibraryContext` \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryHandle/context.mdx b/references/1.3.0/common/common/LibraryHandle/context.mdx deleted file mode 100644 index 2ae001f..0000000 --- a/references/1.3.0/common/common/LibraryHandle/context.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "context" -icon: "variable" -description: "context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# context - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryHandle/library.mdx b/references/1.3.0/common/common/LibraryHandle/library.mdx deleted file mode 100644 index 2939aff..0000000 --- a/references/1.3.0/common/common/LibraryHandle/library.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "library" -icon: "variable" -description: "library API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# library - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryHandle/symbol.mdx b/references/1.3.0/common/common/LibraryHandle/symbol.mdx deleted file mode 100644 index f2417e7..0000000 --- a/references/1.3.0/common/common/LibraryHandle/symbol.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "symbol" -icon: "variable" -description: "symbol API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# symbol - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager.mdx b/references/1.3.0/common/common/LibraryManager.mdx deleted file mode 100644 index 2062e1d..0000000 --- a/references/1.3.0/common/common/LibraryManager.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "LibraryManager class" -icon: "box" -description: "LibraryManager API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryManager -## Signature - -```typescript -declare class LibraryManager extends BaseLibraryManager -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -*No properties defined.* - -## Methods - -### getAssetManager - - - -### getComponentSystem - - - -### getGraphics - - - -### getInput - - - -### getMusic - - - -### getNetwork - - - -### getSound - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager/constructor.mdx b/references/1.3.0/common/common/LibraryManager/constructor.mdx deleted file mode 100644 index 62e6062..0000000 --- a/references/1.3.0/common/common/LibraryManager/constructor.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the LibraryManager class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `LibraryManager` class -## Signature - -```typescript -constructor(); -``` - -*This constructor takes no parameters.* \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager/getAssetManager.mdx b/references/1.3.0/common/common/LibraryManager/getAssetManager.mdx deleted file mode 100644 index 6c092ee..0000000 --- a/references/1.3.0/common/common/LibraryManager/getAssetManager.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getAssetManager" -icon: "function" -description: "getAssetManager API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAssetManager -## Signature - -```typescript -getAssetManager(): LibraryHandle; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`LibraryHandle` \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager/getComponentSystem.mdx b/references/1.3.0/common/common/LibraryManager/getComponentSystem.mdx deleted file mode 100644 index 450f3e5..0000000 --- a/references/1.3.0/common/common/LibraryManager/getComponentSystem.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getComponentSystem" -icon: "function" -description: "getComponentSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentSystem -## Signature - -```typescript -getComponentSystem(): LibraryHandle; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`LibraryHandle` \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager/getGraphics.mdx b/references/1.3.0/common/common/LibraryManager/getGraphics.mdx deleted file mode 100644 index ee48e90..0000000 --- a/references/1.3.0/common/common/LibraryManager/getGraphics.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getGraphics" -icon: "function" -description: "getGraphics API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getGraphics -## Signature - -```typescript -getGraphics(): LibraryHandle; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`LibraryHandle` \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager/getInput.mdx b/references/1.3.0/common/common/LibraryManager/getInput.mdx deleted file mode 100644 index 40ee710..0000000 --- a/references/1.3.0/common/common/LibraryManager/getInput.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getInput" -icon: "function" -description: "getInput API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getInput -## Signature - -```typescript -getInput(): LibraryHandle; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`LibraryHandle` \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager/getMusic.mdx b/references/1.3.0/common/common/LibraryManager/getMusic.mdx deleted file mode 100644 index c3601ce..0000000 --- a/references/1.3.0/common/common/LibraryManager/getMusic.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getMusic" -icon: "function" -description: "getMusic API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMusic -## Signature - -```typescript -getMusic(): LibraryHandle; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`LibraryHandle` \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager/getNetwork.mdx b/references/1.3.0/common/common/LibraryManager/getNetwork.mdx deleted file mode 100644 index a22865a..0000000 --- a/references/1.3.0/common/common/LibraryManager/getNetwork.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getNetwork" -icon: "function" -description: "getNetwork API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getNetwork -## Signature - -```typescript -getNetwork(): LibraryHandle; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`LibraryHandle` \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryManager/getSound.mdx b/references/1.3.0/common/common/LibraryManager/getSound.mdx deleted file mode 100644 index e860474..0000000 --- a/references/1.3.0/common/common/LibraryManager/getSound.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getSound" -icon: "function" -description: "getSound API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getSound -## Signature - -```typescript -getSound(): LibraryHandle; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`LibraryHandle` \ No newline at end of file diff --git a/references/1.3.0/common/common/LibraryStatusEnum.mdx b/references/1.3.0/common/common/LibraryStatusEnum.mdx deleted file mode 100644 index 071c2bf..0000000 --- a/references/1.3.0/common/common/LibraryStatusEnum.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: "LibraryStatusEnum enum" -icon: "list" -description: "LibraryStatusEnum API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryStatusEnum -## Members - -| Member | Description | -| ------ | ----------- | -| `CLEAR` | | -| `LOADED` | | -| `UNLOADED` | | \ No newline at end of file diff --git a/references/1.3.0/common/common/MUSIC_LIBRARY.mdx b/references/1.3.0/common/common/MUSIC_LIBRARY.mdx deleted file mode 100644 index f86fcff..0000000 --- a/references/1.3.0/common/common/MUSIC_LIBRARY.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "MUSIC_LIBRARY variable" -icon: "variable" -description: "MUSIC_LIBRARY API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# MUSIC_LIBRARY - - -## Signature - -```typescript -MUSIC_LIBRARY: unique symbol -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NETWORK_LIBRARY.mdx b/references/1.3.0/common/common/NETWORK_LIBRARY.mdx deleted file mode 100644 index b31a463..0000000 --- a/references/1.3.0/common/common/NETWORK_LIBRARY.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "NETWORK_LIBRARY variable" -icon: "variable" -description: "NETWORK_LIBRARY API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NETWORK_LIBRARY - - -## Signature - -```typescript -NETWORK_LIBRARY: unique symbol -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfConfigException.mdx b/references/1.3.0/common/common/NfConfigException.mdx deleted file mode 100644 index 37de199..0000000 --- a/references/1.3.0/common/common/NfConfigException.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "NfConfigException class" -icon: "box" -description: "NfConfigException API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfConfigException -## Signature - -```typescript -declare class NfConfigException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` -**Default**: `` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfConfigException/code.mdx b/references/1.3.0/common/common/NfConfigException/code.mdx deleted file mode 100644 index ddf79c6..0000000 --- a/references/1.3.0/common/common/NfConfigException/code.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "code API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfConfigException/constructor.mdx b/references/1.3.0/common/common/NfConfigException/constructor.mdx deleted file mode 100644 index dbb5dc4..0000000 --- a/references/1.3.0/common/common/NfConfigException/constructor.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfConfigException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfConfigException` class -## Signature - -```typescript -constructor(message: string, library?: string); -``` - -## Parameters - -### message -- **Type**:`string` - - - -### library -- **Type**:`string` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFetchException.mdx b/references/1.3.0/common/common/NfFetchException.mdx deleted file mode 100644 index dbdace4..0000000 --- a/references/1.3.0/common/common/NfFetchException.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "NfFetchException class" -icon: "box" -description: "NfFetchException API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfFetchException -## Signature - -```typescript -declare class NfFetchException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` -**Default**: `` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFetchException/code.mdx b/references/1.3.0/common/common/NfFetchException/code.mdx deleted file mode 100644 index ddf79c6..0000000 --- a/references/1.3.0/common/common/NfFetchException/code.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "code API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFetchException/constructor.mdx b/references/1.3.0/common/common/NfFetchException/constructor.mdx deleted file mode 100644 index c743b99..0000000 --- a/references/1.3.0/common/common/NfFetchException/constructor.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfFetchException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfFetchException` class -## Signature - -```typescript -constructor(code: number, text: string); -``` - -## Parameters - -### code -- **Type**:`number` - - - -### text -- **Type**:`string` \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile.mdx b/references/1.3.0/common/common/NfFile.mdx deleted file mode 100644 index 201e682..0000000 --- a/references/1.3.0/common/common/NfFile.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "NfFile class" -icon: "box" -description: "NfFile API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfFile -## Signature - -```typescript -declare class NfFile -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### path -**Modifiers**: readonly -**Type**:`get path(): string;` -**Default**: `` - - - -## Methods - -### arrayBuffer - - - -### blob - - - -### bytes - - - -### formData - - - -### json - - - -### text - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile/arrayBuffer.mdx b/references/1.3.0/common/common/NfFile/arrayBuffer.mdx deleted file mode 100644 index b77d11e..0000000 --- a/references/1.3.0/common/common/NfFile/arrayBuffer.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "arrayBuffer" -icon: "function" -description: "arrayBuffer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# arrayBuffer -## Signature - -```typescript -arrayBuffer(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile/blob.mdx b/references/1.3.0/common/common/NfFile/blob.mdx deleted file mode 100644 index b25f42e..0000000 --- a/references/1.3.0/common/common/NfFile/blob.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "blob" -icon: "function" -description: "blob API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# blob -## Signature - -```typescript -blob(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile/bytes.mdx b/references/1.3.0/common/common/NfFile/bytes.mdx deleted file mode 100644 index d805e8f..0000000 --- a/references/1.3.0/common/common/NfFile/bytes.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "bytes" -icon: "function" -description: "bytes API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# bytes -## Signature - -```typescript -bytes(): Promise>; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise>` \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile/constructor.mdx b/references/1.3.0/common/common/NfFile/constructor.mdx deleted file mode 100644 index dabdbc6..0000000 --- a/references/1.3.0/common/common/NfFile/constructor.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfFile class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfFile` class -## Signature - -```typescript -constructor(path: string); -``` - -## Parameters - -### path -- **Type**:`string` \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile/formData.mdx b/references/1.3.0/common/common/NfFile/formData.mdx deleted file mode 100644 index e272197..0000000 --- a/references/1.3.0/common/common/NfFile/formData.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "formData" -icon: "function" -description: "formData API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# formData -## Signature - -```typescript -formData(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile/json.mdx b/references/1.3.0/common/common/NfFile/json.mdx deleted file mode 100644 index d6dafc7..0000000 --- a/references/1.3.0/common/common/NfFile/json.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "json" -icon: "function" -description: "json API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# json -## Signature - -```typescript -json(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile/path.mdx b/references/1.3.0/common/common/NfFile/path.mdx deleted file mode 100644 index eb37172..0000000 --- a/references/1.3.0/common/common/NfFile/path.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "path" -icon: "variable" -description: "path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# path - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfFile/text.mdx b/references/1.3.0/common/common/NfFile/text.mdx deleted file mode 100644 index d583e59..0000000 --- a/references/1.3.0/common/common/NfFile/text.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "text" -icon: "function" -description: "text API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# text -## Signature - -```typescript -text(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/common/common/NfNotFound.mdx b/references/1.3.0/common/common/NfNotFound.mdx deleted file mode 100644 index cbf7844..0000000 --- a/references/1.3.0/common/common/NfNotFound.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "NfNotFound class" -icon: "box" -description: "NfNotFound API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfNotFound -## Signature - -```typescript -declare class NfNotFound extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` -**Default**: `` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfNotFound/code.mdx b/references/1.3.0/common/common/NfNotFound/code.mdx deleted file mode 100644 index ddf79c6..0000000 --- a/references/1.3.0/common/common/NfNotFound/code.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "code API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfNotFound/constructor.mdx b/references/1.3.0/common/common/NfNotFound/constructor.mdx deleted file mode 100644 index 1424ac9..0000000 --- a/references/1.3.0/common/common/NfNotFound/constructor.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfNotFound class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfNotFound` class -## Signature - -```typescript -constructor(item: string, type?: string); -``` - -## Parameters - -### item -- **Type**:`string` - - - -### type -- **Type**:`string` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.3.0/common/common/NfNotInitializedException.mdx b/references/1.3.0/common/common/NfNotInitializedException.mdx deleted file mode 100644 index 599dbda..0000000 --- a/references/1.3.0/common/common/NfNotInitializedException.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "NfNotInitializedException class" -icon: "box" -description: "NfNotInitializedException API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfNotInitializedException -## Signature - -```typescript -declare class NfNotInitializedException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` -**Default**: `` - - - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfNotInitializedException/code.mdx b/references/1.3.0/common/common/NfNotInitializedException/code.mdx deleted file mode 100644 index ddf79c6..0000000 --- a/references/1.3.0/common/common/NfNotInitializedException/code.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "code API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/common/common/NfNotInitializedException/constructor.mdx b/references/1.3.0/common/common/NfNotInitializedException/constructor.mdx deleted file mode 100644 index b900e96..0000000 --- a/references/1.3.0/common/common/NfNotInitializedException/constructor.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfNotInitializedException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfNotInitializedException` class -## Signature - -```typescript -constructor(item: string, type?: string); -``` - -## Parameters - -### item -- **Type**:`string` - - - -### type -- **Type**:`string` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.3.0/common/common/SOUND_LIBRARY.mdx b/references/1.3.0/common/common/SOUND_LIBRARY.mdx deleted file mode 100644 index 65871ff..0000000 --- a/references/1.3.0/common/common/SOUND_LIBRARY.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "SOUND_LIBRARY variable" -icon: "variable" -description: "SOUND_LIBRARY API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SOUND_LIBRARY - - -## Signature - -```typescript -SOUND_LIBRARY: unique symbol -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/common/index.mdx b/references/1.3.0/common/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/common/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/config/config.mdx b/references/1.3.0/config/config.mdx deleted file mode 100644 index 2030082..0000000 --- a/references/1.3.0/config/config.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "config package" -icon: "package" -description: "@nanoforge-dev/config API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/config -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/config/config/Default.mdx b/references/1.3.0/config/config/Default.mdx deleted file mode 100644 index 378478b..0000000 --- a/references/1.3.0/config/config/Default.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Default function" -icon: "function" -description: "Default API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Default - - -## Signature - -```typescript -declare function Default(defaultValue: unknown): PropertyDecorator; -``` - - -## Parameters - - - -### defaultValue - - -**Type**: unknown - - - - - - - - - - - - - -## Returns - - - -**Type**: PropertyDecorator \ No newline at end of file diff --git a/references/1.3.0/config/config/IsIpOrFQDN.mdx b/references/1.3.0/config/config/IsIpOrFQDN.mdx deleted file mode 100644 index ec84580..0000000 --- a/references/1.3.0/config/config/IsIpOrFQDN.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "IsIpOrFQDN function" -icon: "function" -description: "IsIpOrFQDN API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IsIpOrFQDN - - -## Signature - -```typescript -IsIpOrFQDN: (validationOptions?: ValidationOptions) => (object: object, propertyName: string) => void -``` - - -## Parameters - - - -### validationOptions - - -**Type**: ValidationOptions - - - -**Optional**: Yes - - - - - - - - - - - -## Returns - - - -**Type**: (object: object, propertyName: string) => void \ No newline at end of file diff --git a/references/1.3.0/config/config/TransformToBoolean.mdx b/references/1.3.0/config/config/TransformToBoolean.mdx deleted file mode 100644 index 5da7354..0000000 --- a/references/1.3.0/config/config/TransformToBoolean.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "TransformToBoolean function" -icon: "function" -description: "TransformToBoolean API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TransformToBoolean - - -## Signature - -```typescript -TransformToBoolean: () => PropertyDecorator -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - - -**Type**: PropertyDecorator \ No newline at end of file diff --git a/references/1.3.0/config/index.mdx b/references/1.3.0/config/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/config/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/core-editor/core-editor.mdx b/references/1.3.0/core-editor/core-editor.mdx deleted file mode 100644 index 5d8e937..0000000 --- a/references/1.3.0/core-editor/core-editor.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "core-editor package" -icon: "package" -description: "@nanoforge-dev/core-editor API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/core-editor -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/core-editor/core-editor/NanoforgeClient.mdx b/references/1.3.0/core-editor/core-editor/NanoforgeClient.mdx deleted file mode 100644 index c768026..0000000 --- a/references/1.3.0/core-editor/core-editor/NanoforgeClient.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "NanoforgeClient class" -icon: "box" -description: "NanoforgeClient API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeClient -## Signature - -```typescript -declare class NanoforgeClient extends NanoforgeApplication -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -### useGraphics - - - -### useInput - - - -### useSound - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/core-editor/core-editor/NanoforgeClient/useGraphics.mdx b/references/1.3.0/core-editor/core-editor/NanoforgeClient/useGraphics.mdx deleted file mode 100644 index 0ad17e5..0000000 --- a/references/1.3.0/core-editor/core-editor/NanoforgeClient/useGraphics.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "useGraphics" -icon: "function" -description: "useGraphics API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useGraphics -## Signature - -```typescript -useGraphics(library: IGraphicsLibrary): void; -``` - -## Parameters - -### library -**Type**:`IGraphicsLibrary` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/core-editor/core-editor/NanoforgeClient/useInput.mdx b/references/1.3.0/core-editor/core-editor/NanoforgeClient/useInput.mdx deleted file mode 100644 index 85b98a1..0000000 --- a/references/1.3.0/core-editor/core-editor/NanoforgeClient/useInput.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "useInput" -icon: "function" -description: "useInput API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useInput -## Signature - -```typescript -useInput(library: IInputLibrary): void; -``` - -## Parameters - -### library -**Type**:`IInputLibrary` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/core-editor/core-editor/NanoforgeClient/useSound.mdx b/references/1.3.0/core-editor/core-editor/NanoforgeClient/useSound.mdx deleted file mode 100644 index d6a6918..0000000 --- a/references/1.3.0/core-editor/core-editor/NanoforgeClient/useSound.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "useSound" -icon: "function" -description: "useSound API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useSound -## Signature - -```typescript -useSound(library: ISoundLibrary): void; -``` - -## Parameters - -### library -**Type**:`ISoundLibrary` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/core-editor/core-editor/NanoforgeFactory.mdx b/references/1.3.0/core-editor/core-editor/NanoforgeFactory.mdx deleted file mode 100644 index 8b45ccf..0000000 --- a/references/1.3.0/core-editor/core-editor/NanoforgeFactory.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "NanoforgeFactory variable" -icon: "variable" -description: "NanoforgeFactory API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeFactory - - -## Signature - -```typescript -NanoforgeFactory: NanoforgeFactoryStatic -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/core-editor/core-editor/NanoforgeServer.mdx b/references/1.3.0/core-editor/core-editor/NanoforgeServer.mdx deleted file mode 100644 index 516198a..0000000 --- a/references/1.3.0/core-editor/core-editor/NanoforgeServer.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeServer class" -icon: "box" -description: "NanoforgeServer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeServer -## Signature - -```typescript -declare class NanoforgeServer extends NanoforgeApplication -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/core-editor/index.mdx b/references/1.3.0/core-editor/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/core-editor/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/core/core.mdx b/references/1.3.0/core/core.mdx deleted file mode 100644 index 6583b72..0000000 --- a/references/1.3.0/core/core.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "core package" -icon: "package" -description: "@nanoforge-dev/core API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/core -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/core/core/NanoforgeClient.mdx b/references/1.3.0/core/core/NanoforgeClient.mdx deleted file mode 100644 index c768026..0000000 --- a/references/1.3.0/core/core/NanoforgeClient.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "NanoforgeClient class" -icon: "box" -description: "NanoforgeClient API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeClient -## Signature - -```typescript -declare class NanoforgeClient extends NanoforgeApplication -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -### useGraphics - - - -### useInput - - - -### useSound - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/core/core/NanoforgeClient/useGraphics.mdx b/references/1.3.0/core/core/NanoforgeClient/useGraphics.mdx deleted file mode 100644 index 0ad17e5..0000000 --- a/references/1.3.0/core/core/NanoforgeClient/useGraphics.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "useGraphics" -icon: "function" -description: "useGraphics API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useGraphics -## Signature - -```typescript -useGraphics(library: IGraphicsLibrary): void; -``` - -## Parameters - -### library -**Type**:`IGraphicsLibrary` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/core/core/NanoforgeClient/useInput.mdx b/references/1.3.0/core/core/NanoforgeClient/useInput.mdx deleted file mode 100644 index 85b98a1..0000000 --- a/references/1.3.0/core/core/NanoforgeClient/useInput.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "useInput" -icon: "function" -description: "useInput API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useInput -## Signature - -```typescript -useInput(library: IInputLibrary): void; -``` - -## Parameters - -### library -**Type**:`IInputLibrary` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/core/core/NanoforgeClient/useSound.mdx b/references/1.3.0/core/core/NanoforgeClient/useSound.mdx deleted file mode 100644 index d6a6918..0000000 --- a/references/1.3.0/core/core/NanoforgeClient/useSound.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "useSound" -icon: "function" -description: "useSound API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useSound -## Signature - -```typescript -useSound(library: ISoundLibrary): void; -``` - -## Parameters - -### library -**Type**:`ISoundLibrary` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/core/core/NanoforgeFactory.mdx b/references/1.3.0/core/core/NanoforgeFactory.mdx deleted file mode 100644 index 8b45ccf..0000000 --- a/references/1.3.0/core/core/NanoforgeFactory.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "NanoforgeFactory variable" -icon: "variable" -description: "NanoforgeFactory API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeFactory - - -## Signature - -```typescript -NanoforgeFactory: NanoforgeFactoryStatic -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/core/core/NanoforgeServer.mdx b/references/1.3.0/core/core/NanoforgeServer.mdx deleted file mode 100644 index 516198a..0000000 --- a/references/1.3.0/core/core/NanoforgeServer.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeServer class" -icon: "box" -description: "NanoforgeServer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeServer -## Signature - -```typescript -declare class NanoforgeServer extends NanoforgeApplication -``` - -## Constructors - -*No constructors defined.* - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/core/index.mdx b/references/1.3.0/core/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/core/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/ecs-client/ecs-client.mdx b/references/1.3.0/ecs-client/ecs-client.mdx deleted file mode 100644 index c8988e0..0000000 --- a/references/1.3.0/ecs-client/ecs-client.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ecs-client package" -icon: "package" -description: "@nanoforge-dev/ecs-client API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/ecs-client -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary.mdx b/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary.mdx deleted file mode 100644 index 4f1fe07..0000000 --- a/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "ECSClientLibrary class" -icon: "box" -description: "ECSClientLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ECSClientLibrary -## Signature - -```typescript -declare class ECSClientLibrary extends AbstractECSLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -## Methods - -### __init - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__init.mdx b/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__init.mdx deleted file mode 100644 index 2a476bf..0000000 --- a/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__name.mdx b/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/constructor.mdx b/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/constructor.mdx deleted file mode 100644 index 5a0ce12..0000000 --- a/references/1.3.0/ecs-client/ecs-client/ECSClientLibrary/constructor.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ECSClientLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ECSClientLibrary` class -## Signature - -```typescript -constructor(); -``` - -*This constructor takes no parameters.* \ No newline at end of file diff --git a/references/1.3.0/ecs-client/index.mdx b/references/1.3.0/ecs-client/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/ecs-client/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib.mdx b/references/1.3.0/ecs-lib/ecs-lib.mdx deleted file mode 100644 index f965052..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ecs-lib package" -icon: "package" -description: "@nanoforge-dev/ecs-lib API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/ecs-lib -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary.mdx b/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary.mdx deleted file mode 100644 index a246a25..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "AbstractECSLibrary class" -icon: "box" -description: "Abstract class representing an ECS (Entity Component System) library. Extends the BaseComponentSystemLibrary to provide ECS-specific functionality. Manages a registry of systems and ensures proper initialization before use. AbstractECSLibrary" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# AbstractECSLibrary - -## Summary - -Abstract class representing an ECS (Entity Component System) library. Extends the BaseComponentSystemLibrary to provide ECS-specific functionality. Manages a registry of systems and ensures proper initialization before use. AbstractECSLibrary BaseComponentSystemLibrary -## Signature - -```typescript -declare abstract class AbstractECSLibrary extends BaseComponentSystemLibrary -``` - -## Constructors - -### constructor -**Modifiers**: protected - -Constructs a new instance of the class - -## Properties - -### __name -**Modifiers**: abstract, readonly -**Type**:`abstract get __name(): string;` -**Default**: `` - - - -### _registry -**Modifiers**: protected -**Type**:`protected _registry?: Registry;` -**Optional**: Yes -**Default**: `` - - - -### module -**Modifiers**: protected -**Type**:`protected module?: MainModule;` -**Optional**: Yes -**Default**: `` - - - -### path -**Modifiers**: protected -**Type**:`protected path: string;` -**Default**: `` - - - -### registry -**Modifiers**: readonly -**Type**:`get registry(): Registry;` -**Default**: `` - -Gets the registry. - -## Methods - -### __run - -Runs the ECS systems using the provided context. - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__name.mdx b/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__run.mdx b/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__run.mdx deleted file mode 100644 index 47ff7ab..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/__run.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "__run" -icon: "function" -description: "Runs the ECS systems using the provided context." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __run - -## Summary - -Runs the ECS systems using the provided context. -## Signature - -```typescript -__run(ctx: Context): Promise; -``` - -## Parameters - -### ctx -**Type**:`Context` - -The context to be used for running the systems. - -## Returns - -**Type**:`Promise` - -Runs the ECS systems using the provided context. \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/_registry.mdx b/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/_registry.mdx deleted file mode 100644 index fd7e5c2..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/_registry.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "_registry" -icon: "variable" -description: "_registry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _registry - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/constructor.mdx b/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/constructor.mdx deleted file mode 100644 index 1736cfa..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/constructor.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the AbstractECSLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `AbstractECSLibrary` class -## Signature - -```typescript -protected constructor(); -``` - -*This constructor takes no parameters.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/module.mdx b/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/module.mdx deleted file mode 100644 index d745832..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/module.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "module" -icon: "variable" -description: "module API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# module - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/path.mdx b/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/path.mdx deleted file mode 100644 index eb37172..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/path.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "path" -icon: "variable" -description: "path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# path - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/registry.mdx b/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/registry.mdx deleted file mode 100644 index 771d9ca..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/AbstractECSLibrary/registry.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "registry" -icon: "variable" -description: "Gets the registry." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registry - -## Summary - -Gets the registry. - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Component.mdx b/references/1.3.0/ecs-lib/ecs-lib/Component.mdx deleted file mode 100644 index eb9196c..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Component.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Component type" -icon: "file-code" -description: "Component API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Component - - -## Signature - -```typescript -type Component = { - name: string; - [key: string]: any; -}; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/EditorComponentManifest.mdx b/references/1.3.0/ecs-lib/ecs-lib/EditorComponentManifest.mdx deleted file mode 100644 index 43beeb2..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/EditorComponentManifest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "EditorComponentManifest type" -icon: "file-code" -description: "Manifest for a component to be used in the NanoForge Editor" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorComponentManifest - -## Summary - -Manifest for a component to be used in the NanoForge Editor - - -## Signature - -```typescript -type EditorComponentManifest = { - name: string; - description?: string; - params: ECSElement[]; -}; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/EditorSystemManifest.mdx b/references/1.3.0/ecs-lib/ecs-lib/EditorSystemManifest.mdx deleted file mode 100644 index 51ab161..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/EditorSystemManifest.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "EditorSystemManifest type" -icon: "file-code" -description: "Manifest for a system to be used in the NanoForge Editor" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorSystemManifest - -## Summary - -Manifest for a system to be used in the NanoForge Editor - - -## Signature - -```typescript -type EditorSystemManifest = { - name: string; - description?: string; - dependencies: string[]; -}; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Entity.mdx b/references/1.3.0/ecs-lib/ecs-lib/Entity.mdx deleted file mode 100644 index 44171dd..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Entity.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Entity interface" -icon: "plug" -description: "Entity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Entity -## Signature - -```typescript -interface Entity extends ClassHandle -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Entity/getId.mdx b/references/1.3.0/ecs-lib/ecs-lib/Entity/getId.mdx deleted file mode 100644 index b363787..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Entity/getId.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getId" -icon: "file" -description: "getId API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getId - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry.mdx deleted file mode 100644 index 01348c6..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Registry interface" -icon: "plug" -description: "Registry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Registry -## Signature - -```typescript -interface Registry extends ClassHandle -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/addComponent.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/addComponent.mdx deleted file mode 100644 index 938d691..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/addComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "addComponent" -icon: "file" -description: "addComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# addComponent - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/addSystem.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/addSystem.mdx deleted file mode 100644 index 72af2a6..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/addSystem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "addSystem" -icon: "file" -description: "addSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# addSystem - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/clearEntities.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/clearEntities.mdx deleted file mode 100644 index 9b5c9d6..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/clearEntities.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clearEntities" -icon: "file" -description: "clearEntities API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clearEntities - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/clearSystems.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/clearSystems.mdx deleted file mode 100644 index 8e0053d..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/clearSystems.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clearSystems" -icon: "file" -description: "clearSystems API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clearSystems - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/entityFromIndex.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/entityFromIndex.mdx deleted file mode 100644 index 5746a8c..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/entityFromIndex.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "entityFromIndex" -icon: "file" -description: "entityFromIndex API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# entityFromIndex - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/getComponents.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/getComponents.mdx deleted file mode 100644 index 7e2eb0c..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/getComponents.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getComponents" -icon: "file" -description: "getComponents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponents - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/getComponentsConst.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/getComponentsConst.mdx deleted file mode 100644 index c0c5e75..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/getComponentsConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getComponentsConst" -icon: "file" -description: "getComponentsConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentsConst - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponent.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponent.mdx deleted file mode 100644 index 65648c3..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getEntityComponent" -icon: "file" -description: "getEntityComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getEntityComponent - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponentConst.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponentConst.mdx deleted file mode 100644 index de8259d..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/getEntityComponentConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getEntityComponentConst" -icon: "file" -description: "getEntityComponentConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getEntityComponentConst - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/getZipper.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/getZipper.mdx deleted file mode 100644 index f7a918c..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/getZipper.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getZipper" -icon: "file" -description: "getZipper API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getZipper - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/killEntity.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/killEntity.mdx deleted file mode 100644 index 4979d97..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/killEntity.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "killEntity" -icon: "file" -description: "killEntity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# killEntity - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/maxEntities.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/maxEntities.mdx deleted file mode 100644 index f1eb150..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/maxEntities.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "maxEntities" -icon: "file" -description: "maxEntities API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# maxEntities - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/registerComponent.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/registerComponent.mdx deleted file mode 100644 index b0540e5..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/registerComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "registerComponent" -icon: "file" -description: "registerComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registerComponent - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/removeComponent.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/removeComponent.mdx deleted file mode 100644 index 0efa117..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/removeComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "removeComponent" -icon: "file" -description: "removeComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# removeComponent - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/removeSystem.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/removeSystem.mdx deleted file mode 100644 index fea7019..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/removeSystem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "removeSystem" -icon: "file" -description: "removeSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# removeSystem - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/runSystems.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/runSystems.mdx deleted file mode 100644 index 4a391a1..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/runSystems.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "runSystems" -icon: "file" -description: "runSystems API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# runSystems - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/Registry/spawnEntity.mdx b/references/1.3.0/ecs-lib/ecs-lib/Registry/spawnEntity.mdx deleted file mode 100644 index 183b6f5..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/Registry/spawnEntity.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "spawnEntity" -icon: "file" -description: "spawnEntity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# spawnEntity - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray.mdx deleted file mode 100644 index 7d53f5c..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "SparseArray interface" -icon: "plug" -description: "SparseArray API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SparseArray -## Signature - -```typescript -interface SparseArray extends ClassHandle -``` - -## Properties - -*No properties defined.* - -## Methods - -*No methods defined.* - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/clear.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/clear.mdx deleted file mode 100644 index 782f12a..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/clear.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clear" -icon: "file" -description: "clear API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clear - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/empty.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/empty.mdx deleted file mode 100644 index 860f54e..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/empty.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "empty" -icon: "file" -description: "empty API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# empty - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/erase.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/erase.mdx deleted file mode 100644 index 289e964..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/erase.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "erase" -icon: "file" -description: "erase API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# erase - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/get.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/get.mdx deleted file mode 100644 index 18a25bc..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/get.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "get" -icon: "file" -description: "get API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# get - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/getConst.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/getConst.mdx deleted file mode 100644 index 3314654..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/getConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getConst" -icon: "file" -description: "getConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConst - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/getIndex.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/getIndex.mdx deleted file mode 100644 index e6a39d6..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/getIndex.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getIndex" -icon: "file" -description: "getIndex API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getIndex - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt.mdx deleted file mode 100644 index 9a5e08b..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "insertAt" -icon: "file" -description: "insertAt API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# insertAt - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt_1.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt_1.mdx deleted file mode 100644 index 9a5e08b..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/insertAt_1.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "insertAt" -icon: "file" -description: "insertAt API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# insertAt - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/resize.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/resize.mdx deleted file mode 100644 index 6e14c19..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/resize.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "resize" -icon: "file" -description: "resize API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# resize - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/set.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/set.mdx deleted file mode 100644 index 008ca6e..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/set.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "set" -icon: "file" -description: "set API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# set - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByCopy.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByCopy.mdx deleted file mode 100644 index 0da1576..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByCopy.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "setByCopy" -icon: "file" -description: "setByCopy API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setByCopy - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByMove.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByMove.mdx deleted file mode 100644 index d6bb457..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/setByMove.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "setByMove" -icon: "file" -description: "setByMove API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setByMove - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/size.mdx b/references/1.3.0/ecs-lib/ecs-lib/SparseArray/size.mdx deleted file mode 100644 index c4186f7..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/SparseArray/size.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "size" -icon: "file" -description: "size API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# size - -## Description \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/ecs-lib/System.mdx b/references/1.3.0/ecs-lib/ecs-lib/System.mdx deleted file mode 100644 index 6e7d21f..0000000 --- a/references/1.3.0/ecs-lib/ecs-lib/System.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "System type" -icon: "file-code" -description: "System API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# System - - -## Signature - -```typescript -type System = (registry: Registry, ctx: Context) => void; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/ecs-lib/index.mdx b/references/1.3.0/ecs-lib/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/ecs-lib/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/ecs-server/ecs-server.mdx b/references/1.3.0/ecs-server/ecs-server.mdx deleted file mode 100644 index 444eac3..0000000 --- a/references/1.3.0/ecs-server/ecs-server.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "ecs-server package" -icon: "package" -description: "@nanoforge-dev/ecs-server API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/ecs-server -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary.mdx b/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary.mdx deleted file mode 100644 index 38f010a..0000000 --- a/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "ECSServerLibrary class" -icon: "box" -description: "ECSServerLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ECSServerLibrary -## Signature - -```typescript -declare class ECSServerLibrary extends AbstractECSLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -## Methods - -### __init - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__init.mdx b/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__init.mdx deleted file mode 100644 index 2a476bf..0000000 --- a/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__name.mdx b/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/constructor.mdx b/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/constructor.mdx deleted file mode 100644 index 7f650b2..0000000 --- a/references/1.3.0/ecs-server/ecs-server/ECSServerLibrary/constructor.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ECSServerLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ECSServerLibrary` class -## Signature - -```typescript -constructor(); -``` - -*This constructor takes no parameters.* \ No newline at end of file diff --git a/references/1.3.0/ecs-server/ecs-server/Module.mdx b/references/1.3.0/ecs-server/ecs-server/Module.mdx deleted file mode 100644 index 0aaf590..0000000 --- a/references/1.3.0/ecs-server/ecs-server/Module.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Module variable" -icon: "variable" -description: "Module API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Module - - -## Signature - -```typescript -Module: typeof MainModuleFactory -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/ecs-server/index.mdx b/references/1.3.0/ecs-server/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/ecs-server/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d.mdx b/references/1.3.0/graphics-2d/graphics-2d.mdx deleted file mode 100644 index f8a3e82..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "graphics-2d package" -icon: "package" -description: "@nanoforge-dev/graphics-2d API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/graphics-2d -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Animation_2.mdx b/references/1.3.0/graphics-2d/graphics-2d/Animation_2.mdx deleted file mode 100644 index 204cf3f..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Animation_2.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Animation_2 variable" -icon: "variable" -description: "Animation_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Animation_2 - - -## Signature - -```typescript -Animation: typeof import("konva/lib/Animation").Animation -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Arc.mdx b/references/1.3.0/graphics-2d/graphics-2d/Arc.mdx deleted file mode 100644 index cf1bfe4..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Arc.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Arc variable" -icon: "variable" -description: "Arc API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Arc - - -## Signature - -```typescript -Arc: typeof import("konva/lib/shapes/Arc").Arc -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/ArcConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/ArcConfig.mdx deleted file mode 100644 index b7ea12c..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/ArcConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ArcConfig type" -icon: "file-code" -description: "ArcConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ArcConfig - - -## Signature - -```typescript -type ArcConfig = Konva.ArcConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Arrow.mdx b/references/1.3.0/graphics-2d/graphics-2d/Arrow.mdx deleted file mode 100644 index a52418f..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Arrow.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Arrow variable" -icon: "variable" -description: "Arrow API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Arrow - - -## Signature - -```typescript -Arrow: typeof import("konva/lib/shapes/Arrow").Arrow -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/ArrowConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/ArrowConfig.mdx deleted file mode 100644 index 2e0582a..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/ArrowConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ArrowConfig type" -icon: "file-code" -description: "ArrowConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ArrowConfig - - -## Signature - -```typescript -type ArrowConfig = Konva.ArrowConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Canvas.mdx b/references/1.3.0/graphics-2d/graphics-2d/Canvas.mdx deleted file mode 100644 index ba77845..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Canvas.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Canvas variable" -icon: "variable" -description: "Canvas API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Canvas - - -## Signature - -```typescript -Canvas: typeof import("konva/lib/Canvas").Canvas -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Circle.mdx b/references/1.3.0/graphics-2d/graphics-2d/Circle.mdx deleted file mode 100644 index f608e1d..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Circle.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Circle variable" -icon: "variable" -description: "Circle API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Circle - - -## Signature - -```typescript -Circle: typeof import("konva/lib/shapes/Circle").Circle -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/CircleConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/CircleConfig.mdx deleted file mode 100644 index 742ae63..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/CircleConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "CircleConfig type" -icon: "file-code" -description: "CircleConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# CircleConfig - - -## Signature - -```typescript -type CircleConfig = Konva.CircleConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Container.mdx b/references/1.3.0/graphics-2d/graphics-2d/Container.mdx deleted file mode 100644 index 4f436cc..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Container.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Container variable" -icon: "variable" -description: "Container API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Container - - -## Signature - -```typescript -Container: typeof import("konva/lib/Container").Container -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/ContainerConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/ContainerConfig.mdx deleted file mode 100644 index cd3a7d5..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/ContainerConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ContainerConfig type" -icon: "file-code" -description: "ContainerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ContainerConfig - - -## Signature - -```typescript -type ContainerConfig = Konva.ContainerConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Context.mdx b/references/1.3.0/graphics-2d/graphics-2d/Context.mdx deleted file mode 100644 index 4df2856..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Context.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Context variable" -icon: "variable" -description: "Context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Context - - -## Signature - -```typescript -Context: typeof import("konva/lib/Context").Context -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/DD.mdx b/references/1.3.0/graphics-2d/graphics-2d/DD.mdx deleted file mode 100644 index 8b2df33..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/DD.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "DD variable" -icon: "variable" -description: "DD API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# DD - - -## Signature - -```typescript -DD: { - readonly isDragging: boolean; - justDragged: boolean; - readonly node: import("konva/lib/Node").Node | undefined; - _dragElements: Map; - _drag(evt: any): void; - _endDragBefore(evt?: any): void; - _endDragAfter(evt: any): void; -} -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Easings.mdx b/references/1.3.0/graphics-2d/graphics-2d/Easings.mdx deleted file mode 100644 index fd34cae..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Easings.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "Easings variable" -icon: "variable" -description: "Easings API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Easings - - -## Signature - -```typescript -Easings: { - BackEaseIn(t: any, b: any, c: any, d: any): any; - BackEaseOut(t: any, b: any, c: any, d: any): any; - BackEaseInOut(t: any, b: any, c: any, d: any): any; - ElasticEaseIn(t: any, b: any, c: any, d: any, a: any, p: any): any; - ElasticEaseOut(t: any, b: any, c: any, d: any, a: any, p: any): any; - ElasticEaseInOut(t: any, b: any, c: any, d: any, a: any, p: any): any; - BounceEaseOut(t: any, b: any, c: any, d: any): any; - BounceEaseIn(t: any, b: any, c: any, d: any): any; - BounceEaseInOut(t: any, b: any, c: any, d: any): any; - EaseIn(t: any, b: any, c: any, d: any): any; - EaseOut(t: any, b: any, c: any, d: any): any; - EaseInOut(t: any, b: any, c: any, d: any): any; - StrongEaseIn(t: any, b: any, c: any, d: any): any; - StrongEaseOut(t: any, b: any, c: any, d: any): any; - StrongEaseInOut(t: any, b: any, c: any, d: any): any; - Linear(t: any, b: any, c: any, d: any): any; -} -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Ellipse.mdx b/references/1.3.0/graphics-2d/graphics-2d/Ellipse.mdx deleted file mode 100644 index 4ff06cc..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Ellipse.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Ellipse variable" -icon: "variable" -description: "Ellipse API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Ellipse - - -## Signature - -```typescript -Ellipse: typeof import("konva/lib/shapes/Ellipse").Ellipse -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/EllipseConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/EllipseConfig.mdx deleted file mode 100644 index f66725b..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/EllipseConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "EllipseConfig type" -icon: "file-code" -description: "EllipseConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EllipseConfig - - -## Signature - -```typescript -type EllipseConfig = Konva.EllipseConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/FastLayer.mdx b/references/1.3.0/graphics-2d/graphics-2d/FastLayer.mdx deleted file mode 100644 index e5c56ae..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/FastLayer.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "FastLayer variable" -icon: "variable" -description: "FastLayer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# FastLayer - - -## Signature - -```typescript -FastLayer: typeof import("konva/lib/FastLayer").FastLayer -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Filters.mdx b/references/1.3.0/graphics-2d/graphics-2d/Filters.mdx deleted file mode 100644 index f270f90..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Filters.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "Filters variable" -icon: "variable" -description: "Filters API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Filters - - -## Signature - -```typescript -Filters: { - Blur: import("konva/lib/Node").Filter; - Brightness: import("konva/lib/Node").Filter; - Brighten: import("konva/lib/Node").Filter; - Contrast: import("konva/lib/Node").Filter; - Emboss: import("konva/lib/Node").Filter; - Enhance: import("konva/lib/Node").Filter; - Grayscale: import("konva/lib/Node").Filter; - HSL: import("konva/lib/Node").Filter; - HSV: import("konva/lib/Node").Filter; - Invert: import("konva/lib/Node").Filter; - Kaleidoscope: import("konva/lib/Node").Filter; - Mask: import("konva/lib/Node").Filter; - Noise: import("konva/lib/Node").Filter; - Pixelate: import("konva/lib/Node").Filter; - Posterize: import("konva/lib/Node").Filter; - RGB: import("konva/lib/Node").Filter; - RGBA: import("konva/lib/Node").Filter; - Sepia: import("konva/lib/Node").Filter; - Solarize: import("konva/lib/Node").Filter; - Threshold: import("konva/lib/Node").Filter; -} -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary.mdx b/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary.mdx deleted file mode 100644 index cc68d60..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Graphics2DLibrary class" -icon: "box" -description: "Graphics2DLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Graphics2DLibrary -## Signature - -```typescript -declare class Graphics2DLibrary extends BaseGraphicsLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -### baseLayer -**Modifiers**: readonly -**Type**:`get baseLayer(): Layer;` -**Default**: `` - - - -### stage -**Modifiers**: readonly -**Type**:`get stage(): Stage;` -**Default**: `` - - - -## Methods - -### __init - - - -### __run - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__init.mdx b/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__init.mdx deleted file mode 100644 index 2a476bf..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__name.mdx b/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__run.mdx b/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__run.mdx deleted file mode 100644 index a467ed8..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/__run.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "__run" -icon: "function" -description: "__run API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __run -## Signature - -```typescript -__run(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/baseLayer.mdx b/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/baseLayer.mdx deleted file mode 100644 index af269f1..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/baseLayer.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "baseLayer" -icon: "variable" -description: "baseLayer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# baseLayer - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/stage.mdx b/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/stage.mdx deleted file mode 100644 index 3de20b8..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Graphics2DLibrary/stage.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "stage" -icon: "variable" -description: "stage API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# stage - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Group.mdx b/references/1.3.0/graphics-2d/graphics-2d/Group.mdx deleted file mode 100644 index 2ac1b5b..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Group.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Group variable" -icon: "variable" -description: "Group API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Group - - -## Signature - -```typescript -Group: typeof import("konva/lib/Group").Group -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/GroupConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/GroupConfig.mdx deleted file mode 100644 index bb936ab..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/GroupConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "GroupConfig type" -icon: "file-code" -description: "GroupConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# GroupConfig - - -## Signature - -```typescript -type GroupConfig = Konva.GroupConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/ImageConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/ImageConfig.mdx deleted file mode 100644 index c3f63c3..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/ImageConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ImageConfig type" -icon: "file-code" -description: "ImageConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ImageConfig - - -## Signature - -```typescript -type ImageConfig = Konva.ImageConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Image_2.mdx b/references/1.3.0/graphics-2d/graphics-2d/Image_2.mdx deleted file mode 100644 index 1b2d6f0..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Image_2.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Image_2 variable" -icon: "variable" -description: "Image_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Image_2 - - -## Signature - -```typescript -Image: typeof import("konva/lib/shapes/Image").Image -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/KonvaEventListener.mdx b/references/1.3.0/graphics-2d/graphics-2d/KonvaEventListener.mdx deleted file mode 100644 index 07ceac4..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/KonvaEventListener.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "KonvaEventListener type" -icon: "file-code" -description: "KonvaEventListener API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaEventListener - - -## Signature - -```typescript -type KonvaEventListener = Konva.KonvaEventListener; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/KonvaEventObject.mdx b/references/1.3.0/graphics-2d/graphics-2d/KonvaEventObject.mdx deleted file mode 100644 index 56b9013..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/KonvaEventObject.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "KonvaEventObject type" -icon: "file-code" -description: "KonvaEventObject API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaEventObject - - -## Signature - -```typescript -type KonvaEventObject = Konva.KonvaEventObject; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/KonvaPointerEvent.mdx b/references/1.3.0/graphics-2d/graphics-2d/KonvaPointerEvent.mdx deleted file mode 100644 index 11f23dc..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/KonvaPointerEvent.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "KonvaPointerEvent type" -icon: "file-code" -description: "KonvaPointerEvent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaPointerEvent - - -## Signature - -```typescript -type KonvaPointerEvent = Konva.KonvaPointerEvent; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Label.mdx b/references/1.3.0/graphics-2d/graphics-2d/Label.mdx deleted file mode 100644 index ef01a6e..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Label.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Label variable" -icon: "variable" -description: "Label API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Label - - -## Signature - -```typescript -Label: typeof import("konva/lib/shapes/Label").Label -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/LabelConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/LabelConfig.mdx deleted file mode 100644 index 48ba308..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/LabelConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "LabelConfig type" -icon: "file-code" -description: "LabelConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LabelConfig - - -## Signature - -```typescript -type LabelConfig = Konva.LabelConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Layer.mdx b/references/1.3.0/graphics-2d/graphics-2d/Layer.mdx deleted file mode 100644 index bf8785f..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Layer.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Layer variable" -icon: "variable" -description: "Layer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Layer - - -## Signature - -```typescript -Layer: typeof import("konva/lib/Layer").Layer -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/LayerConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/LayerConfig.mdx deleted file mode 100644 index 070d4e7..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/LayerConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "LayerConfig type" -icon: "file-code" -description: "LayerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LayerConfig - - -## Signature - -```typescript -type LayerConfig = Konva.LayerConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Line.mdx b/references/1.3.0/graphics-2d/graphics-2d/Line.mdx deleted file mode 100644 index 298940f..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Line.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Line variable" -icon: "variable" -description: "Line API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Line - - -## Signature - -```typescript -Line: typeof import("konva/lib/shapes/Line").Line -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/LineConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/LineConfig.mdx deleted file mode 100644 index 134cb3f..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/LineConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "LineConfig type" -icon: "file-code" -description: "LineConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LineConfig - - -## Signature - -```typescript -type LineConfig = Konva.LineConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/NodeConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/NodeConfig.mdx deleted file mode 100644 index 41be5d4..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/NodeConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "NodeConfig type" -icon: "file-code" -description: "NodeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NodeConfig - - -## Signature - -```typescript -type NodeConfig = Konva.NodeConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Node_2.mdx b/references/1.3.0/graphics-2d/graphics-2d/Node_2.mdx deleted file mode 100644 index 216d429..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Node_2.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Node_2 variable" -icon: "variable" -description: "Node_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Node_2 - - -## Signature - -```typescript -Node: typeof import("konva/lib/Node").Node -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Path.mdx b/references/1.3.0/graphics-2d/graphics-2d/Path.mdx deleted file mode 100644 index b3b5afb..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Path.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Path variable" -icon: "variable" -description: "Path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Path - - -## Signature - -```typescript -Path: typeof import("konva/lib/shapes/Path").Path -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/PathConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/PathConfig.mdx deleted file mode 100644 index 176ba8c..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/PathConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "PathConfig type" -icon: "file-code" -description: "PathConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# PathConfig - - -## Signature - -```typescript -type PathConfig = Konva.PathConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Rect.mdx b/references/1.3.0/graphics-2d/graphics-2d/Rect.mdx deleted file mode 100644 index 269cb22..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Rect.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Rect variable" -icon: "variable" -description: "Rect API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Rect - - -## Signature - -```typescript -Rect: typeof import("konva/lib/shapes/Rect").Rect -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/RectConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/RectConfig.mdx deleted file mode 100644 index 6a0ff10..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/RectConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "RectConfig type" -icon: "file-code" -description: "RectConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RectConfig - - -## Signature - -```typescript -type RectConfig = Konva.RectConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/RegularPolygon.mdx b/references/1.3.0/graphics-2d/graphics-2d/RegularPolygon.mdx deleted file mode 100644 index abe5f5a..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/RegularPolygon.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "RegularPolygon variable" -icon: "variable" -description: "RegularPolygon API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RegularPolygon - - -## Signature - -```typescript -RegularPolygon: typeof import("konva/lib/shapes/RegularPolygon").RegularPolygon -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/RegularPolygonConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/RegularPolygonConfig.mdx deleted file mode 100644 index 6729af9..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/RegularPolygonConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "RegularPolygonConfig type" -icon: "file-code" -description: "RegularPolygonConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RegularPolygonConfig - - -## Signature - -```typescript -type RegularPolygonConfig = Konva.RegularPolygonConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Ring.mdx b/references/1.3.0/graphics-2d/graphics-2d/Ring.mdx deleted file mode 100644 index 9e40118..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Ring.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Ring variable" -icon: "variable" -description: "Ring API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Ring - - -## Signature - -```typescript -Ring: typeof import("konva/lib/shapes/Ring").Ring -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/RingConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/RingConfig.mdx deleted file mode 100644 index ba12825..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/RingConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "RingConfig type" -icon: "file-code" -description: "RingConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RingConfig - - -## Signature - -```typescript -type RingConfig = Konva.RingConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Shape.mdx b/references/1.3.0/graphics-2d/graphics-2d/Shape.mdx deleted file mode 100644 index 9747d74..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Shape.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Shape variable" -icon: "variable" -description: "Shape API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Shape - - -## Signature - -```typescript -Shape: typeof import("konva/lib/Shape").Shape -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/ShapeConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/ShapeConfig.mdx deleted file mode 100644 index dfe94ee..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/ShapeConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ShapeConfig type" -icon: "file-code" -description: "ShapeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ShapeConfig - - -## Signature - -```typescript -type ShapeConfig = Konva.ShapeConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Sprite.mdx b/references/1.3.0/graphics-2d/graphics-2d/Sprite.mdx deleted file mode 100644 index 953e8e9..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Sprite.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Sprite variable" -icon: "variable" -description: "Sprite API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Sprite - - -## Signature - -```typescript -Sprite: typeof import("konva/lib/shapes/Sprite").Sprite -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/SpriteConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/SpriteConfig.mdx deleted file mode 100644 index 8ceb457..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/SpriteConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "SpriteConfig type" -icon: "file-code" -description: "SpriteConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SpriteConfig - - -## Signature - -```typescript -type SpriteConfig = Konva.SpriteConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Stage.mdx b/references/1.3.0/graphics-2d/graphics-2d/Stage.mdx deleted file mode 100644 index 123e4f5..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Stage.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Stage variable" -icon: "variable" -description: "Stage API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Stage - - -## Signature - -```typescript -Stage: typeof import("konva/lib/Stage").Stage -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/StageConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/StageConfig.mdx deleted file mode 100644 index 68cf2a2..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/StageConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "StageConfig type" -icon: "file-code" -description: "StageConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# StageConfig - - -## Signature - -```typescript -type StageConfig = Konva.StageConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Star.mdx b/references/1.3.0/graphics-2d/graphics-2d/Star.mdx deleted file mode 100644 index 3526d68..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Star.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Star variable" -icon: "variable" -description: "Star API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Star - - -## Signature - -```typescript -Star: typeof import("konva/lib/shapes/Star").Star -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/StarConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/StarConfig.mdx deleted file mode 100644 index 9ff5a5e..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/StarConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "StarConfig type" -icon: "file-code" -description: "StarConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# StarConfig - - -## Signature - -```typescript -type StarConfig = Konva.StarConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Tag.mdx b/references/1.3.0/graphics-2d/graphics-2d/Tag.mdx deleted file mode 100644 index 3c4cd0a..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Tag.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Tag variable" -icon: "variable" -description: "Tag API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Tag - - -## Signature - -```typescript -Tag: typeof import("konva/lib/shapes/Label").Tag -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/TagConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/TagConfig.mdx deleted file mode 100644 index dae0b98..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/TagConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "TagConfig type" -icon: "file-code" -description: "TagConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TagConfig - - -## Signature - -```typescript -type TagConfig = Konva.TagConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/TextConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/TextConfig.mdx deleted file mode 100644 index 507fb41..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/TextConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "TextConfig type" -icon: "file-code" -description: "TextConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextConfig - - -## Signature - -```typescript -type TextConfig = Konva.TextConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/TextPath.mdx b/references/1.3.0/graphics-2d/graphics-2d/TextPath.mdx deleted file mode 100644 index 56a9bc9..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/TextPath.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "TextPath variable" -icon: "variable" -description: "TextPath API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextPath - - -## Signature - -```typescript -TextPath: typeof import("konva/lib/shapes/TextPath").TextPath -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/TextPathConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/TextPathConfig.mdx deleted file mode 100644 index 3e5fb66..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/TextPathConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "TextPathConfig type" -icon: "file-code" -description: "TextPathConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextPathConfig - - -## Signature - -```typescript -type TextPathConfig = Konva.TextPathConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Text_2.mdx b/references/1.3.0/graphics-2d/graphics-2d/Text_2.mdx deleted file mode 100644 index 8964cd4..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Text_2.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Text_2 variable" -icon: "variable" -description: "Text_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Text_2 - - -## Signature - -```typescript -Text: typeof import("konva/lib/shapes/Text").Text -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Transform.mdx b/references/1.3.0/graphics-2d/graphics-2d/Transform.mdx deleted file mode 100644 index 0c2d55a..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Transform.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Transform variable" -icon: "variable" -description: "Transform API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Transform - - -## Signature - -```typescript -Transform: typeof import("konva/lib/Util").Transform -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/TransformerConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/TransformerConfig.mdx deleted file mode 100644 index 8114321..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/TransformerConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "TransformerConfig type" -icon: "file-code" -description: "TransformerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TransformerConfig - - -## Signature - -```typescript -type TransformerConfig = Konva.TransformerConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Transformer_2.mdx b/references/1.3.0/graphics-2d/graphics-2d/Transformer_2.mdx deleted file mode 100644 index 2f49569..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Transformer_2.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Transformer_2 variable" -icon: "variable" -description: "Transformer_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Transformer_2 - - -## Signature - -```typescript -Transformer: typeof import("konva/lib/shapes/Transformer").Transformer -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Tween.mdx b/references/1.3.0/graphics-2d/graphics-2d/Tween.mdx deleted file mode 100644 index 5c63fed..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Tween.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Tween variable" -icon: "variable" -description: "Tween API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Tween - - -## Signature - -```typescript -Tween: typeof import("konva/lib/Tween").Tween -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/TweenConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/TweenConfig.mdx deleted file mode 100644 index d444954..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/TweenConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "TweenConfig type" -icon: "file-code" -description: "TweenConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TweenConfig - - -## Signature - -```typescript -type TweenConfig = Konva.TweenConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Util.mdx b/references/1.3.0/graphics-2d/graphics-2d/Util.mdx deleted file mode 100644 index e7cd0bb..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Util.mdx +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: "Util variable" -icon: "variable" -description: "Util API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Util - - -## Signature - -```typescript -Util: { - _isElement(obj: any): obj is Element; - _isFunction(obj: any): boolean; - _isPlainObject(obj: any): boolean; - _isArray(obj: any): obj is Array; - _isNumber(obj: any): obj is number; - _isString(obj: any): obj is string; - _isBoolean(obj: any): obj is boolean; - isObject(val: any): val is object; - isValidSelector(selector: any): boolean; - _sign(number: number): 1 | -1; - requestAnimFrame(callback: Function): void; - createCanvasElement(): HTMLCanvasElement; - createImageElement(): HTMLImageElement; - _isInDocument(el: any): boolean; - _urlToImage(url: string, callback: Function): void; - _rgbToHex(r: number, g: number, b: number): string; - _hexToRgb(hex: string): import("konva/lib/types").RGB; - getRandomColor(): string; - isCanvasFarblingActive(): boolean; - getHitColor(): string; - getHitColorKey(r: number, g: number, b: number): string; - getSnappedHexColor(hex: string): string; - getRGB(color: string): import("konva/lib/types").RGB; - colorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _namedColorToRBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | null; - _rgbColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _rgbaColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex8ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex6ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex4ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex3ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hslColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - haveIntersection(r1: import("konva/lib/types").IRect, r2: import("konva/lib/types").IRect): boolean; - cloneObject(obj: Any): Any; - cloneArray(arr: Array): any[]; - degToRad(deg: number): number; - radToDeg(rad: number): number; - _degToRad(deg: number): number; - _radToDeg(rad: number): number; - _getRotation(radians: number): number; - _capitalize(str: string): string; - throw(str: string): never; - error(str: string): void; - warn(str: string): void; - each(obj: object, func: Function): void; - _inRange(val: number, left: number, right: number): boolean; - _getProjectionToSegment(x1: any, y1: any, x2: any, y2: any, x3: any, y3: any): any[]; - _getProjectionToLine(pt: import("konva/lib/types").Vector2d, line: Array, isClosed: boolean): import("konva/lib/types").Vector2d; - _prepareArrayForTween(startArray: any, endArray: any, isClosed: any): number[]; - _prepareToStringify(obj: any): T | null; - _assign(target: T, source: U): T & U; - _getFirstPointerId(evt: any): any; - releaseCanvas(...canvases: HTMLCanvasElement[]): void; - drawRoundedRectPath(context: import("konva/lib/Context").Context, width: number, height: number, cornerRadius: number | number[]): void; - drawRoundedPolygonPath(context: import("konva/lib/Context").Context, points: import("konva/lib/types").Vector2d[], sides: number, radius: number, cornerRadius: number | number[]): void; -} -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Vector2d.mdx b/references/1.3.0/graphics-2d/graphics-2d/Vector2d.mdx deleted file mode 100644 index d16baa3..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Vector2d.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Vector2d type" -icon: "file-code" -description: "Vector2d API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Vector2d - - -## Signature - -```typescript -type Vector2d = Konva.Vector2d; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/Wedge.mdx b/references/1.3.0/graphics-2d/graphics-2d/Wedge.mdx deleted file mode 100644 index a7336c9..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/Wedge.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Wedge variable" -icon: "variable" -description: "Wedge API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Wedge - - -## Signature - -```typescript -Wedge: typeof import("konva/lib/shapes/Wedge").Wedge -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/WedgeConfig.mdx b/references/1.3.0/graphics-2d/graphics-2d/WedgeConfig.mdx deleted file mode 100644 index 7d6770d..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/WedgeConfig.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "WedgeConfig type" -icon: "file-code" -description: "WedgeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# WedgeConfig - - -## Signature - -```typescript -type WedgeConfig = Konva.WedgeConfig; -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_global.mdx b/references/1.3.0/graphics-2d/graphics-2d/_global.mdx deleted file mode 100644 index 6933191..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_global.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_global variable" -icon: "variable" -description: "_global API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _global - - -## Signature - -```typescript -_global: any -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_injectGlobal.mdx b/references/1.3.0/graphics-2d/graphics-2d/_injectGlobal.mdx deleted file mode 100644 index f306d7f..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_injectGlobal.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "_injectGlobal function" -icon: "function" -description: "_injectGlobal API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _injectGlobal - - -## Signature - -```typescript -_injectGlobal: (Konva: any) => void -``` - - -## Parameters - - - -### Konva - - -**Type**: any - - - - - - - - - - - - - -## Returns - - - -**Type**: void \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_mouseDblClickPointerId.mdx b/references/1.3.0/graphics-2d/graphics-2d/_mouseDblClickPointerId.mdx deleted file mode 100644 index 1c8348e..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_mouseDblClickPointerId.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_mouseDblClickPointerId variable" -icon: "variable" -description: "_mouseDblClickPointerId API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _mouseDblClickPointerId - - -## Signature - -```typescript -_mouseDblClickPointerId: null -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_mouseInDblClickWindow.mdx b/references/1.3.0/graphics-2d/graphics-2d/_mouseInDblClickWindow.mdx deleted file mode 100644 index 8a74fea..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_mouseInDblClickWindow.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_mouseInDblClickWindow variable" -icon: "variable" -description: "_mouseInDblClickWindow API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _mouseInDblClickWindow - - -## Signature - -```typescript -_mouseInDblClickWindow: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_mouseListenClick.mdx b/references/1.3.0/graphics-2d/graphics-2d/_mouseListenClick.mdx deleted file mode 100644 index 1719883..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_mouseListenClick.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_mouseListenClick variable" -icon: "variable" -description: "_mouseListenClick API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _mouseListenClick - - -## Signature - -```typescript -_mouseListenClick: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_pointerDblClickPointerId.mdx b/references/1.3.0/graphics-2d/graphics-2d/_pointerDblClickPointerId.mdx deleted file mode 100644 index 05fa04c..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_pointerDblClickPointerId.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_pointerDblClickPointerId variable" -icon: "variable" -description: "_pointerDblClickPointerId API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _pointerDblClickPointerId - - -## Signature - -```typescript -_pointerDblClickPointerId: null -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_pointerInDblClickWindow.mdx b/references/1.3.0/graphics-2d/graphics-2d/_pointerInDblClickWindow.mdx deleted file mode 100644 index d103253..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_pointerInDblClickWindow.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_pointerInDblClickWindow variable" -icon: "variable" -description: "_pointerInDblClickWindow API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _pointerInDblClickWindow - - -## Signature - -```typescript -_pointerInDblClickWindow: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_pointerListenClick.mdx b/references/1.3.0/graphics-2d/graphics-2d/_pointerListenClick.mdx deleted file mode 100644 index cbeffdf..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_pointerListenClick.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_pointerListenClick variable" -icon: "variable" -description: "_pointerListenClick API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _pointerListenClick - - -## Signature - -```typescript -_pointerListenClick: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_renderBackend.mdx b/references/1.3.0/graphics-2d/graphics-2d/_renderBackend.mdx deleted file mode 100644 index 78ef80c..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_renderBackend.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_renderBackend variable" -icon: "variable" -description: "_renderBackend API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _renderBackend - - -## Signature - -```typescript -_renderBackend: string -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_touchDblClickPointerId.mdx b/references/1.3.0/graphics-2d/graphics-2d/_touchDblClickPointerId.mdx deleted file mode 100644 index 0826aee..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_touchDblClickPointerId.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_touchDblClickPointerId variable" -icon: "variable" -description: "_touchDblClickPointerId API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _touchDblClickPointerId - - -## Signature - -```typescript -_touchDblClickPointerId: null -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_touchInDblClickWindow.mdx b/references/1.3.0/graphics-2d/graphics-2d/_touchInDblClickWindow.mdx deleted file mode 100644 index 05abb5d..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_touchInDblClickWindow.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_touchInDblClickWindow variable" -icon: "variable" -description: "_touchInDblClickWindow API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _touchInDblClickWindow - - -## Signature - -```typescript -_touchInDblClickWindow: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/_touchListenClick.mdx b/references/1.3.0/graphics-2d/graphics-2d/_touchListenClick.mdx deleted file mode 100644 index ef342cb..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/_touchListenClick.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "_touchListenClick variable" -icon: "variable" -description: "_touchListenClick API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _touchListenClick - - -## Signature - -```typescript -_touchListenClick: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/angleDeg.mdx b/references/1.3.0/graphics-2d/graphics-2d/angleDeg.mdx deleted file mode 100644 index be18428..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/angleDeg.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "angleDeg variable" -icon: "variable" -description: "angleDeg API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# angleDeg - - -## Signature - -```typescript -angleDeg: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/autoDrawEnabled.mdx b/references/1.3.0/graphics-2d/graphics-2d/autoDrawEnabled.mdx deleted file mode 100644 index 4d2316c..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/autoDrawEnabled.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "autoDrawEnabled variable" -icon: "variable" -description: "autoDrawEnabled API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# autoDrawEnabled - - -## Signature - -```typescript -autoDrawEnabled: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/capturePointerEventsEnabled.mdx b/references/1.3.0/graphics-2d/graphics-2d/capturePointerEventsEnabled.mdx deleted file mode 100644 index c075364..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/capturePointerEventsEnabled.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "capturePointerEventsEnabled variable" -icon: "variable" -description: "capturePointerEventsEnabled API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# capturePointerEventsEnabled - - -## Signature - -```typescript -capturePointerEventsEnabled: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/dblClickWindow.mdx b/references/1.3.0/graphics-2d/graphics-2d/dblClickWindow.mdx deleted file mode 100644 index a89cf31..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/dblClickWindow.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "dblClickWindow variable" -icon: "variable" -description: "dblClickWindow API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# dblClickWindow - - -## Signature - -```typescript -dblClickWindow: number -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/document_2.mdx b/references/1.3.0/graphics-2d/graphics-2d/document_2.mdx deleted file mode 100644 index c063c05..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/document_2.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "document_2 variable" -icon: "variable" -description: "document_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# document_2 - - -## Signature - -```typescript -document: any -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/dragButtons.mdx b/references/1.3.0/graphics-2d/graphics-2d/dragButtons.mdx deleted file mode 100644 index 85a06bf..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/dragButtons.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "dragButtons variable" -icon: "variable" -description: "dragButtons API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# dragButtons - - -## Signature - -```typescript -dragButtons: number[] -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/dragDistance.mdx b/references/1.3.0/graphics-2d/graphics-2d/dragDistance.mdx deleted file mode 100644 index 5838843..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/dragDistance.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "dragDistance variable" -icon: "variable" -description: "dragDistance API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# dragDistance - - -## Signature - -```typescript -dragDistance: number -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/enableTrace.mdx b/references/1.3.0/graphics-2d/graphics-2d/enableTrace.mdx deleted file mode 100644 index 88ea45f..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/enableTrace.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "enableTrace variable" -icon: "variable" -description: "enableTrace API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# enableTrace - - -## Signature - -```typescript -enableTrace: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/getAngle.mdx b/references/1.3.0/graphics-2d/graphics-2d/getAngle.mdx deleted file mode 100644 index 3b6851b..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/getAngle.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "getAngle function" -icon: "function" -description: "getAngle API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAngle - - -## Signature - -```typescript -getAngle: (angle: number) => number -``` - - -## Parameters - - - -### angle - - -**Type**: number - - - - - - - - - - - - - -## Returns - - - -**Type**: number \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/hitOnDragEnabled.mdx b/references/1.3.0/graphics-2d/graphics-2d/hitOnDragEnabled.mdx deleted file mode 100644 index 00dcfa8..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/hitOnDragEnabled.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "hitOnDragEnabled variable" -icon: "variable" -description: "hitOnDragEnabled API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# hitOnDragEnabled - - -## Signature - -```typescript -hitOnDragEnabled: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/isBrowser.mdx b/references/1.3.0/graphics-2d/graphics-2d/isBrowser.mdx deleted file mode 100644 index d67ac5f..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/isBrowser.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isBrowser variable" -icon: "variable" -description: "isBrowser API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isBrowser - - -## Signature - -```typescript -isBrowser: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/isDragReady.mdx b/references/1.3.0/graphics-2d/graphics-2d/isDragReady.mdx deleted file mode 100644 index b11e6c9..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/isDragReady.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "isDragReady function" -icon: "function" -description: "isDragReady API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isDragReady - - -## Signature - -```typescript -isDragReady: () => boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - - -**Type**: boolean \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/isDragging.mdx b/references/1.3.0/graphics-2d/graphics-2d/isDragging.mdx deleted file mode 100644 index 1151186..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/isDragging.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "isDragging function" -icon: "function" -description: "isDragging API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isDragging - - -## Signature - -```typescript -isDragging: () => boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - - -**Type**: boolean \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/isTransforming.mdx b/references/1.3.0/graphics-2d/graphics-2d/isTransforming.mdx deleted file mode 100644 index a322c28..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/isTransforming.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "isTransforming function" -icon: "function" -description: "isTransforming API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isTransforming - - -## Signature - -```typescript -isTransforming: () => boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - - -**Type**: boolean \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/isUnminified.mdx b/references/1.3.0/graphics-2d/graphics-2d/isUnminified.mdx deleted file mode 100644 index 266cd83..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/isUnminified.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isUnminified variable" -icon: "variable" -description: "isUnminified API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isUnminified - - -## Signature - -```typescript -isUnminified: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/legacyTextRendering.mdx b/references/1.3.0/graphics-2d/graphics-2d/legacyTextRendering.mdx deleted file mode 100644 index c28b5ef..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/legacyTextRendering.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "legacyTextRendering variable" -icon: "variable" -description: "legacyTextRendering API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# legacyTextRendering - - -## Signature - -```typescript -legacyTextRendering: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/pixelRatio.mdx b/references/1.3.0/graphics-2d/graphics-2d/pixelRatio.mdx deleted file mode 100644 index 6739c18..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/pixelRatio.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "pixelRatio variable" -icon: "variable" -description: "pixelRatio API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# pixelRatio - - -## Signature - -```typescript -pixelRatio: number -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/pointerEventsEnabled.mdx b/references/1.3.0/graphics-2d/graphics-2d/pointerEventsEnabled.mdx deleted file mode 100644 index 960d0c6..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/pointerEventsEnabled.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "pointerEventsEnabled variable" -icon: "variable" -description: "pointerEventsEnabled API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# pointerEventsEnabled - - -## Signature - -```typescript -pointerEventsEnabled: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/releaseCanvasOnDestroy.mdx b/references/1.3.0/graphics-2d/graphics-2d/releaseCanvasOnDestroy.mdx deleted file mode 100644 index 1c8cd75..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/releaseCanvasOnDestroy.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "releaseCanvasOnDestroy variable" -icon: "variable" -description: "releaseCanvasOnDestroy API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# releaseCanvasOnDestroy - - -## Signature - -```typescript -releaseCanvasOnDestroy: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/shapes.mdx b/references/1.3.0/graphics-2d/graphics-2d/shapes.mdx deleted file mode 100644 index f86de84..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/shapes.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "shapes variable" -icon: "variable" -description: "shapes API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# shapes - - -## Signature - -```typescript -shapes: { - [key: string]: import("konva/lib/Shape").Shape; -} -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/showWarnings.mdx b/references/1.3.0/graphics-2d/graphics-2d/showWarnings.mdx deleted file mode 100644 index 8c2b970..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/showWarnings.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "showWarnings variable" -icon: "variable" -description: "showWarnings API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# showWarnings - - -## Signature - -```typescript -showWarnings: boolean -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/stages.mdx b/references/1.3.0/graphics-2d/graphics-2d/stages.mdx deleted file mode 100644 index 9f41ec1..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/stages.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "stages variable" -icon: "variable" -description: "stages API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# stages - - -## Signature - -```typescript -stages: import("konva/lib/Stage").Stage[] -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/graphics-2d/version.mdx b/references/1.3.0/graphics-2d/graphics-2d/version.mdx deleted file mode 100644 index be22895..0000000 --- a/references/1.3.0/graphics-2d/graphics-2d/version.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "version variable" -icon: "variable" -description: "version API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# version - - -## Signature - -```typescript -version: string -``` - - -## Parameters - - -*This function takes no parameters.* - - -## Returns - - -*This function has no return value.* \ No newline at end of file diff --git a/references/1.3.0/graphics-2d/index.mdx b/references/1.3.0/graphics-2d/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/graphics-2d/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/input/index.mdx b/references/1.3.0/input/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/input/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/input/input.mdx b/references/1.3.0/input/input.mdx deleted file mode 100644 index 782f56d..0000000 --- a/references/1.3.0/input/input.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "input package" -icon: "package" -description: "@nanoforge-dev/input API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/input -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/input/input/InputEnum.mdx b/references/1.3.0/input/input/InputEnum.mdx deleted file mode 100644 index 8981948..0000000 --- a/references/1.3.0/input/input/InputEnum.mdx +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: "InputEnum enum" -icon: "list" -description: "InputEnum API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InputEnum -## Members - -| Member | Description | -| ------ | ----------- | -| `AltLeft` | | -| `AltRight` | | -| `ArrowDown` | | -| `ArrowLeft` | | -| `ArrowRight` | | -| `ArrowUp` | | -| `AudioVolumeMute` | | -| `Back` | | -| `Backquote` | | -| `Backslash` | | -| `Backspace` | | -| `BracketLeft` | | -| `BracketRight` | | -| `BrowserBack` | | -| `BrowserFavorites` | | -| `BrowserForward` | | -| `BrowserHome` | | -| `BrowserRefresh` | | -| `BrowserSearch` | | -| `BrowserStop` | | -| `CapsLock` | | -| `Comma` | | -| `ContextMenu` | | -| `ControlLeft` | | -| `ControlRight` | | -| `Convert` | | -| `Delete` | | -| `Digit0` | | -| `Digit1` | | -| `Digit2` | | -| `Digit3` | | -| `Digit4` | | -| `Digit5` | | -| `Digit6` | | -| `Digit7` | | -| `Digit8` | | -| `Digit9` | | -| `End` | | -| `Enter` | | -| `Equal` | | -| `Escape` | | -| `F1` | | -| `F10` | | -| `F11` | | -| `F12` | | -| `F13` | | -| `F14` | | -| `F15` | | -| `F16` | | -| `F17` | | -| `F18` | | -| `F19` | | -| `F2` | | -| `F20` | | -| `F21` | | -| `F22` | | -| `F23` | | -| `F24` | | -| `F3` | | -| `F4` | | -| `F5` | | -| `F6` | | -| `F7` | | -| `F8` | | -| `F9` | | -| `Forward` | | -| `Home` | | -| `Insert` | | -| `IntlBackslash` | | -| `IntlRo` | | -| `IntlYen` | | -| `KanaMode` | | -| `KeyA` | | -| `KeyB` | | -| `KeyC` | | -| `KeyD` | | -| `KeyE` | | -| `KeyF` | | -| `KeyG` | | -| `KeyH` | | -| `KeyI` | | -| `KeyJ` | | -| `KeyK` | | -| `KeyL` | | -| `KeyM` | | -| `KeyN` | | -| `KeyO` | | -| `KeyP` | | -| `KeyQ` | | -| `KeyR` | | -| `KeyS` | | -| `KeyT` | | -| `KeyU` | | -| `KeyV` | | -| `KeyW` | | -| `KeyX` | | -| `KeyY` | | -| `KeyZ` | | -| `Lang1` | | -| `Lang2` | | -| `LaunchApp1` | | -| `LaunchApp2` | | -| `LaunchMail` | | -| `MediaPlayPause` | | -| `MediaStop` | | -| `MediaTrackNext` | | -| `MediaTrackPrevious` | | -| `MetaLeft` | | -| `MetaRight` | | -| `Minus` | | -| `MouseLeft` | | -| `MouseMiddle` | | -| `MouseRight` | | -| `NonConvert` | | -| `NumLock` | | -| `Numpad0` | | -| `Numpad1` | | -| `Numpad2` | | -| `Numpad3` | | -| `Numpad4` | | -| `Numpad5` | | -| `Numpad6` | | -| `Numpad7` | | -| `Numpad8` | | -| `Numpad9` | | -| `NumpadAdd` | | -| `NumpadComma` | | -| `NumpadDecimal` | | -| `NumpadDivide` | | -| `NumpadEnter` | | -| `NumpadEqual` | | -| `NumpadMultiply` | | -| `NumpadSubtract` | | -| `PageDown` | | -| `PageUp` | | -| `Pause` | | -| `Period` | | -| `Power` | | -| `PrintScreen` | | -| `Quote` | | -| `ScrollLock` | | -| `Semicolon` | | -| `ShiftLeft` | | -| `ShiftRight` | | -| `Slash` | | -| `Space` | | -| `Tab` | | \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary.mdx b/references/1.3.0/input/input/InputLibrary.mdx deleted file mode 100644 index 43bcb1a..0000000 --- a/references/1.3.0/input/input/InputLibrary.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: "InputLibrary class" -icon: "box" -description: "InputLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InputLibrary -## Signature - -```typescript -declare class InputLibrary extends BaseInputLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -## Methods - -### __init - - - -### __run - - - -### getDragState - - - -### getMousePosition - - - -### getMouseState - - - -### getPressedKeys - - - -### getWheelState - - - -### isDragging - - - -### isKeyPressed - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/__init.mdx b/references/1.3.0/input/input/InputLibrary/__init.mdx deleted file mode 100644 index 1f9a89f..0000000 --- a/references/1.3.0/input/input/InputLibrary/__init.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/__name.mdx b/references/1.3.0/input/input/InputLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/input/input/InputLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/__run.mdx b/references/1.3.0/input/input/InputLibrary/__run.mdx deleted file mode 100644 index a467ed8..0000000 --- a/references/1.3.0/input/input/InputLibrary/__run.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "__run" -icon: "function" -description: "__run API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __run -## Signature - -```typescript -__run(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/constructor.mdx b/references/1.3.0/input/input/InputLibrary/constructor.mdx deleted file mode 100644 index 93df30b..0000000 --- a/references/1.3.0/input/input/InputLibrary/constructor.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the InputLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `InputLibrary` class -## Signature - -```typescript -constructor(); -``` - -*This constructor takes no parameters.* \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/getDragState.mdx b/references/1.3.0/input/input/InputLibrary/getDragState.mdx deleted file mode 100644 index e8459d8..0000000 --- a/references/1.3.0/input/input/InputLibrary/getDragState.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getDragState" -icon: "function" -description: "getDragState API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getDragState -## Signature - -```typescript -getDragState(): DragState; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`DragState` \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/getMousePosition.mdx b/references/1.3.0/input/input/InputLibrary/getMousePosition.mdx deleted file mode 100644 index 426452b..0000000 --- a/references/1.3.0/input/input/InputLibrary/getMousePosition.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getMousePosition" -icon: "function" -description: "getMousePosition API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMousePosition -## Signature - -```typescript -getMousePosition(): { - x: number; - y: number; - }; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**: - -```typescript -{ - x: number; - y: number; - } -``` \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/getMouseState.mdx b/references/1.3.0/input/input/InputLibrary/getMouseState.mdx deleted file mode 100644 index d7dd55d..0000000 --- a/references/1.3.0/input/input/InputLibrary/getMouseState.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getMouseState" -icon: "function" -description: "getMouseState API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMouseState -## Signature - -```typescript -getMouseState(): MouseState; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`MouseState` \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/getPressedKeys.mdx b/references/1.3.0/input/input/InputLibrary/getPressedKeys.mdx deleted file mode 100644 index bacc349..0000000 --- a/references/1.3.0/input/input/InputLibrary/getPressedKeys.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getPressedKeys" -icon: "function" -description: "getPressedKeys API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getPressedKeys -## Signature - -```typescript -getPressedKeys(): InputEnum[]; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`InputEnum[]` \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/getWheelState.mdx b/references/1.3.0/input/input/InputLibrary/getWheelState.mdx deleted file mode 100644 index 7ebf0c2..0000000 --- a/references/1.3.0/input/input/InputLibrary/getWheelState.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "getWheelState" -icon: "function" -description: "getWheelState API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getWheelState -## Signature - -```typescript -getWheelState(): WheelState; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`WheelState` \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/isDragging.mdx b/references/1.3.0/input/input/InputLibrary/isDragging.mdx deleted file mode 100644 index 1b8671b..0000000 --- a/references/1.3.0/input/input/InputLibrary/isDragging.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "isDragging" -icon: "function" -description: "isDragging API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isDragging -## Signature - -```typescript -isDragging(button?: InputEnum): boolean; -``` - -## Parameters - -### button -**Type**:`InputEnum` -**Optional**: Yes - - - -## Returns - -**Type**:`boolean` \ No newline at end of file diff --git a/references/1.3.0/input/input/InputLibrary/isKeyPressed.mdx b/references/1.3.0/input/input/InputLibrary/isKeyPressed.mdx deleted file mode 100644 index af68bfc..0000000 --- a/references/1.3.0/input/input/InputLibrary/isKeyPressed.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "isKeyPressed" -icon: "function" -description: "isKeyPressed API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isKeyPressed -## Signature - -```typescript -isKeyPressed(key: InputEnum): boolean | undefined; -``` - -## Parameters - -### key -**Type**:`InputEnum` - - - -## Returns - -**Type**:`boolean | undefined` \ No newline at end of file diff --git a/references/1.3.0/music/index.mdx b/references/1.3.0/music/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/music/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/music/music.mdx b/references/1.3.0/music/music.mdx deleted file mode 100644 index b541638..0000000 --- a/references/1.3.0/music/music.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "music package" -icon: "package" -description: "@nanoforge-dev/music API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/music -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/music/music/MusicLibrary.mdx b/references/1.3.0/music/music/MusicLibrary.mdx deleted file mode 100644 index 98b28c8..0000000 --- a/references/1.3.0/music/music/MusicLibrary.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "MusicLibrary class" -icon: "box" -description: "MusicLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# MusicLibrary -## Signature - -```typescript -declare class MusicLibrary extends BaseMusicLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -## Methods - -### __init - - - -### load - - - -### mute - - - -### play - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/music/music/MusicLibrary/__init.mdx b/references/1.3.0/music/music/MusicLibrary/__init.mdx deleted file mode 100644 index 1f9a89f..0000000 --- a/references/1.3.0/music/music/MusicLibrary/__init.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/music/music/MusicLibrary/__name.mdx b/references/1.3.0/music/music/MusicLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/music/music/MusicLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/music/music/MusicLibrary/load.mdx b/references/1.3.0/music/music/MusicLibrary/load.mdx deleted file mode 100644 index bf37364..0000000 --- a/references/1.3.0/music/music/MusicLibrary/load.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "load" -icon: "function" -description: "load API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# load -## Signature - -```typescript -load(music: string, file: string): void; -``` - -## Parameters - -### music -**Type**:`string` - - - -### file -**Type**:`string` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/music/music/MusicLibrary/mute.mdx b/references/1.3.0/music/music/MusicLibrary/mute.mdx deleted file mode 100644 index 24cdc4f..0000000 --- a/references/1.3.0/music/music/MusicLibrary/mute.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "mute API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute -## Signature - -```typescript -mute(): void; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/music/music/MusicLibrary/play.mdx b/references/1.3.0/music/music/MusicLibrary/play.mdx deleted file mode 100644 index 7c28b5e..0000000 --- a/references/1.3.0/music/music/MusicLibrary/play.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "play" -icon: "function" -description: "play API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play -## Signature - -```typescript -play(music: string): void; -``` - -## Parameters - -### music -**Type**:`string` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/network-client/index.mdx b/references/1.3.0/network-client/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/network-client/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client.mdx b/references/1.3.0/network-client/network-client.mdx deleted file mode 100644 index a69bdc5..0000000 --- a/references/1.3.0/network-client/network-client.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "network-client package" -icon: "package" -description: "@nanoforge-dev/network-client API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/network-client -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/NetworkClientLibrary.mdx b/references/1.3.0/network-client/network-client/NetworkClientLibrary.mdx deleted file mode 100644 index ad45c8d..0000000 --- a/references/1.3.0/network-client/network-client/NetworkClientLibrary.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "NetworkClientLibrary class" -icon: "box" -description: "NetworkClientLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NetworkClientLibrary -## Signature - -```typescript -declare class NetworkClientLibrary extends BaseNetworkLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -### tcp -**Type**:`tcp: TCPClient;` -**Default**: `` - - - -### udp -**Type**:`udp: UDPClient;` -**Default**: `` - - - -## Methods - -### __init - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/NetworkClientLibrary/__init.mdx b/references/1.3.0/network-client/network-client/NetworkClientLibrary/__init.mdx deleted file mode 100644 index 2a476bf..0000000 --- a/references/1.3.0/network-client/network-client/NetworkClientLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/NetworkClientLibrary/__name.mdx b/references/1.3.0/network-client/network-client/NetworkClientLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/network-client/network-client/NetworkClientLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/NetworkClientLibrary/tcp.mdx b/references/1.3.0/network-client/network-client/NetworkClientLibrary/tcp.mdx deleted file mode 100644 index c5a2f4d..0000000 --- a/references/1.3.0/network-client/network-client/NetworkClientLibrary/tcp.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "tcp" -icon: "variable" -description: "tcp API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# tcp - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/NetworkClientLibrary/udp.mdx b/references/1.3.0/network-client/network-client/NetworkClientLibrary/udp.mdx deleted file mode 100644 index f7ca392..0000000 --- a/references/1.3.0/network-client/network-client/NetworkClientLibrary/udp.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "udp" -icon: "variable" -description: "udp API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# udp - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/TCPClient.mdx b/references/1.3.0/network-client/network-client/TCPClient.mdx deleted file mode 100644 index 332c830..0000000 --- a/references/1.3.0/network-client/network-client/TCPClient.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "TCPClient class" -icon: "box" -description: "TCPClient Reliable ordered send/receive of packets to a TCP server" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TCPClient - -## Summary - -TCPClient Reliable ordered send/receive of packets to a TCP server -## Signature - -```typescript -declare class TCPClient -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -*No properties defined.* - -## Methods - -### connect - -Initiate a WebSocket connection to the server (e.g. ). - -### getReceivedPackets - -Return an array of complete packets that were reassembled from received chunks. - -### isConnected - -Return when the underlying WebSocket is open. - -### sendData - -Send a payload to the server. - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/TCPClient/connect.mdx b/references/1.3.0/network-client/network-client/TCPClient/connect.mdx deleted file mode 100644 index 7f45227..0000000 --- a/references/1.3.0/network-client/network-client/TCPClient/connect.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "connect" -icon: "function" -description: "Initiate a WebSocket connection to the server (e.g. ws://<ip>:<port>)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# connect - -## Summary - -Initiate a WebSocket connection to the server (e.g. `ws://:`). -## Signature - -```typescript -connect(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` - -Initiate a WebSocket connection to the server (e.g. ). \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/TCPClient/constructor.mdx b/references/1.3.0/network-client/network-client/TCPClient/constructor.mdx deleted file mode 100644 index f12435d..0000000 --- a/references/1.3.0/network-client/network-client/TCPClient/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the TCPClient class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `TCPClient` class -## Signature - -```typescript -constructor(_port: number, _ip: string, magicValue: string, _wss: boolean); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _ip -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _wss -- **Type**:`boolean` \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/TCPClient/getReceivedPackets.mdx b/references/1.3.0/network-client/network-client/TCPClient/getReceivedPackets.mdx deleted file mode 100644 index 8537095..0000000 --- a/references/1.3.0/network-client/network-client/TCPClient/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Return an array of complete packets that were reassembled from received chunks." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Return an array of complete packets that were reassembled from received chunks. -## Signature - -```typescript -getReceivedPackets(): Uint8Array[]; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Uint8Array[]` - -Return an array of complete packets that were reassembled from received chunks. \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/TCPClient/isConnected.mdx b/references/1.3.0/network-client/network-client/TCPClient/isConnected.mdx deleted file mode 100644 index b979c0a..0000000 --- a/references/1.3.0/network-client/network-client/TCPClient/isConnected.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isConnected" -icon: "function" -description: "Return true when the underlying WebSocket is open." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isConnected - -## Summary - -Return `true` when the underlying WebSocket is open. -## Signature - -```typescript -isConnected(): boolean; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`boolean` - -Return when the underlying WebSocket is open. \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/TCPClient/sendData.mdx b/references/1.3.0/network-client/network-client/TCPClient/sendData.mdx deleted file mode 100644 index a8e419a..0000000 --- a/references/1.3.0/network-client/network-client/TCPClient/sendData.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendData" -icon: "function" -description: "Send a payload to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendData - -## Summary - -Send a payload to the server. -## Signature - -```typescript -sendData(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Uint8Array — raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to the server. \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/UDPClient.mdx b/references/1.3.0/network-client/network-client/UDPClient.mdx deleted file mode 100644 index 45df3fb..0000000 --- a/references/1.3.0/network-client/network-client/UDPClient.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "UDPClient class" -icon: "box" -description: "UDPClient Fast but less reliable send/receive of packets to a UDP server" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# UDPClient - -## Summary - -UDPClient Fast but less reliable send/receive of packets to a UDP server -## Signature - -```typescript -declare class UDPClient -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -*No properties defined.* - -## Methods - -### connect - -Open a WebSocket for signaling, create an RTCPeerConnection and initiate an SDP offer. - -### getReceivedPackets - -Return an array of complete packets reassembled from received data-channel chunks. - -### isConnected - -Return when the RTCDataChannel is open. - -### sendData - -Send a payload on the data channel. - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/UDPClient/connect.mdx b/references/1.3.0/network-client/network-client/UDPClient/connect.mdx deleted file mode 100644 index 0b33875..0000000 --- a/references/1.3.0/network-client/network-client/UDPClient/connect.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "connect" -icon: "function" -description: "Open a WebSocket for signaling, create an RTCPeerConnection and initiate an SDP offer." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# connect - -## Summary - -Open a WebSocket for signaling, create an RTCPeerConnection and initiate an SDP offer. -## Signature - -```typescript -connect(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` - -Open a WebSocket for signaling, create an RTCPeerConnection and initiate an SDP offer. \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/UDPClient/constructor.mdx b/references/1.3.0/network-client/network-client/UDPClient/constructor.mdx deleted file mode 100644 index 8009fa3..0000000 --- a/references/1.3.0/network-client/network-client/UDPClient/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the UDPClient class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `UDPClient` class -## Signature - -```typescript -constructor(_port: number, _ip: string, magicValue: string, _wss: boolean); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _ip -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _wss -- **Type**:`boolean` \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/UDPClient/getReceivedPackets.mdx b/references/1.3.0/network-client/network-client/UDPClient/getReceivedPackets.mdx deleted file mode 100644 index 379fbe8..0000000 --- a/references/1.3.0/network-client/network-client/UDPClient/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Return an array of complete packets reassembled from received data-channel chunks." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Return an array of complete packets reassembled from received data-channel chunks. -## Signature - -```typescript -getReceivedPackets(): Uint8Array[]; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Uint8Array[]` - -Return an array of complete packets reassembled from received data-channel chunks. \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/UDPClient/isConnected.mdx b/references/1.3.0/network-client/network-client/UDPClient/isConnected.mdx deleted file mode 100644 index 9454960..0000000 --- a/references/1.3.0/network-client/network-client/UDPClient/isConnected.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isConnected" -icon: "function" -description: "Return true when the RTCDataChannel is open." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isConnected - -## Summary - -Return `true` when the RTCDataChannel is open. -## Signature - -```typescript -isConnected(): boolean; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`boolean` - -Return when the RTCDataChannel is open. \ No newline at end of file diff --git a/references/1.3.0/network-client/network-client/UDPClient/sendData.mdx b/references/1.3.0/network-client/network-client/UDPClient/sendData.mdx deleted file mode 100644 index a452c3f..0000000 --- a/references/1.3.0/network-client/network-client/UDPClient/sendData.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendData" -icon: "function" -description: "Send a payload on the data channel." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendData - -## Summary - -Send a payload on the data channel. -## Signature - -```typescript -sendData(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Uint8Array — raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload on the data channel. \ No newline at end of file diff --git a/references/1.3.0/network-server/index.mdx b/references/1.3.0/network-server/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/network-server/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server.mdx b/references/1.3.0/network-server/network-server.mdx deleted file mode 100644 index a7d6686..0000000 --- a/references/1.3.0/network-server/network-server.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "network-server package" -icon: "package" -description: "@nanoforge-dev/network-server API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/network-server -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/NetworkServerLibrary.mdx b/references/1.3.0/network-server/network-server/NetworkServerLibrary.mdx deleted file mode 100644 index ff675a6..0000000 --- a/references/1.3.0/network-server/network-server/NetworkServerLibrary.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "NetworkServerLibrary class" -icon: "box" -description: "NetworkServerLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NetworkServerLibrary -## Signature - -```typescript -declare class NetworkServerLibrary extends BaseNetworkLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -### tcp -**Type**:`tcp: TCPServer;` -**Default**: `` - - - -### udp -**Type**:`udp: UDPServer;` -**Default**: `` - - - -## Methods - -### __init - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/NetworkServerLibrary/__init.mdx b/references/1.3.0/network-server/network-server/NetworkServerLibrary/__init.mdx deleted file mode 100644 index 2a476bf..0000000 --- a/references/1.3.0/network-server/network-server/NetworkServerLibrary/__init.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(context: InitContext): Promise; -``` - -## Parameters - -### context -**Type**:`InitContext` - - - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/NetworkServerLibrary/__name.mdx b/references/1.3.0/network-server/network-server/NetworkServerLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/network-server/network-server/NetworkServerLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/NetworkServerLibrary/tcp.mdx b/references/1.3.0/network-server/network-server/NetworkServerLibrary/tcp.mdx deleted file mode 100644 index c5a2f4d..0000000 --- a/references/1.3.0/network-server/network-server/NetworkServerLibrary/tcp.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "tcp" -icon: "variable" -description: "tcp API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# tcp - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/NetworkServerLibrary/udp.mdx b/references/1.3.0/network-server/network-server/NetworkServerLibrary/udp.mdx deleted file mode 100644 index f7ca392..0000000 --- a/references/1.3.0/network-server/network-server/NetworkServerLibrary/udp.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "udp" -icon: "variable" -description: "udp API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# udp - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/TCPServer.mdx b/references/1.3.0/network-server/network-server/TCPServer.mdx deleted file mode 100644 index 9e83e5b..0000000 --- a/references/1.3.0/network-server/network-server/TCPServer.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "TCPServer class" -icon: "box" -description: "TCPServer Reliable ordered send/receive of packets to multiple TCP clients" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TCPServer - -## Summary - -TCPServer Reliable ordered send/receive of packets to multiple TCP clients -## Signature - -```typescript -declare class TCPServer -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -*No properties defined.* - -## Methods - -### getConnectedClients - -Return a snapshot array of numeric client IDs currently connected. - -### getReceivedPackets - -Parse and return complete packets received from each client. Each packet is a buffer. - -### listen - -Start the WebSocket server and begin accepting clients. - -### sendToClient - -Send a payload to the client identified by . - -### sendToEverybody - -Send a payload to every connected client. - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/TCPServer/constructor.mdx b/references/1.3.0/network-server/network-server/TCPServer/constructor.mdx deleted file mode 100644 index 34a13cb..0000000 --- a/references/1.3.0/network-server/network-server/TCPServer/constructor.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the TCPServer class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `TCPServer` class -## Signature - -```typescript -constructor(_port: number, _host: string, magicValue: string, _cert?: string | undefined, _key?: string | undefined); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _host -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _cert -- **Type**:`string | undefined` -- **Optional**: Yes - - - -### _key -- **Type**:`string | undefined` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/TCPServer/getConnectedClients.mdx b/references/1.3.0/network-server/network-server/TCPServer/getConnectedClients.mdx deleted file mode 100644 index ea5a97b..0000000 --- a/references/1.3.0/network-server/network-server/TCPServer/getConnectedClients.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getConnectedClients" -icon: "function" -description: "Return a snapshot array of numeric client IDs currently connected." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConnectedClients - -## Summary - -Return a snapshot array of numeric client IDs currently connected. -## Signature - -```typescript -getConnectedClients(): number[]; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`number[]` - -Return a snapshot array of numeric client IDs currently connected. \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/TCPServer/getReceivedPackets.mdx b/references/1.3.0/network-server/network-server/TCPServer/getReceivedPackets.mdx deleted file mode 100644 index d3b68b6..0000000 --- a/references/1.3.0/network-server/network-server/TCPServer/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return complete packets received from each client. Each packet is a Uint8Array buffer." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return complete packets received from each client. Each packet is a `Uint8Array` buffer. -## Signature - -```typescript -getReceivedPackets(): Map; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Map` - -Parse and return complete packets received from each client. Each packet is a buffer. \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/TCPServer/listen.mdx b/references/1.3.0/network-server/network-server/TCPServer/listen.mdx deleted file mode 100644 index fc56f4e..0000000 --- a/references/1.3.0/network-server/network-server/TCPServer/listen.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "listen" -icon: "function" -description: "Start the WebSocket server and begin accepting clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# listen - -## Summary - -Start the WebSocket server and begin accepting clients. -## Signature - -```typescript -listen(): void; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`void` - -Start the WebSocket server and begin accepting clients. \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/TCPServer/sendToClient.mdx b/references/1.3.0/network-server/network-server/TCPServer/sendToClient.mdx deleted file mode 100644 index 7bef494..0000000 --- a/references/1.3.0/network-server/network-server/TCPServer/sendToClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "sendToClient" -icon: "function" -description: "Send a payload to the client identified by clientId." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToClient - -## Summary - -Send a payload to the client identified by `clientId`. -## Signature - -```typescript -sendToClient(clientId: number, data: Uint8Array): void; -``` - -## Parameters - -### clientId -**Type**:`number` - -number — numeric client identifier. - -### data -**Type**:`Uint8Array` - -Uint8Array — payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to the client identified by . \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/TCPServer/sendToEverybody.mdx b/references/1.3.0/network-server/network-server/TCPServer/sendToEverybody.mdx deleted file mode 100644 index f2b2d58..0000000 --- a/references/1.3.0/network-server/network-server/TCPServer/sendToEverybody.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendToEverybody" -icon: "function" -description: "Send a payload to every connected client." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToEverybody - -## Summary - -Send a payload to every connected client. -## Signature - -```typescript -sendToEverybody(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Uint8Array — raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to every connected client. \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/UDPServer.mdx b/references/1.3.0/network-server/network-server/UDPServer.mdx deleted file mode 100644 index 76fc41f..0000000 --- a/references/1.3.0/network-server/network-server/UDPServer.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "UDPServer class" -icon: "box" -description: "UDPServer Fast but less reliable unordered send/receive to multiple UDP clients" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# UDPServer - -## Summary - -UDPServer Fast but less reliable unordered send/receive to multiple UDP clients -## Signature - -```typescript -declare class UDPServer -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -*No properties defined.* - -## Methods - -### getConnectedClients - -Return a snapshot array of client IDs with active data channels. - -### getReceivedPackets - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. - -### listen - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). - -### sendToClient - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. - -### sendToEverybody - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/UDPServer/constructor.mdx b/references/1.3.0/network-server/network-server/UDPServer/constructor.mdx deleted file mode 100644 index 8cb0274..0000000 --- a/references/1.3.0/network-server/network-server/UDPServer/constructor.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the UDPServer class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `UDPServer` class -## Signature - -```typescript -constructor(_port: number, _host: string, magicValue: string, _cert?: string | undefined, _key?: string | undefined); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _host -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _cert -- **Type**:`string | undefined` -- **Optional**: Yes - - - -### _key -- **Type**:`string | undefined` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/UDPServer/getConnectedClients.mdx b/references/1.3.0/network-server/network-server/UDPServer/getConnectedClients.mdx deleted file mode 100644 index df0eee7..0000000 --- a/references/1.3.0/network-server/network-server/UDPServer/getConnectedClients.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getConnectedClients" -icon: "function" -description: "Return a snapshot array of client IDs with active data channels." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConnectedClients - -## Summary - -Return a snapshot array of client IDs with active data channels. -## Signature - -```typescript -getConnectedClients(): number[]; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`number[]` - -Return a snapshot array of client IDs with active data channels. \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/UDPServer/getReceivedPackets.mdx b/references/1.3.0/network-server/network-server/UDPServer/getReceivedPackets.mdx deleted file mode 100644 index 4bdffe0..0000000 --- a/references/1.3.0/network-server/network-server/UDPServer/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Reassemble buffered chunks and return a map of clientId => complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. -## Signature - -```typescript -getReceivedPackets(): Map; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Map` - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/UDPServer/listen.mdx b/references/1.3.0/network-server/network-server/UDPServer/listen.mdx deleted file mode 100644 index 0c604a1..0000000 --- a/references/1.3.0/network-server/network-server/UDPServer/listen.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "listen" -icon: "function" -description: "Start the signaling WebSocket and accept incoming client offers (SDP/ICE)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# listen - -## Summary - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). -## Signature - -```typescript -listen(): void; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`void` - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/UDPServer/sendToClient.mdx b/references/1.3.0/network-server/network-server/UDPServer/sendToClient.mdx deleted file mode 100644 index 2443a80..0000000 --- a/references/1.3.0/network-server/network-server/UDPServer/sendToClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "sendToClient" -icon: "function" -description: "Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToClient - -## Summary - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. -## Signature - -```typescript -sendToClient(clientId: number, data: Uint8Array): void; -``` - -## Parameters - -### clientId -**Type**:`number` - -Numeric client identifier returned by events - -### data -**Type**:`Uint8Array` - -Raw packet bytes (Uint8Array) to send - -## Returns - -**Type**:`void` - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. \ No newline at end of file diff --git a/references/1.3.0/network-server/network-server/UDPServer/sendToEverybody.mdx b/references/1.3.0/network-server/network-server/UDPServer/sendToEverybody.mdx deleted file mode 100644 index 7a0489c..0000000 --- a/references/1.3.0/network-server/network-server/UDPServer/sendToEverybody.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendToEverybody" -icon: "function" -description: "Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToEverybody - -## Summary - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. -## Signature - -```typescript -sendToEverybody(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw packet bytes (Uint8Array) to send to every client - -## Returns - -**Type**:`void` - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. \ No newline at end of file diff --git a/references/1.3.0/sound/index.mdx b/references/1.3.0/sound/index.mdx deleted file mode 100644 index d5954de..0000000 --- a/references/1.3.0/sound/index.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "API Reference" -icon: "book" -description: "(model) API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# (model) -## API Model - -This is the root API model documentation. \ No newline at end of file diff --git a/references/1.3.0/sound/sound.mdx b/references/1.3.0/sound/sound.mdx deleted file mode 100644 index 1702c40..0000000 --- a/references/1.3.0/sound/sound.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "sound package" -icon: "package" -description: "@nanoforge-dev/sound API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# @nanoforge-dev/sound -## Abstract Classes - - -*No abstract classes defined.* - - -## Classes - - -*No classes defined.* - - -## Enumerations - - -*No enumerations defined.* - - -## Functions - - -*No functions defined.* - - -## Interfaces - - -*No interfaces defined.* - - -## Namespaces - - -*No namespaces defined.* - - -## Type Aliases - - -*No type aliases defined.* - - -## Variables - - -*No variables defined.* \ No newline at end of file diff --git a/references/1.3.0/sound/sound/SoundLibrary.mdx b/references/1.3.0/sound/sound/SoundLibrary.mdx deleted file mode 100644 index bcdce32..0000000 --- a/references/1.3.0/sound/sound/SoundLibrary.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "SoundLibrary class" -icon: "box" -description: "SoundLibrary API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SoundLibrary -## Signature - -```typescript -declare class SoundLibrary extends BaseSoundLibrary -``` - -## Constructors - -*No constructors defined.* - -## Properties - -### __name -**Modifiers**: readonly -**Type**:`get __name(): string;` -**Default**: `` - - - -## Methods - -### __init - - - -### load - - - -### mute - - - -### play - - - -## Events - -*No events defined.* \ No newline at end of file diff --git a/references/1.3.0/sound/sound/SoundLibrary/__init.mdx b/references/1.3.0/sound/sound/SoundLibrary/__init.mdx deleted file mode 100644 index 1f9a89f..0000000 --- a/references/1.3.0/sound/sound/SoundLibrary/__init.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "__init" -icon: "function" -description: "__init API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __init -## Signature - -```typescript -__init(): Promise; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`Promise` \ No newline at end of file diff --git a/references/1.3.0/sound/sound/SoundLibrary/__name.mdx b/references/1.3.0/sound/sound/SoundLibrary/__name.mdx deleted file mode 100644 index 10196af..0000000 --- a/references/1.3.0/sound/sound/SoundLibrary/__name.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "__name" -icon: "variable" -description: "__name API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# __name - -*Type information not available.* \ No newline at end of file diff --git a/references/1.3.0/sound/sound/SoundLibrary/load.mdx b/references/1.3.0/sound/sound/SoundLibrary/load.mdx deleted file mode 100644 index 70cd394..0000000 --- a/references/1.3.0/sound/sound/SoundLibrary/load.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "load" -icon: "function" -description: "load API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# load -## Signature - -```typescript -load(sound: string, file: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - - - -### file -**Type**:`string` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/sound/sound/SoundLibrary/mute.mdx b/references/1.3.0/sound/sound/SoundLibrary/mute.mdx deleted file mode 100644 index 24cdc4f..0000000 --- a/references/1.3.0/sound/sound/SoundLibrary/mute.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "mute API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute -## Signature - -```typescript -mute(): void; -``` - -## Parameters - -*This method takes no parameters.* - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.3.0/sound/sound/SoundLibrary/play.mdx b/references/1.3.0/sound/sound/SoundLibrary/play.mdx deleted file mode 100644 index 921a21e..0000000 --- a/references/1.3.0/sound/sound/SoundLibrary/play.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "play" -icon: "function" -description: "play API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play -## Signature - -```typescript -play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.0/.tsdocs/client/ValidRefs.js b/references/1.4.0/.tsdocs/client/ValidRefs.js deleted file mode 100644 index e1205f1..0000000 --- a/references/1.4.0/.tsdocs/client/ValidRefs.js +++ /dev/null @@ -1,29 +0,0 @@ -// @ts-nocheck -/** - * Valid API Reference IDs - * Auto-generated by mint-tsdocs during documentation build. - * Used by RefLink component for runtime validation. - * - * @generated - */ - -// Expose VALID_REFS on window for use by RefLink component -// This avoids ES6 module import issues with .jsx MIME types -if (typeof window !== 'undefined') { - window.VALID_REFS = new Set([ - "core-editor", - "core-editor.CoreEvents", - "core-editor.EditorEvents", - "core-editor.EventEmitter", - "core-editor.EventEmitter.constructor", - "core-editor.EventEmitter.emit", - "core-editor.EventEmitter.on", - "core-editor.EventEmitter.runEvents", - "core-editor.NanoforgeClient", - "core-editor.NanoforgeClient.useGraphics", - "core-editor.NanoforgeClient.useInput", - "core-editor.NanoforgeClient.useSound", - "core-editor.NanoforgeFactory", - "core-editor.NanoforgeServer" -]); -} diff --git a/references/1.4.0/.tsdocs/client/tsdocs-config.js b/references/1.4.0/.tsdocs/client/tsdocs-config.js deleted file mode 100644 index dcea992..0000000 --- a/references/1.4.0/.tsdocs/client/tsdocs-config.js +++ /dev/null @@ -1,28 +0,0 @@ -/** - * TSDocs Runtime Configuration - * Auto-generated by mint-tsdocs during documentation build. - * Loaded globally as a custom script for all documentation pages. - * - * This provides runtime configuration to TSDocs components (RefLink, PageLink, etc.) - * without requiring imports between snippet files. - * - * @generated - */ -(function() { - 'use strict'; - - // Global TSDocs configuration accessible to all components - window.TSDOCS_CONFIG = { - basePath: "/core-editor", - packageName: "core-editor", - generatedAt: "2026-07-01T15:55:51.205Z" - }; - - // Helper function to generate absolute path for an API reference - window.getRefPath = function(refId) { - var segments = refId.split('.').filter(function(s) { return s.length > 0; }); - return segments.length > 0 - ? window.TSDOCS_CONFIG.basePath + '/' + segments.join('/') - : window.TSDOCS_CONFIG.basePath; - }; -})(); diff --git a/references/1.4.0/.tsdocs/client/tsdocs-styles.css b/references/1.4.0/.tsdocs/client/tsdocs-styles.css deleted file mode 100644 index 0541fd9..0000000 --- a/references/1.4.0/.tsdocs/client/tsdocs-styles.css +++ /dev/null @@ -1,65 +0,0 @@ -/** - * TSDocs Default Styles - * Auto-generated by mint-tsdocs during documentation generation - * - * To override any style, add more specific selectors in docs/style.css: - * - * Example: - * .prose .tsdocs-reflink.broken-link { - * border-bottom: 3px solid orange !important; - * } - */ - -/* ============================================================================ - * Broken Link Indicators - * ============================================================================ - * Used by RefLink and PageLink components to highlight invalid references - */ - -/* RefLink broken links */ -.prose .tsdocs-reflink.broken-link { - border-bottom: 2px dotted #ef4444 !important; - color: #ef4444 !important; - text-decoration: wavy underline !important; -} - -/* PageLink broken links */ -.prose .tsdocs-pagelink.broken-link { - border-bottom: 2px dotted #ef4444 !important; - color: #ef4444 !important; - text-decoration: wavy underline !important; -} - -/* Dark mode variants */ -.dark .prose .tsdocs-reflink.broken-link { - border-bottom-color: #f87171 !important; - color: #f87171 !important; -} - -.dark .prose .tsdocs-pagelink.broken-link { - border-bottom-color: #f87171 !important; - color: #f87171 !important; -} - -/* ============================================================================ - * TypeTree Component Styles - * ============================================================================ - * Currently uses Mintlify's native ResponseField and Expandable components - * Use this selector for custom TypeTree styling: - * [data-component="tsdocs-typetree"] { } - */ - -/* ============================================================================ - * Preview Component Styles - * ============================================================================ - * Wrapper for code examples and previews - * Use this selector for custom Preview styling: - * [data-component="tsdocs-preview"] { } - */ - -/* ============================================================================ - * Feature Component Styles - * ============================================================================ - * The Feature component now uses Tailwind CSS classes directly. - * No custom styles needed - matches Mintlify Card component styling. - */ diff --git a/references/1.4.0/.tsdocs/global.d.ts b/references/1.4.0/.tsdocs/global.d.ts deleted file mode 100644 index 7284151..0000000 --- a/references/1.4.0/.tsdocs/global.d.ts +++ /dev/null @@ -1,145 +0,0 @@ -/** - * Global type declarations for mint-tsdocs - * Auto-generated during documentation build. - * - * This file provides: - * - Mintlify component type declarations (ResponseField, Expandable) - * - Window object augmentations for runtime scripts - * - Type-safe ValidRefId and ValidPageId unions - * - * @generated - */ - -// ============================================================================ -// Mintlify Component Declarations -// ============================================================================ - -/** - * Global type declarations for Mintlify components. - * These components are provided by Mintlify at runtime. - */ -declare namespace JSX { - interface IntrinsicElements { - ResponseField: any; - Expandable: any; - } -} - -// Also declare as global React components -declare const ResponseField: React.FC; -declare const Expandable: React.FC; - -// ============================================================================ -// ValidRefs Types -// ============================================================================ - -/** - * Union type of all valid API reference IDs - * - * Generated from the API model structure during documentation build. - * Used by RefLink component for type-safe reference validation. - */ -export type ValidRefId = - | "core-editor" - | "core-editor.CoreEvents" - | "core-editor.EditorEvents" - | "core-editor.EventEmitter" - | "core-editor.EventEmitter.constructor" - | "core-editor.EventEmitter.emit" - | "core-editor.EventEmitter.on" - | "core-editor.EventEmitter.runEvents" - | "core-editor.NanoforgeClient" - | "core-editor.NanoforgeClient.useGraphics" - | "core-editor.NanoforgeClient.useInput" - | "core-editor.NanoforgeClient.useSound" - | "core-editor.NanoforgeFactory" - | "core-editor.NanoforgeServer"; - -/** - * Check if a RefId is valid - * - * @param refId - The reference ID to check - * @returns True if the refId is valid - */ -export function isValidRef(refId: string): refId is ValidRefId; - -// ============================================================================ -// ValidPages Types -// ============================================================================ - -/** - * Union type of all valid page IDs from docs.json - * - * Generated from docs.json navigation structure during documentation build. - * Used by PageLink component for type-safe page validation. - */ -export type ValidPageId = - never; - -/** - * Check if a PageId is valid - * - * @param pageId - The page ID to check - * @returns True if the pageId is valid - */ -export function isValidPage(pageId: string): pageId is ValidPageId; - -// ============================================================================ -// TsdocsConfig Types -// ============================================================================ - -/** - * Runtime configuration for TSDocs components - * - * Available via window.TSDOCS_CONFIG after tsdocs-config.js loads. - */ -export interface TsdocsConfig { - /** Base path for API reference pages (e.g., "/reference") */ - basePath: string; - - /** Package name */ - packageName: string; - - /** Generated timestamp (ISO 8601) */ - generatedAt: string; -} - -// ============================================================================ -// Window Object Augmentation -// ============================================================================ - -declare global { - interface Window { - /** - * Set of all valid RefIds in the documentation - * Populated by ValidRefs.js at runtime - */ - VALID_REFS?: Set; - - /** - * Set of all valid PageIds in the documentation - * Populated by ValidPages.js at runtime - */ - VALID_PAGES?: Set; - - /** - * Runtime configuration object - * Populated by tsdocs-config.js at runtime - */ - TSDOCS_CONFIG?: TsdocsConfig; - - /** - * Get absolute path for an API reference - * - * @param refId - The RefId (e.g., "mint-tsdocs.MarkdownDocumenter") - * @returns Absolute path (e.g., "/reference/mint-tsdocs/MarkdownDocumenter") - * - * @example - * getRefPath("mint-tsdocs.MarkdownDocumenter") - * // Returns: "/reference/mint-tsdocs/MarkdownDocumenter" - */ - getRefPath?: (refId: string) => string; - } -} - -export {}; diff --git a/references/1.4.0/asset-manager/0-index.mdx b/references/1.4.0/asset-manager/0-index.mdx deleted file mode 100644 index 0733d87..0000000 --- a/references/1.4.0/asset-manager/0-index.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "Asset Manager" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/asset-manager` is a manager for loading assets to uniform work with between client and server. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/asset-manager -yarn add @nanoforge-dev/asset-manager -pnpm add @nanoforge-dev/asset-manager -bun add @nanoforge-dev/asset-manager -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; - -export async function main(options: IRunOptions) { - const app = NanoforgeFactory.createClient(); // Or NanoforgeFactory.createServer() - - const assetManager = new AssetManagerLibrary(); - - app.useAssetManager(assetManager); - - await app.init(options); - - await app.run(); -} -``` - -Use to load assets - -```ts -export async function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - - const file = assetManager.getAsset("/path/to/file.txt"); - const text = await file.text(); - - // Do something with file or text -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/asset-manager -[npm]: https://www.npmjs.com/package/@nanoforge-dev/asset-manager -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/asset-manager/AssetManagerLibrary.mdx b/references/1.4.0/asset-manager/AssetManagerLibrary.mdx deleted file mode 100644 index 966b860..0000000 --- a/references/1.4.0/asset-manager/AssetManagerLibrary.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "AssetManagerLibrary class" -icon: "box" -description: "Built-in asset-manager library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# AssetManagerLibrary - -## Summary - -Built-in asset-manager library. -## Signature - -```typescript -declare class AssetManagerLibrary extends BaseAssetManagerLibrary -``` - -## Methods - -### getAsset - -Retrieve a registered file asset by its virtual path. - -### getAsset - - - -## Remarks - - Stores the file map injected by the NanoForge loader (`nf start`) and exposes assets via `getAsset`. Register it with the application before calling `init`: File paths are normalised on lookup: leading slashes are collapsed to a single `/`, duplicate slashes are removed, and trailing slashes are stripped. \ No newline at end of file diff --git a/references/1.4.0/asset-manager/AssetManagerLibrary/getAsset.mdx b/references/1.4.0/asset-manager/AssetManagerLibrary/getAsset.mdx deleted file mode 100644 index 192a448..0000000 --- a/references/1.4.0/asset-manager/AssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "Retrieve a registered file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a registered file asset by its virtual path. -## Signature - -```typescript -getAsset(path: string): NfFile; -``` - -## Parameters - -### path -**Type**:`string` - -Virtual path of the asset (e.g. "/textures/hero.png"). - -## Returns - -**Type**:`NfFile` - -Retrieve a registered file asset by its virtual path. - -## Remarks - - The path is normalised before lookup: leading and duplicate slashes are collapsed and trailing slashes are removed. \ No newline at end of file diff --git a/references/1.4.0/asset-manager/AssetManagerLibrary/getAsset_1.mdx b/references/1.4.0/asset-manager/AssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index b06123b..0000000 --- a/references/1.4.0/asset-manager/AssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset -## Signature - -```typescript -getAsset(path: "" | undefined): undefined; -``` - -## Parameters - -### path -**Type**:`"" | undefined` - - - -## Returns - -**Type**:`undefined` \ No newline at end of file diff --git a/references/1.4.0/common/0-index.mdx b/references/1.4.0/common/0-index.mdx deleted file mode 100644 index 0de4539..0000000 --- a/references/1.4.0/common/0-index.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "Common" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/common` is library with common interfaces and utilities used by Nanoforge Engine. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/common -yarn add @nanoforge-dev/common -pnpm add @nanoforge-dev/common -bun add @nanoforge-dev/common -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/common -[npm]: https://www.npmjs.com/package/@nanoforge-dev/common -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/common/ASSET_MANAGER_LIBRARY.mdx b/references/1.4.0/common/ASSET_MANAGER_LIBRARY.mdx deleted file mode 100644 index 55eed46..0000000 --- a/references/1.4.0/common/ASSET_MANAGER_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ASSET_MANAGER_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the asset-manager library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ASSET_MANAGER_LIBRARY - -## Summary - -Registration symbol for the asset-manager library slot. -## Signature - -```typescript -ASSET_MANAGER_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.useAssetManager` or use it as a dependency in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.0/common/ApplicationContext.mdx b/references/1.4.0/common/ApplicationContext.mdx deleted file mode 100644 index 5c94d56..0000000 --- a/references/1.4.0/common/ApplicationContext.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "ApplicationContext class" -icon: "box" -description: "Holds runtime state that is shared across all libraries during the game loop." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ApplicationContext - -## Summary - -Holds runtime state that is shared across all libraries during the game loop. -## Signature - -```typescript -declare abstract class ApplicationContext -``` - -## Properties - -### delta -**Modifiers**: readonly -**Type**:`get delta(): number;` - -Elapsed time in milliseconds since the last frame. - -### isRunning -**Modifiers**: readonly -**Type**:`get isRunning(): boolean;` - -Whether the engine game loop is currently executing. - -## Remarks - - An instance of this class is available to every library via `BaseContext.application`. Libraries may read `isRunning` and `delta` to make frame-rate-independent decisions. \ No newline at end of file diff --git a/references/1.4.0/common/ApplicationContext/delta.mdx b/references/1.4.0/common/ApplicationContext/delta.mdx deleted file mode 100644 index 3e3d8cc..0000000 --- a/references/1.4.0/common/ApplicationContext/delta.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "delta" -icon: "variable" -description: "Elapsed time in milliseconds since the last frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# delta - -## Summary - -Elapsed time in milliseconds since the last frame. \ No newline at end of file diff --git a/references/1.4.0/common/ApplicationContext/isRunning.mdx b/references/1.4.0/common/ApplicationContext/isRunning.mdx deleted file mode 100644 index 631b6fd..0000000 --- a/references/1.4.0/common/ApplicationContext/isRunning.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "isRunning" -icon: "variable" -description: "Whether the engine game loop is currently executing." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isRunning - -## Summary - -Whether the engine game loop is currently executing. \ No newline at end of file diff --git a/references/1.4.0/common/BaseAssetManagerLibrary.mdx b/references/1.4.0/common/BaseAssetManagerLibrary.mdx deleted file mode 100644 index 3294405..0000000 --- a/references/1.4.0/common/BaseAssetManagerLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseAssetManagerLibrary class" -icon: "box" -description: "Abstract base class for asset-manager libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseAssetManagerLibrary - -## Summary - -Abstract base class for asset-manager libraries. -## Signature - -```typescript -declare abstract class BaseAssetManagerLibrary extends Library implements IAssetManagerLibrary -``` - -## Methods - -### getAsset -**Modifiers**: abstract - -Retrieve a file asset by its virtual path. - -### getAsset -**Modifiers**: abstract - - - -## Remarks - - Extend this class to implement a custom asset-manager and register it with `NanoforgeApplication.useAssetManager`. The built-in implementation is `AssetManagerLibrary`. \ No newline at end of file diff --git a/references/1.4.0/common/BaseAssetManagerLibrary/getAsset.mdx b/references/1.4.0/common/BaseAssetManagerLibrary/getAsset.mdx deleted file mode 100644 index f492d02..0000000 --- a/references/1.4.0/common/BaseAssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "Retrieve a file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a file asset by its virtual path. -## Signature - -```typescript -abstract getAsset(path: string): NfFile; -``` - -## Parameters - -### path -**Type**:`string` - -Virtual path as registered in the engine's file map (e.g. "/textures/hero.png"). - -## Returns - -**Type**:`NfFile` - -Retrieve a file asset by its virtual path. \ No newline at end of file diff --git a/references/1.4.0/common/BaseAssetManagerLibrary/getAsset_1.mdx b/references/1.4.0/common/BaseAssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index baa7fe8..0000000 --- a/references/1.4.0/common/BaseAssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset -## Signature - -```typescript -abstract getAsset(path: "" | undefined): undefined; -``` - -## Parameters - -### path -**Type**:`"" | undefined` - - - -## Returns - -**Type**:`undefined` \ No newline at end of file diff --git a/references/1.4.0/common/BaseComponentSystemLibrary.mdx b/references/1.4.0/common/BaseComponentSystemLibrary.mdx deleted file mode 100644 index 0104678..0000000 --- a/references/1.4.0/common/BaseComponentSystemLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseComponentSystemLibrary class" -icon: "box" -description: "Abstract base class for component-system (ECS) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseComponentSystemLibrary - -## Summary - -Abstract base class for component-system (ECS) libraries. -## Signature - -```typescript -declare abstract class BaseComponentSystemLibrary extends Library implements IComponentSystemLibrary -``` - -## Remarks - - Extend this class (or the higher-level `AbstractECSLibrary`) to implement a custom ECS back-end and register it with `NanoforgeApplication.useComponentSystem`. The built-in implementations are `ECSClientLibrary` and `ECSServerLibrary`. \ No newline at end of file diff --git a/references/1.4.0/common/BaseGraphicsLibrary.mdx b/references/1.4.0/common/BaseGraphicsLibrary.mdx deleted file mode 100644 index 91ff228..0000000 --- a/references/1.4.0/common/BaseGraphicsLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseGraphicsLibrary class" -icon: "box" -description: "Abstract base class for graphics libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseGraphicsLibrary - -## Summary - -Abstract base class for graphics libraries. -## Signature - -```typescript -declare abstract class BaseGraphicsLibrary extends Library implements IGraphicsLibrary -``` - -## Remarks - - Extend this class to implement a custom rendering backend and register it with `NanoforgeClient.useGraphics`. The built-in implementation is `Graphics2DLibrary`. \ No newline at end of file diff --git a/references/1.4.0/common/BaseInputLibrary.mdx b/references/1.4.0/common/BaseInputLibrary.mdx deleted file mode 100644 index 9d79933..0000000 --- a/references/1.4.0/common/BaseInputLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseInputLibrary class" -icon: "box" -description: "Abstract base class for input libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseInputLibrary - -## Summary - -Abstract base class for input libraries. -## Signature - -```typescript -declare abstract class BaseInputLibrary extends Library implements IInputLibrary -``` - -## Remarks - - Extend this class to implement a custom input back-end and register it with `NanoforgeClient.useInput`. The built-in implementation is `InputLibrary`. \ No newline at end of file diff --git a/references/1.4.0/common/BaseMusicLibrary.mdx b/references/1.4.0/common/BaseMusicLibrary.mdx deleted file mode 100644 index 355c2ed..0000000 --- a/references/1.4.0/common/BaseMusicLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseMusicLibrary class" -icon: "box" -description: "Abstract base class for music libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseMusicLibrary - -## Summary - -Abstract base class for music libraries. -## Signature - -```typescript -declare abstract class BaseMusicLibrary extends Library implements IMusicLibrary -``` - -## Methods - -### mute -**Modifiers**: abstract - -Toggle the muted state of all loaded music tracks. - -### play -**Modifiers**: abstract - -Stop the currently playing track (if any) and start playing the requested one. - -## Remarks - - Extend this class to implement a custom music library and register it with `NanoforgeApplication.use` using the `MUSIC_LIBRARY` symbol. The built-in implementation is `MusicLibrary`. \ No newline at end of file diff --git a/references/1.4.0/common/BaseMusicLibrary/mute.mdx b/references/1.4.0/common/BaseMusicLibrary/mute.mdx deleted file mode 100644 index 870e300..0000000 --- a/references/1.4.0/common/BaseMusicLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded music tracks." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded music tracks. -## Signature - -```typescript -abstract mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded music tracks. \ No newline at end of file diff --git a/references/1.4.0/common/BaseMusicLibrary/play.mdx b/references/1.4.0/common/BaseMusicLibrary/play.mdx deleted file mode 100644 index c01e955..0000000 --- a/references/1.4.0/common/BaseMusicLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Stop the currently playing track (if any) and start playing the requested one." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Stop the currently playing track (if any) and start playing the requested one. -## Signature - -```typescript -abstract play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the music track (as passed to load). - -## Returns - -**Type**:`void` - -Stop the currently playing track (if any) and start playing the requested one. \ No newline at end of file diff --git a/references/1.4.0/common/BaseNetworkLibrary.mdx b/references/1.4.0/common/BaseNetworkLibrary.mdx deleted file mode 100644 index b1ac7fa..0000000 --- a/references/1.4.0/common/BaseNetworkLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseNetworkLibrary class" -icon: "box" -description: "Abstract base class for network libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseNetworkLibrary - -## Summary - -Abstract base class for network libraries. -## Signature - -```typescript -declare abstract class BaseNetworkLibrary extends Library implements INetworkLibrary -``` - -## Remarks - - Extend this class to implement a custom network library and register it with `NanoforgeApplication.useNetwork`. The built-in implementations are `NetworkClientLibrary` and `NetworkServerLibrary`. \ No newline at end of file diff --git a/references/1.4.0/common/BaseSoundLibrary.mdx b/references/1.4.0/common/BaseSoundLibrary.mdx deleted file mode 100644 index 7655039..0000000 --- a/references/1.4.0/common/BaseSoundLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseSoundLibrary class" -icon: "box" -description: "Abstract base class for sound libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseSoundLibrary - -## Summary - -Abstract base class for sound libraries. -## Signature - -```typescript -declare abstract class BaseSoundLibrary extends Library implements ISoundLibrary -``` - -## Methods - -### mute -**Modifiers**: abstract - -Toggle the muted state of all loaded sound effects. - -### play -**Modifiers**: abstract - -Play a previously loaded sound effect. - -## Remarks - - Extend this class to implement a custom sound library and register it with `NanoforgeClient.useSound`. The built-in implementation is `SoundLibrary`. \ No newline at end of file diff --git a/references/1.4.0/common/BaseSoundLibrary/mute.mdx b/references/1.4.0/common/BaseSoundLibrary/mute.mdx deleted file mode 100644 index 9fcd48e..0000000 --- a/references/1.4.0/common/BaseSoundLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded sound effects." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded sound effects. -## Signature - -```typescript -abstract mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded sound effects. \ No newline at end of file diff --git a/references/1.4.0/common/BaseSoundLibrary/play.mdx b/references/1.4.0/common/BaseSoundLibrary/play.mdx deleted file mode 100644 index c7040b6..0000000 --- a/references/1.4.0/common/BaseSoundLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Play a previously loaded sound effect." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Play a previously loaded sound effect. -## Signature - -```typescript -abstract play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the sound (as passed to load). - -## Returns - -**Type**:`void` - -Play a previously loaded sound effect. \ No newline at end of file diff --git a/references/1.4.0/common/COMPONENT_SYSTEM_LIBRARY.mdx b/references/1.4.0/common/COMPONENT_SYSTEM_LIBRARY.mdx deleted file mode 100644 index 484ad21..0000000 --- a/references/1.4.0/common/COMPONENT_SYSTEM_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "COMPONENT_SYSTEM_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the component-system (ECS) library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# COMPONENT_SYSTEM_LIBRARY - -## Summary - -Registration symbol for the component-system (ECS) library slot. -## Signature - -```typescript -COMPONENT_SYSTEM_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.use` when registering a custom component-system library, or use the shorthand `NanoforgeApplication.useComponentSystem`. \ No newline at end of file diff --git a/references/1.4.0/common/ClearContext.mdx b/references/1.4.0/common/ClearContext.mdx deleted file mode 100644 index b3a6704..0000000 --- a/references/1.4.0/common/ClearContext.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ClearContext class" -icon: "box" -description: "Context passed to a library's clear lifecycle hook during application shutdown." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ClearContext - -## Summary - -Context passed to a library's `__clear` lifecycle hook during application shutdown. -## Signature - -```typescript -declare class ClearContext extends BaseContext -``` - -## Remarks - - Use the inherited `application` and `libraries` accessors to access shared state and other libraries while tearing down resources. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager.mdx b/references/1.4.0/common/ClientLibraryManager.mdx deleted file mode 100644 index 75f7404..0000000 --- a/references/1.4.0/common/ClientLibraryManager.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "ClientLibraryManager class" -icon: "box" -description: "Convenience wrapper around LibraryManager that unwraps LibraryHandle values and returns the library instance directly." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ClientLibraryManager - -## Summary - -Convenience wrapper around `LibraryManager` that unwraps `LibraryHandle` values and returns the library instance directly. -## Signature - -```typescript -declare class ClientLibraryManager -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### get - -Retrieve a library registered under a custom symbol. - -### getAssetManager - -Retrieve the registered asset-manager library instance. - -### getComponentSystem - -Retrieve the registered component-system (ECS) library instance. - -### getGraphics - -Retrieve the registered graphics library instance. - -### getInput - -Retrieve the registered input library instance. - -### getMusic - -Retrieve the registered music library instance. - -### getNetwork - -Retrieve the registered network library instance. - -### getSound - -Retrieve the registered sound library instance. - -## Remarks - - Typically accessed inside a library's lifecycle hooks through the execution context's `libraries` property after being constructed with a concrete `LibraryManager`. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/constructor.mdx b/references/1.4.0/common/ClientLibraryManager/constructor.mdx deleted file mode 100644 index e84b462..0000000 --- a/references/1.4.0/common/ClientLibraryManager/constructor.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ClientLibraryManager class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ClientLibraryManager` class -## Signature - -```typescript -constructor(libraryManager: LibraryManager); -``` - -## Parameters - -### libraryManager -- **Type**:`LibraryManager` - -The underlying manager to delegate lookups to. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/get.mdx b/references/1.4.0/common/ClientLibraryManager/get.mdx deleted file mode 100644 index 9b5edaf..0000000 --- a/references/1.4.0/common/ClientLibraryManager/get.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "get" -icon: "function" -description: "Retrieve a library registered under a custom symbol." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# get - -## Summary - -Retrieve a library registered under a custom symbol. -## Signature - -```typescript -get(sym: symbol): T; -``` - -## Parameters - -### sym -**Type**:`symbol` - -The symbol the library was registered with. - -## Returns - -**Type**:`T` - -Retrieve a library registered under a custom symbol. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/getAssetManager.mdx b/references/1.4.0/common/ClientLibraryManager/getAssetManager.mdx deleted file mode 100644 index 3f9dc8a..0000000 --- a/references/1.4.0/common/ClientLibraryManager/getAssetManager.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getAssetManager" -icon: "function" -description: "Retrieve the registered asset-manager library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAssetManager - -## Summary - -Retrieve the registered asset-manager library instance. -## Signature - -```typescript -getAssetManager(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered asset-manager library instance. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/getComponentSystem.mdx b/references/1.4.0/common/ClientLibraryManager/getComponentSystem.mdx deleted file mode 100644 index 0618c44..0000000 --- a/references/1.4.0/common/ClientLibraryManager/getComponentSystem.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getComponentSystem" -icon: "function" -description: "Retrieve the registered component-system (ECS) library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentSystem - -## Summary - -Retrieve the registered component-system (ECS) library instance. -## Signature - -```typescript -getComponentSystem(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered component-system (ECS) library instance. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/getGraphics.mdx b/references/1.4.0/common/ClientLibraryManager/getGraphics.mdx deleted file mode 100644 index 279e0e7..0000000 --- a/references/1.4.0/common/ClientLibraryManager/getGraphics.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getGraphics" -icon: "function" -description: "Retrieve the registered graphics library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getGraphics - -## Summary - -Retrieve the registered graphics library instance. -## Signature - -```typescript -getGraphics(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered graphics library instance. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/getInput.mdx b/references/1.4.0/common/ClientLibraryManager/getInput.mdx deleted file mode 100644 index ecb04fa..0000000 --- a/references/1.4.0/common/ClientLibraryManager/getInput.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getInput" -icon: "function" -description: "Retrieve the registered input library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getInput - -## Summary - -Retrieve the registered input library instance. -## Signature - -```typescript -getInput(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered input library instance. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/getMusic.mdx b/references/1.4.0/common/ClientLibraryManager/getMusic.mdx deleted file mode 100644 index ec91ce8..0000000 --- a/references/1.4.0/common/ClientLibraryManager/getMusic.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMusic" -icon: "function" -description: "Retrieve the registered music library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMusic - -## Summary - -Retrieve the registered music library instance. -## Signature - -```typescript -getMusic(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered music library instance. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/getNetwork.mdx b/references/1.4.0/common/ClientLibraryManager/getNetwork.mdx deleted file mode 100644 index 91f2bfd..0000000 --- a/references/1.4.0/common/ClientLibraryManager/getNetwork.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getNetwork" -icon: "function" -description: "Retrieve the registered network library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getNetwork - -## Summary - -Retrieve the registered network library instance. -## Signature - -```typescript -getNetwork(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered network library instance. \ No newline at end of file diff --git a/references/1.4.0/common/ClientLibraryManager/getSound.mdx b/references/1.4.0/common/ClientLibraryManager/getSound.mdx deleted file mode 100644 index fcfd477..0000000 --- a/references/1.4.0/common/ClientLibraryManager/getSound.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getSound" -icon: "function" -description: "Retrieve the registered sound library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getSound - -## Summary - -Retrieve the registered sound library instance. -## Signature - -```typescript -getSound(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered sound library instance. \ No newline at end of file diff --git a/references/1.4.0/common/Context.mdx b/references/1.4.0/common/Context.mdx deleted file mode 100644 index 92d8ed5..0000000 --- a/references/1.4.0/common/Context.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Context class" -icon: "box" -description: "Context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Context -## Signature - -```typescript -declare class Context -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### app -**Modifiers**: readonly -**Type**:`get app(): ApplicationContext;` - - - -### libs -**Modifiers**: readonly -**Type**:`get libs(): ClientLibraryManager;` \ No newline at end of file diff --git a/references/1.4.0/common/Context/app.mdx b/references/1.4.0/common/Context/app.mdx deleted file mode 100644 index 0912bb7..0000000 --- a/references/1.4.0/common/Context/app.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "app" -icon: "variable" -description: "app API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# app \ No newline at end of file diff --git a/references/1.4.0/common/Context/constructor.mdx b/references/1.4.0/common/Context/constructor.mdx deleted file mode 100644 index 5688f33..0000000 --- a/references/1.4.0/common/Context/constructor.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the Context class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `Context` class -## Signature - -```typescript -constructor(applicationContext: ApplicationContext, libraryManager: ClientLibraryManager); -``` - -## Parameters - -### applicationContext -- **Type**:`ApplicationContext` - - - -### libraryManager -- **Type**:`ClientLibraryManager` \ No newline at end of file diff --git a/references/1.4.0/common/Context/libs.mdx b/references/1.4.0/common/Context/libs.mdx deleted file mode 100644 index eb4c68b..0000000 --- a/references/1.4.0/common/Context/libs.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "libs" -icon: "variable" -description: "libs API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# libs \ No newline at end of file diff --git a/references/1.4.0/common/DefaultLibrariesEnum.mdx b/references/1.4.0/common/DefaultLibrariesEnum.mdx deleted file mode 100644 index b82062a..0000000 --- a/references/1.4.0/common/DefaultLibrariesEnum.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "DefaultLibrariesEnum enum" -icon: "list" -description: "Numeric index keys for the built-in library slots." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# DefaultLibrariesEnum - -## Summary - -Numeric index keys for the built-in library slots. - -## Members -| Member | Description | -| ------ | ----------- | -| `ASSET_MANAGER` | | -| `COMPONENT_SYSTEM` | | -| `GRAPHICS` | | -| `INPUT` | | -| `MUSIC` | | -| `NETWORK` | | -| `SOUND` | | - -## Remarks - - Used internally by `LibraryManager` to keep O(1) access to the well-known library positions. Game code should not reference these values directly — use the typed accessor methods on `LibraryManager` instead. \ No newline at end of file diff --git a/references/1.4.0/common/ExecutionContext.mdx b/references/1.4.0/common/ExecutionContext.mdx deleted file mode 100644 index b6ef64b..0000000 --- a/references/1.4.0/common/ExecutionContext.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ExecutionContext class" -icon: "box" -description: "Context passed to a library's run hook on every game-loop tick." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ExecutionContext - -## Summary - -Context passed to a library's `__run` hook on every game-loop tick. -## Signature - -```typescript -declare class ExecutionContext extends BaseContext -``` - -## Remarks - - Use the inherited `application` and `libraries` accessors to read the current delta time and interact with other libraries during the frame update. \ No newline at end of file diff --git a/references/1.4.0/common/GRAPHICS_LIBRARY.mdx b/references/1.4.0/common/GRAPHICS_LIBRARY.mdx deleted file mode 100644 index 149ddc0..0000000 --- a/references/1.4.0/common/GRAPHICS_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "GRAPHICS_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the graphics library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# GRAPHICS_LIBRARY - -## Summary - -Registration symbol for the graphics library slot. -## Signature - -```typescript -GRAPHICS_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useGraphics` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.0/common/IAssetManagerLibrary.mdx b/references/1.4.0/common/IAssetManagerLibrary.mdx deleted file mode 100644 index 81e2913..0000000 --- a/references/1.4.0/common/IAssetManagerLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IAssetManagerLibrary interface" -icon: "plug" -description: "Interface for asset-manager libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IAssetManagerLibrary - -## Summary - -Interface for asset-manager libraries. -## Signature - -```typescript -interface IAssetManagerLibrary extends IExposedLibrary -``` - -## Remarks - - Implemented by `BaseAssetManagerLibrary` and its concrete subclass `AssetManagerLibrary`. Access an instance via `ctx.libraries.getAssetManager().library`. \ No newline at end of file diff --git a/references/1.4.0/common/IAssetManagerLibrary/getAsset.mdx b/references/1.4.0/common/IAssetManagerLibrary/getAsset.mdx deleted file mode 100644 index 89ba6b7..0000000 --- a/references/1.4.0/common/IAssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getAsset" -icon: "file" -description: "Retrieve a registered file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a registered file asset by its virtual path. - -## Description - -Retrieve a registered file asset by its virtual path. \ No newline at end of file diff --git a/references/1.4.0/common/IAssetManagerLibrary/getAsset_1.mdx b/references/1.4.0/common/IAssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index 9698eef..0000000 --- a/references/1.4.0/common/IAssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getAsset" -icon: "file" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Description \ No newline at end of file diff --git a/references/1.4.0/common/IComponentSystemLibrary.mdx b/references/1.4.0/common/IComponentSystemLibrary.mdx deleted file mode 100644 index 4e173f3..0000000 --- a/references/1.4.0/common/IComponentSystemLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IComponentSystemLibrary interface" -icon: "plug" -description: "Interface for component-system (ECS) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IComponentSystemLibrary - -## Summary - -Interface for component-system (ECS) libraries. -## Signature - -```typescript -interface IComponentSystemLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseComponentSystemLibrary` and the higher-level `AbstractECSLibrary`, with concrete subclasses `ECSClientLibrary` and `ECSServerLibrary`. Access an instance via `ctx.libraries.getComponentSystem().library`. \ No newline at end of file diff --git a/references/1.4.0/common/IConfigRegistry.mdx b/references/1.4.0/common/IConfigRegistry.mdx deleted file mode 100644 index ce95d44..0000000 --- a/references/1.4.0/common/IConfigRegistry.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "IConfigRegistry interface" -icon: "plug" -description: "Resolves and validates typed configuration objects from the runtime environment." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IConfigRegistry - -## Summary - -Resolves and validates typed configuration objects from the runtime environment. -## Signature - -```typescript -interface IConfigRegistry -``` - -## Remarks - - An instance is available in `InitContext.config`. Configuration classes must be decorated with `class-transformer` (`@Expose`, `@Default`) and `class-validator` (`@IsPort`, `@IsIpOrFQDN`, etc.) decorators from `@nanoforge-dev/config`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/common/IConfigRegistry/registerConfig.mdx b/references/1.4.0/common/IConfigRegistry/registerConfig.mdx deleted file mode 100644 index d093467..0000000 --- a/references/1.4.0/common/IConfigRegistry/registerConfig.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "registerConfig" -icon: "file" -description: "Instantiate, populate from the runtime environment, transform, and validate a configuration class." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registerConfig - -## Summary - -Instantiate, populate from the runtime environment, transform, and validate a configuration class. - -## Description - -Instantiate, populate from the runtime environment, transform, and validate a configuration class. \ No newline at end of file diff --git a/references/1.4.0/common/IExposedLibrary.mdx b/references/1.4.0/common/IExposedLibrary.mdx deleted file mode 100644 index 488520d..0000000 --- a/references/1.4.0/common/IExposedLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IExposedLibrary interface" -icon: "plug" -description: "Marker interface for libraries that are directly accessible to game code via the ClientLibraryManager." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IExposedLibrary - -## Summary - -Marker interface for libraries that are directly accessible to game code via the `ClientLibraryManager`. -## Signature - -```typescript -interface IExposedLibrary extends ILibrary -``` - -## Remarks - - All built-in typed library interfaces (e.g. `IAssetManagerLibrary`, `ISoundLibrary`) extend this interface. \ No newline at end of file diff --git a/references/1.4.0/common/IGraphicsLibrary.mdx b/references/1.4.0/common/IGraphicsLibrary.mdx deleted file mode 100644 index 22daee8..0000000 --- a/references/1.4.0/common/IGraphicsLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IGraphicsLibrary interface" -icon: "plug" -description: "Interface for graphics libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IGraphicsLibrary - -## Summary - -Interface for graphics libraries. -## Signature - -```typescript -interface IGraphicsLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseGraphicsLibrary` and its concrete subclass `Graphics2DLibrary`. Access an instance via `ctx.libraries.getGraphics().library`. \ No newline at end of file diff --git a/references/1.4.0/common/IInputLibrary.mdx b/references/1.4.0/common/IInputLibrary.mdx deleted file mode 100644 index bff971f..0000000 --- a/references/1.4.0/common/IInputLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IInputLibrary interface" -icon: "plug" -description: "Interface for input libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IInputLibrary - -## Summary - -Interface for input libraries. -## Signature - -```typescript -interface IInputLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseInputLibrary` and its concrete subclass `InputLibrary`. Access an instance via `ctx.libraries.getInput().library`. \ No newline at end of file diff --git a/references/1.4.0/common/ILibrary.mdx b/references/1.4.0/common/ILibrary.mdx deleted file mode 100644 index cc0a1ea..0000000 --- a/references/1.4.0/common/ILibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ILibrary interface" -icon: "plug" -description: "Core interface that every NanoForge library must satisfy." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ILibrary - -## Summary - -Core interface that every NanoForge library must satisfy. -## Signature - -```typescript -interface ILibrary -``` - -## Remarks - - Implement this interface (or extend an abstract base such as `BaseAssetManagerLibrary`) to create a custom library and register it with the engine via `NanoforgeApplication.use`. \ No newline at end of file diff --git a/references/1.4.0/common/IMusicLibrary.mdx b/references/1.4.0/common/IMusicLibrary.mdx deleted file mode 100644 index 64ef5cb..0000000 --- a/references/1.4.0/common/IMusicLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IMusicLibrary interface" -icon: "plug" -description: "Interface for music libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IMusicLibrary - -## Summary - -Interface for music libraries. -## Signature - -```typescript -interface IMusicLibrary extends IExposedLibrary, IMutableLibrary -``` - -## Remarks - - Implemented by `BaseMusicLibrary` and its concrete subclass `MusicLibrary`. Access an instance via `ctx.libraries.getMusic().library`. \ No newline at end of file diff --git a/references/1.4.0/common/IMutableLibrary.mdx b/references/1.4.0/common/IMutableLibrary.mdx deleted file mode 100644 index 9300072..0000000 --- a/references/1.4.0/common/IMutableLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IMutableLibrary interface" -icon: "plug" -description: "Interface for libraries that support muting/unmuting audio playback." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IMutableLibrary - -## Summary - -Interface for libraries that support muting/unmuting audio playback. -## Signature - -```typescript -interface IMutableLibrary extends ILibrary -``` - -## Remarks - - Implemented by `ISoundLibrary` and `IMusicLibrary`. \ No newline at end of file diff --git a/references/1.4.0/common/IMutableLibrary/mute.mdx b/references/1.4.0/common/IMutableLibrary/mute.mdx deleted file mode 100644 index 74a6415..0000000 --- a/references/1.4.0/common/IMutableLibrary/mute.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "mute" -icon: "file" -description: "Toggle the muted state. Mutes when currently unmuted, and vice versa." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state. Mutes when currently unmuted, and vice versa. - -## Description - -Toggle the muted state. Mutes when currently unmuted, and vice versa. \ No newline at end of file diff --git a/references/1.4.0/common/INPUT_LIBRARY.mdx b/references/1.4.0/common/INPUT_LIBRARY.mdx deleted file mode 100644 index 52d6c76..0000000 --- a/references/1.4.0/common/INPUT_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "INPUT_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the input library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# INPUT_LIBRARY - -## Summary - -Registration symbol for the input library slot. -## Signature - -```typescript -INPUT_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useInput` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.0/common/INetworkLibrary.mdx b/references/1.4.0/common/INetworkLibrary.mdx deleted file mode 100644 index 9f1d44a..0000000 --- a/references/1.4.0/common/INetworkLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "INetworkLibrary interface" -icon: "plug" -description: "Interface for network libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# INetworkLibrary - -## Summary - -Interface for network libraries. -## Signature - -```typescript -interface INetworkLibrary extends IExposedLibrary -``` - -## Remarks - - Implemented by `BaseNetworkLibrary` and its concrete subclasses `NetworkClientLibrary` and `NetworkServerLibrary`. Access an instance via `ctx.libraries.getNetwork().library`. \ No newline at end of file diff --git a/references/1.4.0/common/IRunClientOptions.mdx b/references/1.4.0/common/IRunClientOptions.mdx deleted file mode 100644 index d9362af..0000000 --- a/references/1.4.0/common/IRunClientOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunClientOptions interface" -icon: "plug" -description: "Run options for a client-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunClientOptions - -## Summary - -Run options for a client-side NanoForge application. -## Signature - -```typescript -interface IRunClientOptions -``` - -## Remarks - - Pass an instance to `NanoforgeApplication.init` when running in the browser. The engine bundler (`nf build`) automatically generates and injects `files` and `env` at build time. \ No newline at end of file diff --git a/references/1.4.0/common/IRunClientOptions/container.mdx b/references/1.4.0/common/IRunClientOptions/container.mdx deleted file mode 100644 index 80e02b6..0000000 --- a/references/1.4.0/common/IRunClientOptions/container.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "container" -icon: "file" -description: "DOM element that will host the game canvas." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# container - -## Summary - -DOM element that will host the game canvas. - -## Description - -DOM element that will host the game canvas. - -## Remarks - - The element's current `offsetWidth` and `offsetHeight` are used to set the initial canvas dimensions. \ No newline at end of file diff --git a/references/1.4.0/common/IRunClientOptions/env.mdx b/references/1.4.0/common/IRunClientOptions/env.mdx deleted file mode 100644 index d416585..0000000 --- a/references/1.4.0/common/IRunClientOptions/env.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "env" -icon: "file" -description: "Runtime environment variables available to all libraries via InitContext.env." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Runtime environment variables available to all libraries via `InitContext.env`. - -## Description - -Runtime environment variables available to all libraries via . \ No newline at end of file diff --git a/references/1.4.0/common/IRunClientOptions/files.mdx b/references/1.4.0/common/IRunClientOptions/files.mdx deleted file mode 100644 index 2697027..0000000 --- a/references/1.4.0/common/IRunClientOptions/files.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "files" -icon: "file" -description: "Map of virtual file paths to their resolved URL strings." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their resolved URL strings. - -## Description - -Map of virtual file paths to their resolved URL strings. - -## Remarks - - Populated automatically by the NanoForge bundler. Keys are normalised paths such as `"/textures/hero.png"`. \ No newline at end of file diff --git a/references/1.4.0/common/IRunOptions.mdx b/references/1.4.0/common/IRunOptions.mdx deleted file mode 100644 index 725c3e0..0000000 --- a/references/1.4.0/common/IRunOptions.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "IRunOptions type" -icon: "file-code" -description: "Union of client and server run options accepted by NanoforgeApplication.init." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunOptions - -## Summary - -Union of client and server run options accepted by `NanoforgeApplication.init`. -## Signature - -```typescript -type IRunOptions = IRunClientOptions | IRunServerOptions; -``` \ No newline at end of file diff --git a/references/1.4.0/common/IRunServerOptions.mdx b/references/1.4.0/common/IRunServerOptions.mdx deleted file mode 100644 index 2c28702..0000000 --- a/references/1.4.0/common/IRunServerOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunServerOptions interface" -icon: "plug" -description: "Run options for a server-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunServerOptions - -## Summary - -Run options for a server-side NanoForge application. -## Signature - -```typescript -interface IRunServerOptions -``` - -## Remarks - - Pass an instance to `NanoforgeApplication.init` when running in a Node.js server process. \ No newline at end of file diff --git a/references/1.4.0/common/IRunServerOptions/env.mdx b/references/1.4.0/common/IRunServerOptions/env.mdx deleted file mode 100644 index d416585..0000000 --- a/references/1.4.0/common/IRunServerOptions/env.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "env" -icon: "file" -description: "Runtime environment variables available to all libraries via InitContext.env." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Runtime environment variables available to all libraries via `InitContext.env`. - -## Description - -Runtime environment variables available to all libraries via . \ No newline at end of file diff --git a/references/1.4.0/common/IRunServerOptions/files.mdx b/references/1.4.0/common/IRunServerOptions/files.mdx deleted file mode 100644 index 35be311..0000000 --- a/references/1.4.0/common/IRunServerOptions/files.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "files" -icon: "file" -description: "Map of virtual file paths to their resolved URL strings." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their resolved URL strings. - -## Description - -Map of virtual file paths to their resolved URL strings. - -## Remarks - - Populated automatically by the NanoForge bundler. Keys are normalised paths such as `"/data/config.json"`. \ No newline at end of file diff --git a/references/1.4.0/common/IRunnerLibrary.mdx b/references/1.4.0/common/IRunnerLibrary.mdx deleted file mode 100644 index ca7ec08..0000000 --- a/references/1.4.0/common/IRunnerLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunnerLibrary interface" -icon: "plug" -description: "Interface for libraries that participate in the per-frame game loop." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunnerLibrary - -## Summary - -Interface for libraries that participate in the per-frame game loop. -## Signature - -```typescript -interface IRunnerLibrary extends ILibrary -``` - -## Remarks - - The engine calls `__run` on every tick for all registered runner libraries in the order determined by their `ILibraryOptions.runBefore` / `ILibraryOptions.runAfter` relationships. \ No newline at end of file diff --git a/references/1.4.0/common/ISoundLibrary.mdx b/references/1.4.0/common/ISoundLibrary.mdx deleted file mode 100644 index f653be2..0000000 --- a/references/1.4.0/common/ISoundLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ISoundLibrary interface" -icon: "plug" -description: "Interface for sound-effect libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ISoundLibrary - -## Summary - -Interface for sound-effect libraries. -## Signature - -```typescript -interface ISoundLibrary extends IExposedLibrary, IMutableLibrary -``` - -## Remarks - - Implemented by `BaseSoundLibrary` and its concrete subclass `SoundLibrary`. Access an instance via `ctx.libraries.getSound().library`. \ No newline at end of file diff --git a/references/1.4.0/common/InitContext.mdx b/references/1.4.0/common/InitContext.mdx deleted file mode 100644 index 2cb673a..0000000 --- a/references/1.4.0/common/InitContext.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "InitContext class" -icon: "box" -description: "Context object passed to every library's init lifecycle hook." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InitContext - -## Summary - -Context object passed to every library's `__init` lifecycle hook. -## Signature - -```typescript -declare class InitContext extends BaseContext -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### config -**Modifiers**: readonly -**Type**:`get config(): IConfigRegistry;` - -Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment. - -### container -**Modifiers**: readonly -**Type**:`get container(): IRunClientOptions["container"] | undefined;` - -The that should host the game canvas. - -### env -**Modifiers**: readonly -**Type**:`get env(): Record;` - -Key/value map of environment variables made available at runtime. - -### files -**Modifiers**: readonly -**Type**:`get files(): IRunOptions["files"];` - -Map of virtual file paths to their URL strings, pre-loaded by the engine bundler. - -## Remarks - - Provides libraries with all the information they need during start-up: the canvas container, pre-loaded asset files, environment variables, and a config registry for loading structured configuration classes. Access it in a library's `__init` override: \ No newline at end of file diff --git a/references/1.4.0/common/InitContext/config.mdx b/references/1.4.0/common/InitContext/config.mdx deleted file mode 100644 index 862c74c..0000000 --- a/references/1.4.0/common/InitContext/config.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "config" -icon: "variable" -description: "Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# config - -## Summary - -Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment. - -## Remarks - - Call `ctx.config.registerConfig(MyConfigClass)` to get a validated and transformed instance populated from `ctx.env`. \ No newline at end of file diff --git a/references/1.4.0/common/InitContext/constructor.mdx b/references/1.4.0/common/InitContext/constructor.mdx deleted file mode 100644 index 9966e29..0000000 --- a/references/1.4.0/common/InitContext/constructor.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the InitContext class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `InitContext` class -## Signature - -```typescript -constructor(context: ApplicationContext, libraryManager: LibraryManager, configRegistry: IConfigRegistry, options: IRunOptions); -``` - -## Parameters - -### context -- **Type**:`ApplicationContext` - -Shared application-level runtime state. - -### libraryManager -- **Type**:`LibraryManager` - -Manager giving access to other registered libraries. - -### configRegistry -- **Type**:`IConfigRegistry` - -Registry used to resolve typed configuration objects. - -### options -- **Type**:`IRunOptions` - -Run options forwarded from NanoforgeApplication.init. \ No newline at end of file diff --git a/references/1.4.0/common/InitContext/container.mdx b/references/1.4.0/common/InitContext/container.mdx deleted file mode 100644 index 93f8c55..0000000 --- a/references/1.4.0/common/InitContext/container.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "container" -icon: "variable" -description: "The HTMLDivElement that should host the game canvas." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# container - -## Summary - -The `HTMLDivElement` that should host the game canvas. - -## Remarks - - Only available in client contexts; `undefined` on the server. \ No newline at end of file diff --git a/references/1.4.0/common/InitContext/env.mdx b/references/1.4.0/common/InitContext/env.mdx deleted file mode 100644 index 3e29538..0000000 --- a/references/1.4.0/common/InitContext/env.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "env" -icon: "variable" -description: "Key/value map of environment variables made available at runtime." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Key/value map of environment variables made available at runtime. \ No newline at end of file diff --git a/references/1.4.0/common/InitContext/files.mdx b/references/1.4.0/common/InitContext/files.mdx deleted file mode 100644 index cfebe1f..0000000 --- a/references/1.4.0/common/InitContext/files.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "files" -icon: "variable" -description: "Map of virtual file paths to their URL strings, pre-loaded by the engine bundler." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their URL strings, pre-loaded by the engine bundler. \ No newline at end of file diff --git a/references/1.4.0/common/Library.mdx b/references/1.4.0/common/Library.mdx deleted file mode 100644 index 71d845c..0000000 --- a/references/1.4.0/common/Library.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Library class" -icon: "box" -description: "Base class for all NanoForge libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Library - -## Summary - -Base class for all NanoForge libraries. -## Signature - -```typescript -declare abstract class Library implements ILibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### _relationship -**Modifiers**: protected -**Type**:`protected _relationship: RelationshipHandler;` - - - -## Remarks - - Extend this class (or one of its typed subclasses such as `BaseAssetManagerLibrary`, `BaseSoundLibrary`, etc.) to create a custom library. At minimum you must implement the `ILibrary.__name` getter and register the library with the engine before calling `NanoforgeApplication.init`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/common/Library/_relationship.mdx b/references/1.4.0/common/Library/_relationship.mdx deleted file mode 100644 index b5f1747..0000000 --- a/references/1.4.0/common/Library/_relationship.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "_relationship" -icon: "variable" -description: "_relationship API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _relationship \ No newline at end of file diff --git a/references/1.4.0/common/Library/constructor.mdx b/references/1.4.0/common/Library/constructor.mdx deleted file mode 100644 index f891ea6..0000000 --- a/references/1.4.0/common/Library/constructor.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the Library class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `Library` class -## Signature - -```typescript -constructor(rawOptions?: Partial); -``` - -## Parameters - -### rawOptions -- **Type**:`Partial` -- **Optional**: Yes - -Optional dependency and execution-order overrides. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryContext.mdx b/references/1.4.0/common/LibraryContext.mdx deleted file mode 100644 index 4697fb9..0000000 --- a/references/1.4.0/common/LibraryContext.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "LibraryContext class" -icon: "box" -description: "Tracks the current lifecycle state of a single library registration." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryContext - -## Summary - -Tracks the current lifecycle state of a single library registration. -## Signature - -```typescript -declare class LibraryContext -``` - -## Properties - -### status -**Modifiers**: readonly -**Type**:`get status(): LibraryStatusEnum;` - -Current lifecycle state of the associated library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryContext/status.mdx b/references/1.4.0/common/LibraryContext/status.mdx deleted file mode 100644 index 6f801c7..0000000 --- a/references/1.4.0/common/LibraryContext/status.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "status" -icon: "variable" -description: "Current lifecycle state of the associated library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# status - -## Summary - -Current lifecycle state of the associated library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryHandle.mdx b/references/1.4.0/common/LibraryHandle.mdx deleted file mode 100644 index 4aa0753..0000000 --- a/references/1.4.0/common/LibraryHandle.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "LibraryHandle class" -icon: "box" -description: "An opaque handle returned by LibraryManager accessors." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryHandle - -## Summary - -An opaque handle returned by `LibraryManager` accessors. -## Signature - -```typescript -declare class LibraryHandle -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### context -**Modifiers**: readonly -**Type**:`get context(): LibraryContext;` - -Current lifecycle context tracking the library's status. - -### library -**Modifiers**: readonly -**Type**:`get library(): T;` - -The underlying library instance. - -### symbol -**Modifiers**: readonly -**Type**:`get symbol(): symbol;` - -The registration symbol used to look up this library. - -## Remarks - - Bundles the library instance together with its registration symbol and lifecycle context. Prefer using the strongly-typed accessor methods on `LibraryManager` or `ClientLibraryManager` rather than constructing handles directly. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryHandle/constructor.mdx b/references/1.4.0/common/LibraryHandle/constructor.mdx deleted file mode 100644 index d2367b0..0000000 --- a/references/1.4.0/common/LibraryHandle/constructor.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the LibraryHandle class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `LibraryHandle` class -## Signature - -```typescript -constructor(sym: symbol, library: T, defaultContext: LibraryContext); -``` - -## Parameters - -### sym -- **Type**:`symbol` - -Registration symbol for this library. - -### library -- **Type**:`T` - -The library instance. - -### defaultContext -- **Type**:`LibraryContext` - -Initial lifecycle context. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryHandle/context.mdx b/references/1.4.0/common/LibraryHandle/context.mdx deleted file mode 100644 index 28d7907..0000000 --- a/references/1.4.0/common/LibraryHandle/context.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "context" -icon: "variable" -description: "Current lifecycle context tracking the library's status." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# context - -## Summary - -Current lifecycle context tracking the library's status. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryHandle/library.mdx b/references/1.4.0/common/LibraryHandle/library.mdx deleted file mode 100644 index c0f9812..0000000 --- a/references/1.4.0/common/LibraryHandle/library.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "library" -icon: "variable" -description: "The underlying library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# library - -## Summary - -The underlying library instance. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryHandle/symbol.mdx b/references/1.4.0/common/LibraryHandle/symbol.mdx deleted file mode 100644 index b47145d..0000000 --- a/references/1.4.0/common/LibraryHandle/symbol.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "symbol" -icon: "variable" -description: "The registration symbol used to look up this library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# symbol - -## Summary - -The registration symbol used to look up this library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager.mdx b/references/1.4.0/common/LibraryManager.mdx deleted file mode 100644 index 011fdfd..0000000 --- a/references/1.4.0/common/LibraryManager.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "LibraryManager class" -icon: "box" -description: "Central registry for all libraries registered with a NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryManager - -## Summary - -Central registry for all libraries registered with a NanoForge application. -## Signature - -```typescript -declare class LibraryManager extends BaseLibraryManager -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getAssetManager - -Retrieve the registered asset-manager library. - -### getComponentSystem - -Retrieve the registered component-system (ECS) library. - -### getGraphics - -Retrieve the registered graphics library. - -### getInput - -Retrieve the registered input library. - -### getMusic - -Retrieve the registered music library. - -### getNetwork - -Retrieve the registered network library. - -### getSound - -Retrieve the registered sound library. - -## Remarks - - An instance is available inside every lifecycle context via `BaseContext.libraries`. Use the typed accessor methods to retrieve any built-in library, or call `BaseLibraryManager.get` with a custom symbol for user-defined libraries. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager/constructor.mdx b/references/1.4.0/common/LibraryManager/constructor.mdx deleted file mode 100644 index f4a0c93..0000000 --- a/references/1.4.0/common/LibraryManager/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the LibraryManager class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `LibraryManager` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager/getAssetManager.mdx b/references/1.4.0/common/LibraryManager/getAssetManager.mdx deleted file mode 100644 index 7f2ea14..0000000 --- a/references/1.4.0/common/LibraryManager/getAssetManager.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getAssetManager" -icon: "function" -description: "Retrieve the registered asset-manager library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAssetManager - -## Summary - -Retrieve the registered asset-manager library. -## Signature - -```typescript -getAssetManager(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered asset-manager library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager/getComponentSystem.mdx b/references/1.4.0/common/LibraryManager/getComponentSystem.mdx deleted file mode 100644 index 45020f1..0000000 --- a/references/1.4.0/common/LibraryManager/getComponentSystem.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getComponentSystem" -icon: "function" -description: "Retrieve the registered component-system (ECS) library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentSystem - -## Summary - -Retrieve the registered component-system (ECS) library. -## Signature - -```typescript -getComponentSystem(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered component-system (ECS) library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager/getGraphics.mdx b/references/1.4.0/common/LibraryManager/getGraphics.mdx deleted file mode 100644 index fa2c568..0000000 --- a/references/1.4.0/common/LibraryManager/getGraphics.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getGraphics" -icon: "function" -description: "Retrieve the registered graphics library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getGraphics - -## Summary - -Retrieve the registered graphics library. -## Signature - -```typescript -getGraphics(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered graphics library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager/getInput.mdx b/references/1.4.0/common/LibraryManager/getInput.mdx deleted file mode 100644 index 238f50f..0000000 --- a/references/1.4.0/common/LibraryManager/getInput.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getInput" -icon: "function" -description: "Retrieve the registered input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getInput - -## Summary - -Retrieve the registered input library. -## Signature - -```typescript -getInput(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered input library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager/getMusic.mdx b/references/1.4.0/common/LibraryManager/getMusic.mdx deleted file mode 100644 index e8fc5f8..0000000 --- a/references/1.4.0/common/LibraryManager/getMusic.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMusic" -icon: "function" -description: "Retrieve the registered music library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMusic - -## Summary - -Retrieve the registered music library. -## Signature - -```typescript -getMusic(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered music library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager/getNetwork.mdx b/references/1.4.0/common/LibraryManager/getNetwork.mdx deleted file mode 100644 index b5df49a..0000000 --- a/references/1.4.0/common/LibraryManager/getNetwork.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getNetwork" -icon: "function" -description: "Retrieve the registered network library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getNetwork - -## Summary - -Retrieve the registered network library. -## Signature - -```typescript -getNetwork(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered network library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryManager/getSound.mdx b/references/1.4.0/common/LibraryManager/getSound.mdx deleted file mode 100644 index 3e4c97a..0000000 --- a/references/1.4.0/common/LibraryManager/getSound.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getSound" -icon: "function" -description: "Retrieve the registered sound library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getSound - -## Summary - -Retrieve the registered sound library. -## Signature - -```typescript -getSound(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered sound library. \ No newline at end of file diff --git a/references/1.4.0/common/LibraryStatusEnum.mdx b/references/1.4.0/common/LibraryStatusEnum.mdx deleted file mode 100644 index 747ba33..0000000 --- a/references/1.4.0/common/LibraryStatusEnum.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "LibraryStatusEnum enum" -icon: "list" -description: "Lifecycle states a library can be in." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryStatusEnum - -## Summary - -Lifecycle states a library can be in. - -## Members -| Member | Description | -| ------ | ----------- | -| `CLEAR` | The library has been cleared and its resources released. | -| `LOADED` | The library has been successfully initialised and is ready to use. | -| `UNLOADED` | The library has not been initialised yet. | \ No newline at end of file diff --git a/references/1.4.0/common/MUSIC_LIBRARY.mdx b/references/1.4.0/common/MUSIC_LIBRARY.mdx deleted file mode 100644 index 1ed1240..0000000 --- a/references/1.4.0/common/MUSIC_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "MUSIC_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the music library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# MUSIC_LIBRARY - -## Summary - -Registration symbol for the music library slot. -## Signature - -```typescript -MUSIC_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.use` with a custom music library or use it as a dependency symbol in `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.0/common/NETWORK_LIBRARY.mdx b/references/1.4.0/common/NETWORK_LIBRARY.mdx deleted file mode 100644 index eedcf69..0000000 --- a/references/1.4.0/common/NETWORK_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "NETWORK_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the network library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NETWORK_LIBRARY - -## Summary - -Registration symbol for the network library slot. -## Signature - -```typescript -NETWORK_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.useNetwork` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.0/common/NfConfigException.mdx b/references/1.4.0/common/NfConfigException.mdx deleted file mode 100644 index 1777a60..0000000 --- a/references/1.4.0/common/NfConfigException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfConfigException class" -icon: "box" -description: "Thrown when a library configuration is invalid or incomplete." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfConfigException - -## Summary - -Thrown when a library configuration is invalid or incomplete. -## Signature - -```typescript -declare class NfConfigException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Remarks - - Typically raised during `__init` when required environment variables are missing or fail validation. For example, `NetworkClientLibrary` throws this when neither `SERVER_TCP_PORT` nor `SERVER_UDP_PORT` is provided. \ No newline at end of file diff --git a/references/1.4.0/common/NfConfigException/code.mdx b/references/1.4.0/common/NfConfigException/code.mdx deleted file mode 100644 index 3401684..0000000 --- a/references/1.4.0/common/NfConfigException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 400." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `400`. \ No newline at end of file diff --git a/references/1.4.0/common/NfConfigException/constructor.mdx b/references/1.4.0/common/NfConfigException/constructor.mdx deleted file mode 100644 index 27d50ba..0000000 --- a/references/1.4.0/common/NfConfigException/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfConfigException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfConfigException` class -## Signature - -```typescript -constructor(message: string, library?: string); -``` - -## Parameters - -### message -- **Type**:`string` - -Description of the configuration error. - -### library -- **Type**:`string` -- **Optional**: Yes - -Optional library name that detected the error. \ No newline at end of file diff --git a/references/1.4.0/common/NfFetchException.mdx b/references/1.4.0/common/NfFetchException.mdx deleted file mode 100644 index 91501a8..0000000 --- a/references/1.4.0/common/NfFetchException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfFetchException class" -icon: "box" -description: "Thrown when an HTTP fetch performed internally by the engine fails." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfFetchException - -## Summary - -Thrown when an HTTP fetch performed internally by the engine fails. -## Signature - -```typescript -declare class NfFetchException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -The HTTP status code returned by the failed request (e.g. , ). - -## Remarks - - Raised by `NfFile` methods (e.g. `arrayBuffer`, `text`) when the underlying `fetch` call returns a non-OK HTTP response. \ No newline at end of file diff --git a/references/1.4.0/common/NfFetchException/code.mdx b/references/1.4.0/common/NfFetchException/code.mdx deleted file mode 100644 index f832308..0000000 --- a/references/1.4.0/common/NfFetchException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "The HTTP status code returned by the failed request (e.g. 404, 500)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -The HTTP status code returned by the failed request (e.g. `404`, `500`). \ No newline at end of file diff --git a/references/1.4.0/common/NfFetchException/constructor.mdx b/references/1.4.0/common/NfFetchException/constructor.mdx deleted file mode 100644 index 2fb11ee..0000000 --- a/references/1.4.0/common/NfFetchException/constructor.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfFetchException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfFetchException` class -## Signature - -```typescript -constructor(code: number, text: string); -``` - -## Parameters - -### code -- **Type**:`number` - -HTTP status code of the failed response. - -### text -- **Type**:`string` - -Status text of the failed response. \ No newline at end of file diff --git a/references/1.4.0/common/NfFile.mdx b/references/1.4.0/common/NfFile.mdx deleted file mode 100644 index 80bfa2e..0000000 --- a/references/1.4.0/common/NfFile.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "NfFile class" -icon: "box" -description: "Represents a file asset that has been registered with the engine." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfFile - -## Summary - -Represents a file asset that has been registered with the engine. -## Signature - -```typescript -declare class NfFile -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### path -**Modifiers**: readonly -**Type**:`get path(): string;` - -Internal URL path used to fetch the file. - -## Methods - -### arrayBuffer - -Fetch the file and return its content as an . - -### blob - -Fetch the file and return its content as a . - -### bytes - -Fetch the file and return its content as a . - -### formData - -Fetch the file and return its content as . - -### json - -Fetch the file, parse it as JSON, and return the result. - -### text - -Fetch the file and return its content as a UTF-8 string. - -## Remarks - - Instances are returned by `AssetManagerLibrary.getAsset`. Each method lazily fetches the file from the engine's virtual file system and returns the content in the requested format. All read methods throw `NfFetchException` when the underlying `fetch` returns a non-OK response. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/common/NfFile/arrayBuffer.mdx b/references/1.4.0/common/NfFile/arrayBuffer.mdx deleted file mode 100644 index 0a94d62..0000000 --- a/references/1.4.0/common/NfFile/arrayBuffer.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "arrayBuffer" -icon: "function" -description: "Fetch the file and return its content as an ArrayBuffer." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# arrayBuffer - -## Summary - -Fetch the file and return its content as an `ArrayBuffer`. -## Signature - -```typescript -arrayBuffer(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as an . \ No newline at end of file diff --git a/references/1.4.0/common/NfFile/blob.mdx b/references/1.4.0/common/NfFile/blob.mdx deleted file mode 100644 index f5a1fd4..0000000 --- a/references/1.4.0/common/NfFile/blob.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "blob" -icon: "function" -description: "Fetch the file and return its content as a Blob." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# blob - -## Summary - -Fetch the file and return its content as a `Blob`. -## Signature - -```typescript -blob(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as a . \ No newline at end of file diff --git a/references/1.4.0/common/NfFile/bytes.mdx b/references/1.4.0/common/NfFile/bytes.mdx deleted file mode 100644 index c43ba59..0000000 --- a/references/1.4.0/common/NfFile/bytes.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "bytes" -icon: "function" -description: "Fetch the file and return its content as a Uint8Array." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# bytes - -## Summary - -Fetch the file and return its content as a `Uint8Array`. -## Signature - -```typescript -bytes(): Promise>; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise>` - -Fetch the file and return its content as a . \ No newline at end of file diff --git a/references/1.4.0/common/NfFile/constructor.mdx b/references/1.4.0/common/NfFile/constructor.mdx deleted file mode 100644 index 3e80d1f..0000000 --- a/references/1.4.0/common/NfFile/constructor.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfFile class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfFile` class -## Signature - -```typescript -constructor(path: string); -``` - -## Parameters - -### path -- **Type**:`string` - -Internal URL path used to fetch the file. \ No newline at end of file diff --git a/references/1.4.0/common/NfFile/formData.mdx b/references/1.4.0/common/NfFile/formData.mdx deleted file mode 100644 index 93ab538..0000000 --- a/references/1.4.0/common/NfFile/formData.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "formData" -icon: "function" -description: "Fetch the file and return its content as FormData." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# formData - -## Summary - -Fetch the file and return its content as `FormData`. -## Signature - -```typescript -formData(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as . \ No newline at end of file diff --git a/references/1.4.0/common/NfFile/json.mdx b/references/1.4.0/common/NfFile/json.mdx deleted file mode 100644 index 350501a..0000000 --- a/references/1.4.0/common/NfFile/json.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "json" -icon: "function" -description: "Fetch the file, parse it as JSON, and return the result." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# json - -## Summary - -Fetch the file, parse it as JSON, and return the result. -## Signature - -```typescript -json(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file, parse it as JSON, and return the result. \ No newline at end of file diff --git a/references/1.4.0/common/NfFile/path.mdx b/references/1.4.0/common/NfFile/path.mdx deleted file mode 100644 index 4653fc5..0000000 --- a/references/1.4.0/common/NfFile/path.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "path" -icon: "variable" -description: "Internal URL path used to fetch the file." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# path - -## Summary - -Internal URL path used to fetch the file. \ No newline at end of file diff --git a/references/1.4.0/common/NfFile/text.mdx b/references/1.4.0/common/NfFile/text.mdx deleted file mode 100644 index 87ed647..0000000 --- a/references/1.4.0/common/NfFile/text.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "text" -icon: "function" -description: "Fetch the file and return its content as a UTF-8 string." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# text - -## Summary - -Fetch the file and return its content as a UTF-8 string. -## Signature - -```typescript -text(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as a UTF-8 string. \ No newline at end of file diff --git a/references/1.4.0/common/NfNotFound.mdx b/references/1.4.0/common/NfNotFound.mdx deleted file mode 100644 index 656e89d..0000000 --- a/references/1.4.0/common/NfNotFound.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "NfNotFound class" -icon: "box" -description: "Thrown when a requested resource (asset, sound, music track, etc.) cannot be found in the engine's registry." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfNotFound - -## Summary - -Thrown when a requested resource (asset, sound, music track, etc.) cannot be found in the engine's registry. -## Signature - -```typescript -declare class NfNotFound extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/common/NfNotFound/code.mdx b/references/1.4.0/common/NfNotFound/code.mdx deleted file mode 100644 index 8bd0665..0000000 --- a/references/1.4.0/common/NfNotFound/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 404." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `404`. \ No newline at end of file diff --git a/references/1.4.0/common/NfNotFound/constructor.mdx b/references/1.4.0/common/NfNotFound/constructor.mdx deleted file mode 100644 index 8165021..0000000 --- a/references/1.4.0/common/NfNotFound/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfNotFound class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfNotFound` class -## Signature - -```typescript -constructor(item: string, type?: string); -``` - -## Parameters - -### item -- **Type**:`string` - -Name or path of the missing resource. - -### type -- **Type**:`string` -- **Optional**: Yes - -Optional category label (e.g. "Asset", "Sound"). \ No newline at end of file diff --git a/references/1.4.0/common/NfNotInitializedException.mdx b/references/1.4.0/common/NfNotInitializedException.mdx deleted file mode 100644 index a6bfda6..0000000 --- a/references/1.4.0/common/NfNotInitializedException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfNotInitializedException class" -icon: "box" -description: "Thrown when a method is called on a library or engine component before it has been initialised via init." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfNotInitializedException - -## Summary - -Thrown when a method is called on a library or engine component before it has been initialised via `__init`. -## Signature - -```typescript -declare class NfNotInitializedException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Remarks - - This exception is raised automatically by the helper method `Library.throwNotInitializedError()`. Ensure that `NanoforgeApplication.init` has resolved before interacting with any library. \ No newline at end of file diff --git a/references/1.4.0/common/NfNotInitializedException/code.mdx b/references/1.4.0/common/NfNotInitializedException/code.mdx deleted file mode 100644 index 8bd0665..0000000 --- a/references/1.4.0/common/NfNotInitializedException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 404." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `404`. \ No newline at end of file diff --git a/references/1.4.0/common/NfNotInitializedException/constructor.mdx b/references/1.4.0/common/NfNotInitializedException/constructor.mdx deleted file mode 100644 index f26a60c..0000000 --- a/references/1.4.0/common/NfNotInitializedException/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfNotInitializedException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfNotInitializedException` class -## Signature - -```typescript -constructor(item: string, type?: string); -``` - -## Parameters - -### item -- **Type**:`string` - -Name of the uninitialised component (e.g. the library's __name). - -### type -- **Type**:`string` -- **Optional**: Yes - -Optional category label (e.g. "Library"). \ No newline at end of file diff --git a/references/1.4.0/common/SOUND_LIBRARY.mdx b/references/1.4.0/common/SOUND_LIBRARY.mdx deleted file mode 100644 index 3f53355..0000000 --- a/references/1.4.0/common/SOUND_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "SOUND_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the sound library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SOUND_LIBRARY - -## Summary - -Registration symbol for the sound library slot. -## Signature - -```typescript -SOUND_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useSound` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.0/config/0-index.mdx b/references/1.4.0/config/0-index.mdx deleted file mode 100644 index 1aa0681..0000000 --- a/references/1.4.0/config/0-index.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: "Config" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/config` is a wrapper of [class-validator][class-validator] and [class-transformer][class-transformer] to imports validation and transformation decorators. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/config -yarn add @nanoforge-dev/config -pnpm add @nanoforge-dev/config -bun add @nanoforge-dev/config -``` - -## Warning - -This library is of exclusive usage for other libraries. To put variables in the environment to allow libraries to use it through this config library, you must put it in `.env` file at the root of your project (or in your environment) : - -```dotenv -NANOFORGE_CLIENT_SERVER_TCP_PORT=4445 -NANOFORGE_CLIENT_SERVER_UDP_PORT=4444 -NANOFORGE_CLIENT_SERVER_ADDRESS=127.0.0.1 -``` - -You must prefix your variables according to this table : - -| Prefix | Availability | -| :------------------ | :----------------------- | -| `NANOFORGE_CLIENT_` | Available in client only | -| `NANOFORGE_SERVER_` | Available in server only | -| `NANOFORGE_` | Available in both apps | - -⚠️ Prefixs are removed in libs - -You can also put it in init options (every value must be string or undefined) : - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkLibrary } from "@nanoforge-dev/network"; - -export async function main(options: IRunOptions) { - const app = NanoforgeFactory.createClient(); - - const network = new NetworkLibrary(); - - app.useNetwork(network); - - await app.init({ - ...options, - env: { - ...options.env, - SERVER_TCP_PORT: "4445", - SERVER_UDP_PORT: "4444", - SERVER_ADDRESS: "127.0.0.1", - }, - }); - - await app.run(); -} -``` - -## Example usage - -Initialize the library in your main file. - -```ts -export class NetworkClientLibrary extends BaseNetworkLibrary { - get __name(): string { - return "NetworkClientLibrary"; - } - - public override async __init(context: InitContext): Promise { - const config = await context.config.registerConfig(ClientConfigNetwork); - - // Do something with config - } -} -``` - -Using this config - -```ts -import { - Default, - Expose, - IsByteLength, - IsIpOrFQDN, - IsOptional, - IsPort, -} from "@nanoforge-dev/config"; - -export class ClientConfigNetwork { - // This var must be a string port (ex: "4444") but can be undefined - @Expose() - @IsOptional() - @IsPort() - SERVER_TCP_PORT?: string; - - @Expose() - @IsOptional() - @IsPort() - SERVER_UDP_PORT?: string; - - // This var must be ip address or fqdn (it cannot be undefined) - @Expose() - @IsIpOrFQDN() - SERVER_ADDRESS?: string; - - // This var must be a byte length between 2 and 64. It can be undefined as it as a default value. - @Expose() - @Default("PACKET_END") - @IsByteLength(2, 64) - MAGIC_VALUE!: string; -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/config -[npm]: https://www.npmjs.com/package/@nanoforge-dev/config -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md -[class-validator]: https://github.com/typestack/class-validator -[class-transformer]: https://github.com/typestack/class-transformer diff --git a/references/1.4.0/config/Default.mdx b/references/1.4.0/config/Default.mdx deleted file mode 100644 index aeb1dc4..0000000 --- a/references/1.4.0/config/Default.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Default function" -icon: "function" -description: "Property decorator that supplies a fallback value when the environment variable is undefined or null." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Default - -## Summary - -Property decorator that supplies a fallback value when the environment variable is `undefined` or `null`. -## Signature - -```typescript -declare function Default(defaultValue: unknown): PropertyDecorator; -``` - -## Parameters - -### defaultValue -**Type**:`unknown` - -The value to use when the property is absent. - -## Returns - -**Type**:`PropertyDecorator` - -Property decorator that supplies a fallback value when the environment variable is or . - -## Remarks - - Pairs with `class-transformer`'s `@Expose` and `class-validator` decorators. The default is deep-cloned via `JSON.parse(JSON.stringify(…))` so objects are not shared between instances. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/config/IsIpOrFQDN.mdx b/references/1.4.0/config/IsIpOrFQDN.mdx deleted file mode 100644 index 281eca1..0000000 --- a/references/1.4.0/config/IsIpOrFQDN.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "IsIpOrFQDN function" -icon: "function" -description: "Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (FQDN)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IsIpOrFQDN - -## Summary - -Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (FQDN). -## Signature - -```typescript -IsIpOrFQDN: (validationOptions?: ValidationOptions) => (object: object, propertyName: string) => void -``` - -## Parameters - -### validationOptions -**Type**:`ValidationOptions` -**Optional**: Yes - -Optional class-validator validation options. - -## Returns - -**Type**:`(object: object, propertyName: string) => void` - -Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (FQDN). - -## Remarks - - Built on top of `class-validator`'s `isIP` and `isFQDN` helpers. Use on config properties that represent server hostnames or addresses. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/config/TransformToBoolean.mdx b/references/1.4.0/config/TransformToBoolean.mdx deleted file mode 100644 index 4efdf4e..0000000 --- a/references/1.4.0/config/TransformToBoolean.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "TransformToBoolean function" -icon: "function" -description: "Property decorator that transforms the string environment variable value \"true\" or \"false\" into a native boolean." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TransformToBoolean - -## Summary - -Property decorator that transforms the string environment variable value `"true"` or `"false"` into a native `boolean`. -## Signature - -```typescript -TransformToBoolean: () => PropertyDecorator -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`PropertyDecorator` - -Property decorator that transforms the string environment variable value or into a native . - -## Remarks - - Returns `undefined` for any value that is neither `"true"` nor `"false"`. Pair with `@IsBoolean()` and `@Default(false)` for a fully validated and defaulted boolean config property. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/core-editor/0-index.mdx b/references/1.4.0/core-editor/0-index.mdx deleted file mode 100644 index 339d811..0000000 --- a/references/1.4.0/core-editor/0-index.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Core Editor" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/core-editor` is a package made to allow the editor to make change to a game even if it's already compiled and running. - -If you want a core to run your game use the `@nanoforge-dev/core`. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/core-editor -yarn add @nanoforge-dev/core-editor -pnpm add @nanoforge-dev/core-editor -bun add @nanoforge-dev/core-editor -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/core-editor -[npm]: https://www.npmjs.com/package/@nanoforge-dev/core-editor -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/core-editor/CoreEvents.mdx b/references/1.4.0/core-editor/CoreEvents.mdx deleted file mode 100644 index 1fc259b..0000000 --- a/references/1.4.0/core-editor/CoreEvents.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "CoreEvents enum" -icon: "list" -description: "Events that the NanoForge editor can emit to the running engine." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# CoreEvents - -## Summary - -Events that the NanoForge editor can emit to the running engine. - -## Members -| Member | Description | -| ------ | ----------- | -| `HARD_RELOAD` | Reload all entities component params | -| `HOT_RELOAD` | Reload only changed entity components params (live-patch) | -| `PAUSE_GAME` | Don't execute the run function until UNPAUSE_GAME | -| `STOP_GAME` | End main loop and clear | -| `UNPAUSE_GAME` | resume executing the run function | \ No newline at end of file diff --git a/references/1.4.0/core-editor/EditorEvents.mdx b/references/1.4.0/core-editor/EditorEvents.mdx deleted file mode 100644 index d62aa05..0000000 --- a/references/1.4.0/core-editor/EditorEvents.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "EditorEvents enum" -icon: "list" -description: "EditorEvents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorEvents - -## Members -| Member | Description | -| ------ | ----------- | -| `MOVE_COMPONENT` | | \ No newline at end of file diff --git a/references/1.4.0/core-editor/EventEmitter.mdx b/references/1.4.0/core-editor/EventEmitter.mdx deleted file mode 100644 index 12dd7b2..0000000 --- a/references/1.4.0/core-editor/EventEmitter.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "EventEmitter class" -icon: "box" -description: "EventEmitter API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EventEmitter -## Signature - -```typescript -declare class EventEmitter -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### emit - - - -### on - - - -### runEvents \ No newline at end of file diff --git a/references/1.4.0/core-editor/EventEmitter/constructor.mdx b/references/1.4.0/core-editor/EventEmitter/constructor.mdx deleted file mode 100644 index 1a46ef1..0000000 --- a/references/1.4.0/core-editor/EventEmitter/constructor.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the EventEmitter class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `EventEmitter` class -## Signature - -```typescript -constructor(opts: IRunOptions["editor"]); -``` - -## Parameters - -### opts -- **Type**:`IRunOptions["editor"]` \ No newline at end of file diff --git a/references/1.4.0/core-editor/EventEmitter/emit.mdx b/references/1.4.0/core-editor/EventEmitter/emit.mdx deleted file mode 100644 index c3eedbd..0000000 --- a/references/1.4.0/core-editor/EventEmitter/emit.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "emit" -icon: "function" -description: "emit API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# emit -## Signature - -```typescript -emit(event: K, ...args: EditorEventsMap[K]): void; -``` - -## Parameters - -### event -**Type**:`K` - - - -### args -**Type**:`EditorEventsMap[K]` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.0/core-editor/EventEmitter/on.mdx b/references/1.4.0/core-editor/EventEmitter/on.mdx deleted file mode 100644 index 21e7823..0000000 --- a/references/1.4.0/core-editor/EventEmitter/on.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "on" -icon: "function" -description: "on API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# on -## Signature - -```typescript -on(event: K, listener: ListenerType): void; -``` - -## Parameters - -### event -**Type**:`K` - - - -### listener -**Type**:`ListenerType` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.0/core-editor/EventEmitter/runEvents.mdx b/references/1.4.0/core-editor/EventEmitter/runEvents.mdx deleted file mode 100644 index 15658b2..0000000 --- a/references/1.4.0/core-editor/EventEmitter/runEvents.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "runEvents" -icon: "function" -description: "runEvents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# runEvents -## Signature - -```typescript -runEvents(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.0/core-editor/NanoforgeClient.mdx b/references/1.4.0/core-editor/NanoforgeClient.mdx deleted file mode 100644 index 7efda75..0000000 --- a/references/1.4.0/core-editor/NanoforgeClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NanoforgeClient class" -icon: "box" -description: "Client-side NanoForge application for editor mode." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeClient - -## Summary - -Client-side NanoForge application for editor mode. -## Signature - -```typescript -declare class NanoforgeClient extends NanoforgeApplication -``` - -## Methods - -### useGraphics - -Register the graphics library. - -### useInput - -Register the input library. - -### useSound - -Register the sound-effect library. - -## Remarks - - Extends `NanoforgeApplication` with graphics, input, and sound library slots. Create via the `core-editor` `NanoforgeFactory`. \ No newline at end of file diff --git a/references/1.4.0/core-editor/NanoforgeClient/useGraphics.mdx b/references/1.4.0/core-editor/NanoforgeClient/useGraphics.mdx deleted file mode 100644 index 27045ab..0000000 --- a/references/1.4.0/core-editor/NanoforgeClient/useGraphics.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useGraphics" -icon: "function" -description: "Register the graphics library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useGraphics - -## Summary - -Register the graphics library. -## Signature - -```typescript -useGraphics(library: IGraphicsLibrary): void; -``` - -## Parameters - -### library -**Type**:`IGraphicsLibrary` - -Graphics library instance (e.g. Graphics2DLibrary). - -## Returns - -**Type**:`void` - -Register the graphics library. \ No newline at end of file diff --git a/references/1.4.0/core-editor/NanoforgeClient/useInput.mdx b/references/1.4.0/core-editor/NanoforgeClient/useInput.mdx deleted file mode 100644 index 799cad5..0000000 --- a/references/1.4.0/core-editor/NanoforgeClient/useInput.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useInput" -icon: "function" -description: "Register the input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useInput - -## Summary - -Register the input library. -## Signature - -```typescript -useInput(library: IInputLibrary): void; -``` - -## Parameters - -### library -**Type**:`IInputLibrary` - -Input library instance (e.g. InputLibrary). - -## Returns - -**Type**:`void` - -Register the input library. \ No newline at end of file diff --git a/references/1.4.0/core-editor/NanoforgeClient/useSound.mdx b/references/1.4.0/core-editor/NanoforgeClient/useSound.mdx deleted file mode 100644 index 30f6b34..0000000 --- a/references/1.4.0/core-editor/NanoforgeClient/useSound.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useSound" -icon: "function" -description: "Register the sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useSound - -## Summary - -Register the sound-effect library. -## Signature - -```typescript -useSound(library: ISoundLibrary): void; -``` - -## Parameters - -### library -**Type**:`ISoundLibrary` - -Sound library instance (e.g. SoundLibrary). - -## Returns - -**Type**:`void` - -Register the sound-effect library. \ No newline at end of file diff --git a/references/1.4.0/core-editor/NanoforgeFactory.mdx b/references/1.4.0/core-editor/NanoforgeFactory.mdx deleted file mode 100644 index 88d924e..0000000 --- a/references/1.4.0/core-editor/NanoforgeFactory.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeFactory variable" -icon: "variable" -description: "Singleton factory for creating editor-mode NanoForge client and server applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeFactory - -## Summary - -Singleton factory for creating editor-mode NanoForge client and server applications. -## Signature - -```typescript -NanoforgeFactory: NanoforgeFactoryStatic -``` - -## Remarks - - Use `NanoforgeFactory.createClient` or `NanoforgeFactory.createServer` to obtain an application instance that accepts `IEditorRunOptions` on `init`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/core-editor/NanoforgeServer.mdx b/references/1.4.0/core-editor/NanoforgeServer.mdx deleted file mode 100644 index 81c27e0..0000000 --- a/references/1.4.0/core-editor/NanoforgeServer.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "NanoforgeServer class" -icon: "box" -description: "Server-side NanoForge application for editor mode." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeServer - -## Summary - -Server-side NanoForge application for editor mode. -## Signature - -```typescript -declare class NanoforgeServer extends NanoforgeApplication -``` - -## Remarks - - Extends `NanoforgeApplication` for use in server processes during editor sessions. Create via the `core-editor` `NanoforgeFactory`. \ No newline at end of file diff --git a/references/1.4.0/core/0-index.mdx b/references/1.4.0/core/0-index.mdx deleted file mode 100644 index 4f7f4ac..0000000 --- a/references/1.4.0/core/0-index.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "Core" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/core` is a core package that contains game main loop. It is used to initialize the game and run it. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/core -yarn add @nanoforge-dev/core -pnpm add @nanoforge-dev/core -bun add @nanoforge-dev/core -``` - -## Example usage - -Initialize the game in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - await app.init(options); - - await app.run(); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/core -[npm]: https://www.npmjs.com/package/@nanoforge-dev/core -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/core/NanoforgeClient.mdx b/references/1.4.0/core/NanoforgeClient.mdx deleted file mode 100644 index eab01be..0000000 --- a/references/1.4.0/core/NanoforgeClient.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "NanoforgeClient class" -icon: "box" -description: "Client-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeClient - -## Summary - -Client-side NanoForge application. -## Signature - -```typescript -declare class NanoforgeClient extends NanoforgeApplication -``` - -## Methods - -### useGraphics - -Register the graphics library used to render the game. - -### useInput - -Register the input library used to read keyboard and mouse state. - -### useSound - -Register the sound-effect library. - -## Remarks - - Extends `NanoforgeApplication` with client-specific library slots for graphics, input, and sound. Create an instance via `NanoforgeFactory.createClient`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/core/NanoforgeClient/useGraphics.mdx b/references/1.4.0/core/NanoforgeClient/useGraphics.mdx deleted file mode 100644 index ce92bfb..0000000 --- a/references/1.4.0/core/NanoforgeClient/useGraphics.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useGraphics" -icon: "function" -description: "Register the graphics library used to render the game." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useGraphics - -## Summary - -Register the graphics library used to render the game. -## Signature - -```typescript -useGraphics(library: IGraphicsLibrary): void; -``` - -## Parameters - -### library -**Type**:`IGraphicsLibrary` - -Graphics library instance (e.g. Graphics2DLibrary). - -## Returns - -**Type**:`void` - -Register the graphics library used to render the game. \ No newline at end of file diff --git a/references/1.4.0/core/NanoforgeClient/useInput.mdx b/references/1.4.0/core/NanoforgeClient/useInput.mdx deleted file mode 100644 index 2e014a7..0000000 --- a/references/1.4.0/core/NanoforgeClient/useInput.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useInput" -icon: "function" -description: "Register the input library used to read keyboard and mouse state." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useInput - -## Summary - -Register the input library used to read keyboard and mouse state. -## Signature - -```typescript -useInput(library: IInputLibrary): void; -``` - -## Parameters - -### library -**Type**:`IInputLibrary` - -Input library instance (e.g. InputLibrary). - -## Returns - -**Type**:`void` - -Register the input library used to read keyboard and mouse state. \ No newline at end of file diff --git a/references/1.4.0/core/NanoforgeClient/useSound.mdx b/references/1.4.0/core/NanoforgeClient/useSound.mdx deleted file mode 100644 index 30f6b34..0000000 --- a/references/1.4.0/core/NanoforgeClient/useSound.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useSound" -icon: "function" -description: "Register the sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useSound - -## Summary - -Register the sound-effect library. -## Signature - -```typescript -useSound(library: ISoundLibrary): void; -``` - -## Parameters - -### library -**Type**:`ISoundLibrary` - -Sound library instance (e.g. SoundLibrary). - -## Returns - -**Type**:`void` - -Register the sound-effect library. \ No newline at end of file diff --git a/references/1.4.0/core/NanoforgeFactory.mdx b/references/1.4.0/core/NanoforgeFactory.mdx deleted file mode 100644 index a383a67..0000000 --- a/references/1.4.0/core/NanoforgeFactory.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeFactory variable" -icon: "variable" -description: "Singleton factory for creating NanoForge client and server applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeFactory - -## Summary - -Singleton factory for creating NanoForge client and server applications. -## Signature - -```typescript -NanoforgeFactory: NanoforgeFactoryStatic -``` - -## Remarks - - Use `NanoforgeFactory.createClient` or `NanoforgeFactory.createServer` to obtain a new application instance, then attach libraries and call `init` / `run`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/core/NanoforgeServer.mdx b/references/1.4.0/core/NanoforgeServer.mdx deleted file mode 100644 index 5430293..0000000 --- a/references/1.4.0/core/NanoforgeServer.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeServer class" -icon: "box" -description: "Server-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeServer - -## Summary - -Server-side NanoForge application. -## Signature - -```typescript -declare class NanoforgeServer extends NanoforgeApplication -``` - -## Remarks - - Extends `NanoforgeApplication` for use in Node.js server processes. Create an instance via `NanoforgeFactory.createServer`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-client/0-index.mdx b/references/1.4.0/ecs-client/0-index.mdx deleted file mode 100644 index fb79025..0000000 --- a/references/1.4.0/ecs-client/0-index.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Ecs Client" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-client` is a wrapper of `@nanoforge-dev/ecs-lib` for client-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-client -yarn add @nanoforge-dev/ecs-client -pnpm add @nanoforge-dev/ecs-client -bun add @nanoforge-dev/ecs-client -``` - -## Example usage - -Initialize the library in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSClientLibrary } from "@nanoforge-dev/ecs-client"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const ecs = new ECSClientLibrary(); - - app.useComponentSystem(ecs); - - await app.init(options); - - const registry = ecs.registry; - - const entity = registry.spawnEntity(); - registry.addComponent(entity, new ExampleComponent("foo", 42)); - - registry.addSystem(exampleSystem); - - await app.run(); -} -``` - -With component - -```ts -export class ExampleComponent { - name = this.constructor.name; - - constructor( - public paramA: string, - public paramB: number, - public paramC: boolean = false, - ) {} - - get foo() { - return "bar"; - } - - get paramAOrDefault() { - return this.paramC ? this.paramA : "default"; - } - - addOne() { - this.paramB += 1; - } -} -``` - -And system - -```ts -export const exampleSystem = (registry: Registry, ctx: Context) => { - const entities = registry.getZipper([ExampleComponent]); - - entities.forEach((entity) => { - if (entity.ExampleComponent.paramA === "end") { - ctx.app.setIsRunning(false); - return; - } - - if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end"; - - if (entity.ExampleComponent.paramB >= 0) - entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1; - }); -}; -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-client -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-client -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/ecs-client/ECSClientLibrary.mdx b/references/1.4.0/ecs-client/ECSClientLibrary.mdx deleted file mode 100644 index d87f98e..0000000 --- a/references/1.4.0/ecs-client/ECSClientLibrary.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ECSClientLibrary class" -icon: "box" -description: "Client-side ECS library backed by the compiled WASM module." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ECSClientLibrary - -## Summary - -Client-side ECS library backed by the compiled WASM module. -## Signature - -```typescript -declare class ECSClientLibrary extends AbstractECSLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Remarks - - Loads `libecs.wasm` from the asset manager and initialises the entity registry. Register with the application: Access the registry in game code: \ No newline at end of file diff --git a/references/1.4.0/ecs-client/ECSClientLibrary/constructor.mdx b/references/1.4.0/ecs-client/ECSClientLibrary/constructor.mdx deleted file mode 100644 index 259968e..0000000 --- a/references/1.4.0/ecs-client/ECSClientLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ECSClientLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ECSClientLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/0-index.mdx b/references/1.4.0/ecs-lib/0-index.mdx deleted file mode 100644 index 54a7543..0000000 --- a/references/1.4.0/ecs-lib/0-index.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "Ecs Lib" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-lib` is a powerful data structure for managing game entities. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-lib -yarn add @nanoforge-dev/ecs-lib -pnpm add @nanoforge-dev/ecs-lib -bun add @nanoforge-dev/ecs-lib -``` - -## Warning - -This library is not usable on its own. You must use either the [ECS Client][ecs-client] or [ECS Server][ecs-server]. - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-lib -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-lib -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md -[ecs-client]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-client -[ecs-server]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-server diff --git a/references/1.4.0/ecs-lib/AbstractECSLibrary.mdx b/references/1.4.0/ecs-lib/AbstractECSLibrary.mdx deleted file mode 100644 index 73fd0d9..0000000 --- a/references/1.4.0/ecs-lib/AbstractECSLibrary.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "AbstractECSLibrary class" -icon: "box" -description: "Abstract base class for WASM-backed ECS (Entity Component System) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# AbstractECSLibrary - -## Summary - -Abstract base class for WASM-backed ECS (Entity Component System) libraries. -## Signature - -```typescript -declare abstract class AbstractECSLibrary extends BaseComponentSystemLibrary -``` - -## Constructors - -### constructor -**Modifiers**: protected - -Constructs a new instance of the class - -## Properties - -### _registry -**Modifiers**: protected -**Type**:`protected _registry?: Registry;` -**Optional**: Yes - - - -### module -**Modifiers**: protected -**Type**:`protected module?: MainModule;` -**Optional**: Yes - - - -### path -**Modifiers**: protected -**Type**:`protected path: string;` - - - -### registry -**Modifiers**: readonly -**Type**:`get registry(): Registry;` - -The WASM-backed entity/component registry. - -## Remarks - - Loads a compiled `libecs.wasm` binary via the asset manager and initialises a `Registry` from the resulting module. Concrete subclasses only need to set `this.path` (the asset path to the `.wasm` file) and call `super()` — see `ECSClientLibrary` and `ECSServerLibrary`. Requires the `ASSET_MANAGER_LIBRARY` dependency and runs after `GRAPHICS_LIBRARY`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/AbstractECSLibrary/_registry.mdx b/references/1.4.0/ecs-lib/AbstractECSLibrary/_registry.mdx deleted file mode 100644 index 342b7fc..0000000 --- a/references/1.4.0/ecs-lib/AbstractECSLibrary/_registry.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "_registry" -icon: "variable" -description: "_registry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _registry \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/AbstractECSLibrary/constructor.mdx b/references/1.4.0/ecs-lib/AbstractECSLibrary/constructor.mdx deleted file mode 100644 index 8b8f644..0000000 --- a/references/1.4.0/ecs-lib/AbstractECSLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the AbstractECSLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `AbstractECSLibrary` class -## Signature - -```typescript -protected constructor(); -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/AbstractECSLibrary/module.mdx b/references/1.4.0/ecs-lib/AbstractECSLibrary/module.mdx deleted file mode 100644 index ec9dbeb..0000000 --- a/references/1.4.0/ecs-lib/AbstractECSLibrary/module.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "module" -icon: "variable" -description: "module API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# module \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/AbstractECSLibrary/path.mdx b/references/1.4.0/ecs-lib/AbstractECSLibrary/path.mdx deleted file mode 100644 index 914b96c..0000000 --- a/references/1.4.0/ecs-lib/AbstractECSLibrary/path.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "path" -icon: "variable" -description: "path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# path \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/AbstractECSLibrary/registry.mdx b/references/1.4.0/ecs-lib/AbstractECSLibrary/registry.mdx deleted file mode 100644 index 9926955..0000000 --- a/references/1.4.0/ecs-lib/AbstractECSLibrary/registry.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "registry" -icon: "variable" -description: "The WASM-backed entity/component registry." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registry - -## Summary - -The WASM-backed entity/component registry. - -## Remarks - - Use this to spawn entities, register components, add systems, and query component data. \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Component.mdx b/references/1.4.0/ecs-lib/Component.mdx deleted file mode 100644 index d75478d..0000000 --- a/references/1.4.0/ecs-lib/Component.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Component type" -icon: "file-code" -description: "Component API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Component -## Signature - -```typescript -type Component = { - name: string; - [key: string]: any; -}; -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/EditorComponentManifest.mdx b/references/1.4.0/ecs-lib/EditorComponentManifest.mdx deleted file mode 100644 index 34e71a1..0000000 --- a/references/1.4.0/ecs-lib/EditorComponentManifest.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "EditorComponentManifest type" -icon: "file-code" -description: "Manifest for a component to be used in the NanoForge Editor" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorComponentManifest - -## Summary - -Manifest for a component to be used in the NanoForge Editor -## Signature - -```typescript -type EditorComponentManifest = { - name: string; - description?: string; - params: ECSElement[]; -}; -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/EditorSystemManifest.mdx b/references/1.4.0/ecs-lib/EditorSystemManifest.mdx deleted file mode 100644 index b8631d9..0000000 --- a/references/1.4.0/ecs-lib/EditorSystemManifest.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "EditorSystemManifest type" -icon: "file-code" -description: "Manifest for a system to be used in the NanoForge Editor" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorSystemManifest - -## Summary - -Manifest for a system to be used in the NanoForge Editor -## Signature - -```typescript -type EditorSystemManifest = { - name: string; - description?: string; - dependencies: string[]; -}; -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Entity.mdx b/references/1.4.0/ecs-lib/Entity.mdx deleted file mode 100644 index b30bd3a..0000000 --- a/references/1.4.0/ecs-lib/Entity.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Entity interface" -icon: "plug" -description: "Entity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Entity -## Signature - -```typescript -interface Entity extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Entity/getId.mdx b/references/1.4.0/ecs-lib/Entity/getId.mdx deleted file mode 100644 index b363787..0000000 --- a/references/1.4.0/ecs-lib/Entity/getId.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getId" -icon: "file" -description: "getId API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getId - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry.mdx b/references/1.4.0/ecs-lib/Registry.mdx deleted file mode 100644 index b505c2e..0000000 --- a/references/1.4.0/ecs-lib/Registry.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Registry interface" -icon: "plug" -description: "Registry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Registry -## Signature - -```typescript -interface Registry extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/addComponent.mdx b/references/1.4.0/ecs-lib/Registry/addComponent.mdx deleted file mode 100644 index 938d691..0000000 --- a/references/1.4.0/ecs-lib/Registry/addComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "addComponent" -icon: "file" -description: "addComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# addComponent - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/addSystem.mdx b/references/1.4.0/ecs-lib/Registry/addSystem.mdx deleted file mode 100644 index 72af2a6..0000000 --- a/references/1.4.0/ecs-lib/Registry/addSystem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "addSystem" -icon: "file" -description: "addSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# addSystem - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/clearEntities.mdx b/references/1.4.0/ecs-lib/Registry/clearEntities.mdx deleted file mode 100644 index 9b5c9d6..0000000 --- a/references/1.4.0/ecs-lib/Registry/clearEntities.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clearEntities" -icon: "file" -description: "clearEntities API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clearEntities - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/clearSystems.mdx b/references/1.4.0/ecs-lib/Registry/clearSystems.mdx deleted file mode 100644 index 8e0053d..0000000 --- a/references/1.4.0/ecs-lib/Registry/clearSystems.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clearSystems" -icon: "file" -description: "clearSystems API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clearSystems - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/entityFromIndex.mdx b/references/1.4.0/ecs-lib/Registry/entityFromIndex.mdx deleted file mode 100644 index 5746a8c..0000000 --- a/references/1.4.0/ecs-lib/Registry/entityFromIndex.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "entityFromIndex" -icon: "file" -description: "entityFromIndex API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# entityFromIndex - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/getComponents.mdx b/references/1.4.0/ecs-lib/Registry/getComponents.mdx deleted file mode 100644 index 7e2eb0c..0000000 --- a/references/1.4.0/ecs-lib/Registry/getComponents.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getComponents" -icon: "file" -description: "getComponents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponents - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/getComponentsConst.mdx b/references/1.4.0/ecs-lib/Registry/getComponentsConst.mdx deleted file mode 100644 index c0c5e75..0000000 --- a/references/1.4.0/ecs-lib/Registry/getComponentsConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getComponentsConst" -icon: "file" -description: "getComponentsConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentsConst - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/getEntityComponent.mdx b/references/1.4.0/ecs-lib/Registry/getEntityComponent.mdx deleted file mode 100644 index 65648c3..0000000 --- a/references/1.4.0/ecs-lib/Registry/getEntityComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getEntityComponent" -icon: "file" -description: "getEntityComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getEntityComponent - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/getEntityComponentConst.mdx b/references/1.4.0/ecs-lib/Registry/getEntityComponentConst.mdx deleted file mode 100644 index de8259d..0000000 --- a/references/1.4.0/ecs-lib/Registry/getEntityComponentConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getEntityComponentConst" -icon: "file" -description: "getEntityComponentConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getEntityComponentConst - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/getIndexedZipper.mdx b/references/1.4.0/ecs-lib/Registry/getIndexedZipper.mdx deleted file mode 100644 index 8232fdb..0000000 --- a/references/1.4.0/ecs-lib/Registry/getIndexedZipper.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getIndexedZipper" -icon: "file" -description: "getIndexedZipper API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getIndexedZipper - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/getZipper.mdx b/references/1.4.0/ecs-lib/Registry/getZipper.mdx deleted file mode 100644 index f7a918c..0000000 --- a/references/1.4.0/ecs-lib/Registry/getZipper.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getZipper" -icon: "file" -description: "getZipper API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getZipper - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/killEntity.mdx b/references/1.4.0/ecs-lib/Registry/killEntity.mdx deleted file mode 100644 index 4979d97..0000000 --- a/references/1.4.0/ecs-lib/Registry/killEntity.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "killEntity" -icon: "file" -description: "killEntity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# killEntity - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/maxEntities.mdx b/references/1.4.0/ecs-lib/Registry/maxEntities.mdx deleted file mode 100644 index f1eb150..0000000 --- a/references/1.4.0/ecs-lib/Registry/maxEntities.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "maxEntities" -icon: "file" -description: "maxEntities API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# maxEntities - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/registerComponent.mdx b/references/1.4.0/ecs-lib/Registry/registerComponent.mdx deleted file mode 100644 index b0540e5..0000000 --- a/references/1.4.0/ecs-lib/Registry/registerComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "registerComponent" -icon: "file" -description: "registerComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registerComponent - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/removeComponent.mdx b/references/1.4.0/ecs-lib/Registry/removeComponent.mdx deleted file mode 100644 index 0efa117..0000000 --- a/references/1.4.0/ecs-lib/Registry/removeComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "removeComponent" -icon: "file" -description: "removeComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# removeComponent - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/removeSystem.mdx b/references/1.4.0/ecs-lib/Registry/removeSystem.mdx deleted file mode 100644 index fea7019..0000000 --- a/references/1.4.0/ecs-lib/Registry/removeSystem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "removeSystem" -icon: "file" -description: "removeSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# removeSystem - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/runSystems.mdx b/references/1.4.0/ecs-lib/Registry/runSystems.mdx deleted file mode 100644 index 4a391a1..0000000 --- a/references/1.4.0/ecs-lib/Registry/runSystems.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "runSystems" -icon: "file" -description: "runSystems API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# runSystems - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/Registry/spawnEntity.mdx b/references/1.4.0/ecs-lib/Registry/spawnEntity.mdx deleted file mode 100644 index 183b6f5..0000000 --- a/references/1.4.0/ecs-lib/Registry/spawnEntity.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "spawnEntity" -icon: "file" -description: "spawnEntity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# spawnEntity - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray.mdx b/references/1.4.0/ecs-lib/SparseArray.mdx deleted file mode 100644 index 48d747f..0000000 --- a/references/1.4.0/ecs-lib/SparseArray.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "SparseArray interface" -icon: "plug" -description: "SparseArray API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SparseArray -## Signature - -```typescript -interface SparseArray extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/clear.mdx b/references/1.4.0/ecs-lib/SparseArray/clear.mdx deleted file mode 100644 index 782f12a..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/clear.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clear" -icon: "file" -description: "clear API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clear - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/empty.mdx b/references/1.4.0/ecs-lib/SparseArray/empty.mdx deleted file mode 100644 index 860f54e..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/empty.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "empty" -icon: "file" -description: "empty API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# empty - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/erase.mdx b/references/1.4.0/ecs-lib/SparseArray/erase.mdx deleted file mode 100644 index 289e964..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/erase.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "erase" -icon: "file" -description: "erase API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# erase - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/get.mdx b/references/1.4.0/ecs-lib/SparseArray/get.mdx deleted file mode 100644 index 18a25bc..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/get.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "get" -icon: "file" -description: "get API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# get - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/getConst.mdx b/references/1.4.0/ecs-lib/SparseArray/getConst.mdx deleted file mode 100644 index 3314654..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/getConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getConst" -icon: "file" -description: "getConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConst - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/getIndex.mdx b/references/1.4.0/ecs-lib/SparseArray/getIndex.mdx deleted file mode 100644 index e6a39d6..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/getIndex.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getIndex" -icon: "file" -description: "getIndex API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getIndex - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/insertAt.mdx b/references/1.4.0/ecs-lib/SparseArray/insertAt.mdx deleted file mode 100644 index 9a5e08b..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/insertAt.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "insertAt" -icon: "file" -description: "insertAt API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# insertAt - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/insertAt_1.mdx b/references/1.4.0/ecs-lib/SparseArray/insertAt_1.mdx deleted file mode 100644 index 9a5e08b..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/insertAt_1.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "insertAt" -icon: "file" -description: "insertAt API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# insertAt - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/resize.mdx b/references/1.4.0/ecs-lib/SparseArray/resize.mdx deleted file mode 100644 index 6e14c19..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/resize.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "resize" -icon: "file" -description: "resize API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# resize - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/set.mdx b/references/1.4.0/ecs-lib/SparseArray/set.mdx deleted file mode 100644 index 008ca6e..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/set.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "set" -icon: "file" -description: "set API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# set - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/setByCopy.mdx b/references/1.4.0/ecs-lib/SparseArray/setByCopy.mdx deleted file mode 100644 index 0da1576..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/setByCopy.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "setByCopy" -icon: "file" -description: "setByCopy API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setByCopy - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/setByMove.mdx b/references/1.4.0/ecs-lib/SparseArray/setByMove.mdx deleted file mode 100644 index d6bb457..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/setByMove.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "setByMove" -icon: "file" -description: "setByMove API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setByMove - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/SparseArray/size.mdx b/references/1.4.0/ecs-lib/SparseArray/size.mdx deleted file mode 100644 index c4186f7..0000000 --- a/references/1.4.0/ecs-lib/SparseArray/size.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "size" -icon: "file" -description: "size API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# size - -## Description \ No newline at end of file diff --git a/references/1.4.0/ecs-lib/System.mdx b/references/1.4.0/ecs-lib/System.mdx deleted file mode 100644 index b171106..0000000 --- a/references/1.4.0/ecs-lib/System.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "System type" -icon: "file-code" -description: "System API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# System -## Signature - -```typescript -type System = (registry: Registry, ctx: Context) => void; -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-server/0-index.mdx b/references/1.4.0/ecs-server/0-index.mdx deleted file mode 100644 index 7c57a23..0000000 --- a/references/1.4.0/ecs-server/0-index.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Ecs Server" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-server` is a wrapper of `@nanoforge-dev/ecs-lib` for server-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-server -yarn add @nanoforge-dev/ecs-server -pnpm add @nanoforge-dev/ecs-server -bun add @nanoforge-dev/ecs-server -``` - -## Example usage - -Initialize the library in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSServerLibrary } from "@nanoforge-dev/ecs-server"; - -export async function main(options: IRunServerOptions) { - const app = NanoforgeFactory.createServer(); - - const ecs = new ECSServerLibrary(); - - app.useComponentSystem(ecs); - - await app.init(options); - - const registry = ecs.registry; - - const entity = registry.spawnEntity(); - registry.addComponent(entity, new ExampleComponent("foo", 42)); - - registry.addSystem(exampleSystem); - - await app.run(); -} -``` - -With component - -```ts -export class ExampleComponent { - name = this.constructor.name; - - constructor( - public paramA: string, - public paramB: number, - public paramC: boolean = false, - ) {} - - get foo() { - return "bar"; - } - - get paramAOrDefault() { - return this.paramC ? this.paramA : "default"; - } - - addOne() { - this.paramB += 1; - } -} -``` - -And system - -```ts -export const exampleSystem = (registry: Registry, ctx: Context) => { - const entities = registry.getZipper([ExampleComponent]); - - entities.forEach((entity) => { - if (entity.ExampleComponent.paramA === "end") { - ctx.app.setIsRunning(false); - return; - } - - if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end"; - - if (entity.ExampleComponent.paramB >= 0) - entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1; - }); -}; -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-server -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-server -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/ecs-server/ECSServerLibrary.mdx b/references/1.4.0/ecs-server/ECSServerLibrary.mdx deleted file mode 100644 index ae983c6..0000000 --- a/references/1.4.0/ecs-server/ECSServerLibrary.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ECSServerLibrary class" -icon: "box" -description: "Server-side ECS library backed by the compiled WASM module." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ECSServerLibrary - -## Summary - -Server-side ECS library backed by the compiled WASM module. -## Signature - -```typescript -declare class ECSServerLibrary extends AbstractECSLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Remarks - - Loads `libecs.wasm` from the asset manager and initialises the entity registry. Register with the application: Access the registry in game code: \ No newline at end of file diff --git a/references/1.4.0/ecs-server/ECSServerLibrary/constructor.mdx b/references/1.4.0/ecs-server/ECSServerLibrary/constructor.mdx deleted file mode 100644 index ce0d21c..0000000 --- a/references/1.4.0/ecs-server/ECSServerLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ECSServerLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ECSServerLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.0/ecs-server/Module.mdx b/references/1.4.0/ecs-server/Module.mdx deleted file mode 100644 index ee8d98d..0000000 --- a/references/1.4.0/ecs-server/Module.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Module variable" -icon: "variable" -description: "Module API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Module -## Signature - -```typescript -Module: typeof MainModuleFactory -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/0-index.mdx b/references/1.4.0/graphics-2d/0-index.mdx deleted file mode 100644 index b0c8cd7..0000000 --- a/references/1.4.0/graphics-2d/0-index.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "Graphics 2d" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/graphics-2d` is a base 2D graphics library. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/graphics-2d -yarn add @nanoforge-dev/graphics-2d -pnpm add @nanoforge-dev/graphics-2d -bun add @nanoforge-dev/graphics-2d -``` - -## Example usage - -Initialize the library in your main file with a red circle. - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSClientLibrary } from "@nanoforge-dev/ecs-client"; -import { Circle, Graphics2DLibrary, Layer } from "@nanoforge-dev/graphics-2d"; - -import { CircleComponent } from "./components/CircleComponent"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const ecs = new ECSClientLibrary(); - const graphics = new Graphics2DLibrary(); - - app.useComponentSystem(ecs); - app.useGraphics(graphics); - - await app.init(options); - - const registry = ecs.registry; - - const layer = new Layer(); - graphics.stage.add(layer); - - const entity = registry.spawnEntity(); - registry.addComponent( - entity, - new CircleComponent( - new Circle({ - radius: 70, - fill: "red", - }), - layer, - ), - ); - - await app.run(); -} -``` - -With circle component defined. - -```ts -import { type Circle, type Layer } from "@nanoforge-dev/graphics-2d"; - -export class CircleComponent { - name = "CircleComponent"; - component: Circle; - - constructor(component: Circle, layer: Layer) { - this.component = component; - layer.add(this.component); - } -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/graphics-2d -[npm]: https://www.npmjs.com/package/@nanoforge-dev/graphics-2d -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/graphics-2d/Animation_2.mdx b/references/1.4.0/graphics-2d/Animation_2.mdx deleted file mode 100644 index ddfaad5..0000000 --- a/references/1.4.0/graphics-2d/Animation_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Animation_2 variable" -icon: "variable" -description: "Animation_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Animation_2 -## Signature - -```typescript -Animation: typeof import("konva/lib/Animation").Animation -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Arc.mdx b/references/1.4.0/graphics-2d/Arc.mdx deleted file mode 100644 index cddf460..0000000 --- a/references/1.4.0/graphics-2d/Arc.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Arc variable" -icon: "variable" -description: "Arc API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Arc -## Signature - -```typescript -Arc: typeof import("konva/lib/shapes/Arc").Arc -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/ArcConfig.mdx b/references/1.4.0/graphics-2d/ArcConfig.mdx deleted file mode 100644 index 54071ac..0000000 --- a/references/1.4.0/graphics-2d/ArcConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ArcConfig type" -icon: "file-code" -description: "ArcConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ArcConfig -## Signature - -```typescript -type ArcConfig = Konva.ArcConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Arrow.mdx b/references/1.4.0/graphics-2d/Arrow.mdx deleted file mode 100644 index 3dfb8ec..0000000 --- a/references/1.4.0/graphics-2d/Arrow.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Arrow variable" -icon: "variable" -description: "Arrow API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Arrow -## Signature - -```typescript -Arrow: typeof import("konva/lib/shapes/Arrow").Arrow -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/ArrowConfig.mdx b/references/1.4.0/graphics-2d/ArrowConfig.mdx deleted file mode 100644 index 140f1f8..0000000 --- a/references/1.4.0/graphics-2d/ArrowConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ArrowConfig type" -icon: "file-code" -description: "ArrowConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ArrowConfig -## Signature - -```typescript -type ArrowConfig = Konva.ArrowConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Canvas.mdx b/references/1.4.0/graphics-2d/Canvas.mdx deleted file mode 100644 index 592d424..0000000 --- a/references/1.4.0/graphics-2d/Canvas.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Canvas variable" -icon: "variable" -description: "Canvas API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Canvas -## Signature - -```typescript -Canvas: typeof import("konva/lib/Canvas").Canvas -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Circle.mdx b/references/1.4.0/graphics-2d/Circle.mdx deleted file mode 100644 index d3294b9..0000000 --- a/references/1.4.0/graphics-2d/Circle.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Circle variable" -icon: "variable" -description: "Circle API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Circle -## Signature - -```typescript -Circle: typeof import("konva/lib/shapes/Circle").Circle -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/CircleConfig.mdx b/references/1.4.0/graphics-2d/CircleConfig.mdx deleted file mode 100644 index 9167a16..0000000 --- a/references/1.4.0/graphics-2d/CircleConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "CircleConfig type" -icon: "file-code" -description: "CircleConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# CircleConfig -## Signature - -```typescript -type CircleConfig = Konva.CircleConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Container.mdx b/references/1.4.0/graphics-2d/Container.mdx deleted file mode 100644 index 2a95a85..0000000 --- a/references/1.4.0/graphics-2d/Container.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Container variable" -icon: "variable" -description: "Container API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Container -## Signature - -```typescript -Container: typeof import("konva/lib/Container").Container -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/ContainerConfig.mdx b/references/1.4.0/graphics-2d/ContainerConfig.mdx deleted file mode 100644 index a11d9c9..0000000 --- a/references/1.4.0/graphics-2d/ContainerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ContainerConfig type" -icon: "file-code" -description: "ContainerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ContainerConfig -## Signature - -```typescript -type ContainerConfig = Konva.ContainerConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Context.mdx b/references/1.4.0/graphics-2d/Context.mdx deleted file mode 100644 index cdb9dcd..0000000 --- a/references/1.4.0/graphics-2d/Context.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Context variable" -icon: "variable" -description: "Context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Context -## Signature - -```typescript -Context: typeof import("konva/lib/Context").Context -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/DD.mdx b/references/1.4.0/graphics-2d/DD.mdx deleted file mode 100644 index 8983841..0000000 --- a/references/1.4.0/graphics-2d/DD.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "DD variable" -icon: "variable" -description: "DD API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# DD -## Signature - -```typescript -DD: { - readonly isDragging: boolean; - justDragged: boolean; - readonly node: import("konva/lib/Node").Node | undefined; - _dragElements: Map; - _drag(evt: any): void; - _endDragBefore(evt?: any): void; - _endDragAfter(evt: any): void; -} -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Easings.mdx b/references/1.4.0/graphics-2d/Easings.mdx deleted file mode 100644 index 5a6a492..0000000 --- a/references/1.4.0/graphics-2d/Easings.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Easings variable" -icon: "variable" -description: "Easings API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Easings -## Signature - -```typescript -Easings: { - BackEaseIn(t: any, b: any, c: any, d: any): any; - BackEaseOut(t: any, b: any, c: any, d: any): any; - BackEaseInOut(t: any, b: any, c: any, d: any): any; - ElasticEaseIn(t: any, b: any, c: any, d: any, a: any, p: any): any; - ElasticEaseOut(t: any, b: any, c: any, d: any, a: any, p: any): any; - ElasticEaseInOut(t: any, b: any, c: any, d: any, a: any, p: any): any; - BounceEaseOut(t: any, b: any, c: any, d: any): any; - BounceEaseIn(t: any, b: any, c: any, d: any): any; - BounceEaseInOut(t: any, b: any, c: any, d: any): any; - EaseIn(t: any, b: any, c: any, d: any): any; - EaseOut(t: any, b: any, c: any, d: any): any; - EaseInOut(t: any, b: any, c: any, d: any): any; - StrongEaseIn(t: any, b: any, c: any, d: any): any; - StrongEaseOut(t: any, b: any, c: any, d: any): any; - StrongEaseInOut(t: any, b: any, c: any, d: any): any; - Linear(t: any, b: any, c: any, d: any): any; -} -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Ellipse.mdx b/references/1.4.0/graphics-2d/Ellipse.mdx deleted file mode 100644 index 96fe50c..0000000 --- a/references/1.4.0/graphics-2d/Ellipse.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Ellipse variable" -icon: "variable" -description: "Ellipse API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Ellipse -## Signature - -```typescript -Ellipse: typeof import("konva/lib/shapes/Ellipse").Ellipse -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/EllipseConfig.mdx b/references/1.4.0/graphics-2d/EllipseConfig.mdx deleted file mode 100644 index 3bf17e4..0000000 --- a/references/1.4.0/graphics-2d/EllipseConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "EllipseConfig type" -icon: "file-code" -description: "EllipseConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EllipseConfig -## Signature - -```typescript -type EllipseConfig = Konva.EllipseConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/FastLayer.mdx b/references/1.4.0/graphics-2d/FastLayer.mdx deleted file mode 100644 index 58f0ee3..0000000 --- a/references/1.4.0/graphics-2d/FastLayer.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "FastLayer variable" -icon: "variable" -description: "FastLayer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# FastLayer -## Signature - -```typescript -FastLayer: typeof import("konva/lib/FastLayer").FastLayer -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Filters.mdx b/references/1.4.0/graphics-2d/Filters.mdx deleted file mode 100644 index 094d800..0000000 --- a/references/1.4.0/graphics-2d/Filters.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "Filters variable" -icon: "variable" -description: "Filters API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Filters -## Signature - -```typescript -Filters: { - Blur: import("konva/lib/Node").Filter; - Brightness: import("konva/lib/Node").Filter; - Brighten: import("konva/lib/Node").Filter; - Contrast: import("konva/lib/Node").Filter; - Emboss: import("konva/lib/Node").Filter; - Enhance: import("konva/lib/Node").Filter; - Grayscale: import("konva/lib/Node").Filter; - HSL: import("konva/lib/Node").Filter; - HSV: import("konva/lib/Node").Filter; - Invert: import("konva/lib/Node").Filter; - Kaleidoscope: import("konva/lib/Node").Filter; - Mask: import("konva/lib/Node").Filter; - Noise: import("konva/lib/Node").Filter; - Pixelate: import("konva/lib/Node").Filter; - Posterize: import("konva/lib/Node").Filter; - RGB: import("konva/lib/Node").Filter; - RGBA: import("konva/lib/Node").Filter; - Sepia: import("konva/lib/Node").Filter; - Solarize: import("konva/lib/Node").Filter; - Threshold: import("konva/lib/Node").Filter; -} -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Graphics2DLibrary.mdx b/references/1.4.0/graphics-2d/Graphics2DLibrary.mdx deleted file mode 100644 index 25ca61d..0000000 --- a/references/1.4.0/graphics-2d/Graphics2DLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Graphics2DLibrary class" -icon: "box" -description: "Built-in 2D graphics library powered by \\Konva\\." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Graphics2DLibrary - -## Summary - -Built-in 2D graphics library powered by [Konva](https://konvajs.org/). -## Signature - -```typescript -declare class Graphics2DLibrary extends BaseGraphicsLibrary -``` - -## Properties - -### baseLayer -**Modifiers**: readonly -**Type**:`get baseLayer(): Layer;` - -The default Konva automatically added to the stage. - -### stage -**Modifiers**: readonly -**Type**:`get stage(): Stage;` - -The Konva that covers the container element. - -## Remarks - - Creates a full-window Konva `Stage` and a default `Layer` during initialisation. Game code interacts with the stage and layer directly to add shapes, images, and animations. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Graphics2DLibrary/baseLayer.mdx b/references/1.4.0/graphics-2d/Graphics2DLibrary/baseLayer.mdx deleted file mode 100644 index ee1d43e..0000000 --- a/references/1.4.0/graphics-2d/Graphics2DLibrary/baseLayer.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "baseLayer" -icon: "variable" -description: "The default Konva Layer automatically added to the stage." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# baseLayer - -## Summary - -The default Konva `Layer` automatically added to the stage. - -## Remarks - - Add shapes and nodes to this layer for them to appear on screen. \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Graphics2DLibrary/stage.mdx b/references/1.4.0/graphics-2d/Graphics2DLibrary/stage.mdx deleted file mode 100644 index 5459bea..0000000 --- a/references/1.4.0/graphics-2d/Graphics2DLibrary/stage.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "stage" -icon: "variable" -description: "The Konva Stage that covers the container element." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# stage - -## Summary - -The Konva `Stage` that covers the container element. - -## Remarks - - Initialised to the container's `offsetWidth` × `offsetHeight` dimensions. \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Group.mdx b/references/1.4.0/graphics-2d/Group.mdx deleted file mode 100644 index 94194fa..0000000 --- a/references/1.4.0/graphics-2d/Group.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Group variable" -icon: "variable" -description: "Group API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Group -## Signature - -```typescript -Group: typeof import("konva/lib/Group").Group -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/GroupConfig.mdx b/references/1.4.0/graphics-2d/GroupConfig.mdx deleted file mode 100644 index e92337a..0000000 --- a/references/1.4.0/graphics-2d/GroupConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "GroupConfig type" -icon: "file-code" -description: "GroupConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# GroupConfig -## Signature - -```typescript -type GroupConfig = Konva.GroupConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/ImageConfig.mdx b/references/1.4.0/graphics-2d/ImageConfig.mdx deleted file mode 100644 index 74c67ae..0000000 --- a/references/1.4.0/graphics-2d/ImageConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ImageConfig type" -icon: "file-code" -description: "ImageConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ImageConfig -## Signature - -```typescript -type ImageConfig = Konva.ImageConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Image_2.mdx b/references/1.4.0/graphics-2d/Image_2.mdx deleted file mode 100644 index bf8a296..0000000 --- a/references/1.4.0/graphics-2d/Image_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Image_2 variable" -icon: "variable" -description: "Image_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Image_2 -## Signature - -```typescript -Image: typeof import("konva/lib/shapes/Image").Image -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/KonvaEventListener.mdx b/references/1.4.0/graphics-2d/KonvaEventListener.mdx deleted file mode 100644 index f83cdd1..0000000 --- a/references/1.4.0/graphics-2d/KonvaEventListener.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaEventListener type" -icon: "file-code" -description: "KonvaEventListener API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaEventListener -## Signature - -```typescript -type KonvaEventListener = Konva.KonvaEventListener; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/KonvaEventObject.mdx b/references/1.4.0/graphics-2d/KonvaEventObject.mdx deleted file mode 100644 index 24c346c..0000000 --- a/references/1.4.0/graphics-2d/KonvaEventObject.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaEventObject type" -icon: "file-code" -description: "KonvaEventObject API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaEventObject -## Signature - -```typescript -type KonvaEventObject = Konva.KonvaEventObject; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/KonvaPointerEvent.mdx b/references/1.4.0/graphics-2d/KonvaPointerEvent.mdx deleted file mode 100644 index d52579e..0000000 --- a/references/1.4.0/graphics-2d/KonvaPointerEvent.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaPointerEvent type" -icon: "file-code" -description: "KonvaPointerEvent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaPointerEvent -## Signature - -```typescript -type KonvaPointerEvent = Konva.KonvaPointerEvent; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Label.mdx b/references/1.4.0/graphics-2d/Label.mdx deleted file mode 100644 index b91d661..0000000 --- a/references/1.4.0/graphics-2d/Label.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Label variable" -icon: "variable" -description: "Label API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Label -## Signature - -```typescript -Label: typeof import("konva/lib/shapes/Label").Label -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/LabelConfig.mdx b/references/1.4.0/graphics-2d/LabelConfig.mdx deleted file mode 100644 index a5d1db5..0000000 --- a/references/1.4.0/graphics-2d/LabelConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LabelConfig type" -icon: "file-code" -description: "LabelConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LabelConfig -## Signature - -```typescript -type LabelConfig = Konva.LabelConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Layer.mdx b/references/1.4.0/graphics-2d/Layer.mdx deleted file mode 100644 index f0cbecc..0000000 --- a/references/1.4.0/graphics-2d/Layer.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Layer variable" -icon: "variable" -description: "Layer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Layer -## Signature - -```typescript -Layer: typeof import("konva/lib/Layer").Layer -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/LayerConfig.mdx b/references/1.4.0/graphics-2d/LayerConfig.mdx deleted file mode 100644 index b6a810a..0000000 --- a/references/1.4.0/graphics-2d/LayerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LayerConfig type" -icon: "file-code" -description: "LayerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LayerConfig -## Signature - -```typescript -type LayerConfig = Konva.LayerConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Line.mdx b/references/1.4.0/graphics-2d/Line.mdx deleted file mode 100644 index 76b62aa..0000000 --- a/references/1.4.0/graphics-2d/Line.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Line variable" -icon: "variable" -description: "Line API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Line -## Signature - -```typescript -Line: typeof import("konva/lib/shapes/Line").Line -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/LineConfig.mdx b/references/1.4.0/graphics-2d/LineConfig.mdx deleted file mode 100644 index a475417..0000000 --- a/references/1.4.0/graphics-2d/LineConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LineConfig type" -icon: "file-code" -description: "LineConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LineConfig -## Signature - -```typescript -type LineConfig = Konva.LineConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/NodeConfig.mdx b/references/1.4.0/graphics-2d/NodeConfig.mdx deleted file mode 100644 index 164684e..0000000 --- a/references/1.4.0/graphics-2d/NodeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "NodeConfig type" -icon: "file-code" -description: "NodeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NodeConfig -## Signature - -```typescript -type NodeConfig = Konva.NodeConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Node_2.mdx b/references/1.4.0/graphics-2d/Node_2.mdx deleted file mode 100644 index cc2dab3..0000000 --- a/references/1.4.0/graphics-2d/Node_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Node_2 variable" -icon: "variable" -description: "Node_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Node_2 -## Signature - -```typescript -Node: typeof import("konva/lib/Node").Node -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Path.mdx b/references/1.4.0/graphics-2d/Path.mdx deleted file mode 100644 index 70ac7a1..0000000 --- a/references/1.4.0/graphics-2d/Path.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Path variable" -icon: "variable" -description: "Path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Path -## Signature - -```typescript -Path: typeof import("konva/lib/shapes/Path").Path -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/PathConfig.mdx b/references/1.4.0/graphics-2d/PathConfig.mdx deleted file mode 100644 index 3f882ea..0000000 --- a/references/1.4.0/graphics-2d/PathConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "PathConfig type" -icon: "file-code" -description: "PathConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# PathConfig -## Signature - -```typescript -type PathConfig = Konva.PathConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Rect.mdx b/references/1.4.0/graphics-2d/Rect.mdx deleted file mode 100644 index e35794b..0000000 --- a/references/1.4.0/graphics-2d/Rect.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Rect variable" -icon: "variable" -description: "Rect API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Rect -## Signature - -```typescript -Rect: typeof import("konva/lib/shapes/Rect").Rect -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/RectConfig.mdx b/references/1.4.0/graphics-2d/RectConfig.mdx deleted file mode 100644 index d4c77fe..0000000 --- a/references/1.4.0/graphics-2d/RectConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RectConfig type" -icon: "file-code" -description: "RectConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RectConfig -## Signature - -```typescript -type RectConfig = Konva.RectConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/RegularPolygon.mdx b/references/1.4.0/graphics-2d/RegularPolygon.mdx deleted file mode 100644 index 9e94364..0000000 --- a/references/1.4.0/graphics-2d/RegularPolygon.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RegularPolygon variable" -icon: "variable" -description: "RegularPolygon API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RegularPolygon -## Signature - -```typescript -RegularPolygon: typeof import("konva/lib/shapes/RegularPolygon").RegularPolygon -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/RegularPolygonConfig.mdx b/references/1.4.0/graphics-2d/RegularPolygonConfig.mdx deleted file mode 100644 index 7eb0178..0000000 --- a/references/1.4.0/graphics-2d/RegularPolygonConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RegularPolygonConfig type" -icon: "file-code" -description: "RegularPolygonConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RegularPolygonConfig -## Signature - -```typescript -type RegularPolygonConfig = Konva.RegularPolygonConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Ring.mdx b/references/1.4.0/graphics-2d/Ring.mdx deleted file mode 100644 index 9b1d5e7..0000000 --- a/references/1.4.0/graphics-2d/Ring.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Ring variable" -icon: "variable" -description: "Ring API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Ring -## Signature - -```typescript -Ring: typeof import("konva/lib/shapes/Ring").Ring -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/RingConfig.mdx b/references/1.4.0/graphics-2d/RingConfig.mdx deleted file mode 100644 index c2d879c..0000000 --- a/references/1.4.0/graphics-2d/RingConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RingConfig type" -icon: "file-code" -description: "RingConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RingConfig -## Signature - -```typescript -type RingConfig = Konva.RingConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Shape.mdx b/references/1.4.0/graphics-2d/Shape.mdx deleted file mode 100644 index 327ffa8..0000000 --- a/references/1.4.0/graphics-2d/Shape.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Shape variable" -icon: "variable" -description: "Shape API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Shape -## Signature - -```typescript -Shape: typeof import("konva/lib/Shape").Shape -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/ShapeConfig.mdx b/references/1.4.0/graphics-2d/ShapeConfig.mdx deleted file mode 100644 index 0dbffd4..0000000 --- a/references/1.4.0/graphics-2d/ShapeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ShapeConfig type" -icon: "file-code" -description: "ShapeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ShapeConfig -## Signature - -```typescript -type ShapeConfig = Konva.ShapeConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Sprite.mdx b/references/1.4.0/graphics-2d/Sprite.mdx deleted file mode 100644 index b18d1db..0000000 --- a/references/1.4.0/graphics-2d/Sprite.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Sprite variable" -icon: "variable" -description: "Sprite API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Sprite -## Signature - -```typescript -Sprite: typeof import("konva/lib/shapes/Sprite").Sprite -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/SpriteConfig.mdx b/references/1.4.0/graphics-2d/SpriteConfig.mdx deleted file mode 100644 index 5897d55..0000000 --- a/references/1.4.0/graphics-2d/SpriteConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "SpriteConfig type" -icon: "file-code" -description: "SpriteConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SpriteConfig -## Signature - -```typescript -type SpriteConfig = Konva.SpriteConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Stage.mdx b/references/1.4.0/graphics-2d/Stage.mdx deleted file mode 100644 index cd1c1df..0000000 --- a/references/1.4.0/graphics-2d/Stage.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Stage variable" -icon: "variable" -description: "Stage API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Stage -## Signature - -```typescript -Stage: typeof import("konva/lib/Stage").Stage -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/StageConfig.mdx b/references/1.4.0/graphics-2d/StageConfig.mdx deleted file mode 100644 index c2105e1..0000000 --- a/references/1.4.0/graphics-2d/StageConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "StageConfig type" -icon: "file-code" -description: "StageConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# StageConfig -## Signature - -```typescript -type StageConfig = Konva.StageConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Star.mdx b/references/1.4.0/graphics-2d/Star.mdx deleted file mode 100644 index 411028f..0000000 --- a/references/1.4.0/graphics-2d/Star.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Star variable" -icon: "variable" -description: "Star API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Star -## Signature - -```typescript -Star: typeof import("konva/lib/shapes/Star").Star -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/StarConfig.mdx b/references/1.4.0/graphics-2d/StarConfig.mdx deleted file mode 100644 index 8d2636b..0000000 --- a/references/1.4.0/graphics-2d/StarConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "StarConfig type" -icon: "file-code" -description: "StarConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# StarConfig -## Signature - -```typescript -type StarConfig = Konva.StarConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Tag.mdx b/references/1.4.0/graphics-2d/Tag.mdx deleted file mode 100644 index 24c03f4..0000000 --- a/references/1.4.0/graphics-2d/Tag.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Tag variable" -icon: "variable" -description: "Tag API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Tag -## Signature - -```typescript -Tag: typeof import("konva/lib/shapes/Label").Tag -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/TagConfig.mdx b/references/1.4.0/graphics-2d/TagConfig.mdx deleted file mode 100644 index 21aba79..0000000 --- a/references/1.4.0/graphics-2d/TagConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TagConfig type" -icon: "file-code" -description: "TagConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TagConfig -## Signature - -```typescript -type TagConfig = Konva.TagConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/TextConfig.mdx b/references/1.4.0/graphics-2d/TextConfig.mdx deleted file mode 100644 index 83d8699..0000000 --- a/references/1.4.0/graphics-2d/TextConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextConfig type" -icon: "file-code" -description: "TextConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextConfig -## Signature - -```typescript -type TextConfig = Konva.TextConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/TextPath.mdx b/references/1.4.0/graphics-2d/TextPath.mdx deleted file mode 100644 index 6864b49..0000000 --- a/references/1.4.0/graphics-2d/TextPath.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextPath variable" -icon: "variable" -description: "TextPath API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextPath -## Signature - -```typescript -TextPath: typeof import("konva/lib/shapes/TextPath").TextPath -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/TextPathConfig.mdx b/references/1.4.0/graphics-2d/TextPathConfig.mdx deleted file mode 100644 index 8fd12d5..0000000 --- a/references/1.4.0/graphics-2d/TextPathConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextPathConfig type" -icon: "file-code" -description: "TextPathConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextPathConfig -## Signature - -```typescript -type TextPathConfig = Konva.TextPathConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Text_2.mdx b/references/1.4.0/graphics-2d/Text_2.mdx deleted file mode 100644 index 6d6f2ce..0000000 --- a/references/1.4.0/graphics-2d/Text_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Text_2 variable" -icon: "variable" -description: "Text_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Text_2 -## Signature - -```typescript -Text: typeof import("konva/lib/shapes/Text").Text -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Transform.mdx b/references/1.4.0/graphics-2d/Transform.mdx deleted file mode 100644 index 3986d65..0000000 --- a/references/1.4.0/graphics-2d/Transform.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Transform variable" -icon: "variable" -description: "Transform API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Transform -## Signature - -```typescript -Transform: typeof import("konva/lib/Util").Transform -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/TransformerConfig.mdx b/references/1.4.0/graphics-2d/TransformerConfig.mdx deleted file mode 100644 index 2b3334a..0000000 --- a/references/1.4.0/graphics-2d/TransformerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TransformerConfig type" -icon: "file-code" -description: "TransformerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TransformerConfig -## Signature - -```typescript -type TransformerConfig = Konva.TransformerConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Transformer_2.mdx b/references/1.4.0/graphics-2d/Transformer_2.mdx deleted file mode 100644 index a676e31..0000000 --- a/references/1.4.0/graphics-2d/Transformer_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Transformer_2 variable" -icon: "variable" -description: "Transformer_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Transformer_2 -## Signature - -```typescript -Transformer: typeof import("konva/lib/shapes/Transformer").Transformer -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Tween.mdx b/references/1.4.0/graphics-2d/Tween.mdx deleted file mode 100644 index 25c1ada..0000000 --- a/references/1.4.0/graphics-2d/Tween.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Tween variable" -icon: "variable" -description: "Tween API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Tween -## Signature - -```typescript -Tween: typeof import("konva/lib/Tween").Tween -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/TweenConfig.mdx b/references/1.4.0/graphics-2d/TweenConfig.mdx deleted file mode 100644 index ed4ae96..0000000 --- a/references/1.4.0/graphics-2d/TweenConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TweenConfig type" -icon: "file-code" -description: "TweenConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TweenConfig -## Signature - -```typescript -type TweenConfig = Konva.TweenConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Util.mdx b/references/1.4.0/graphics-2d/Util.mdx deleted file mode 100644 index 4d6d059..0000000 --- a/references/1.4.0/graphics-2d/Util.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Util variable" -icon: "variable" -description: "Util API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Util -## Signature - -```typescript -Util: { - _isElement(obj: any): obj is Element; - _isFunction(obj: any): boolean; - _isPlainObject(obj: any): boolean; - _isArray(obj: any): obj is Array; - _isNumber(obj: any): obj is number; - _isString(obj: any): obj is string; - _isBoolean(obj: any): obj is boolean; - isObject(val: any): val is object; - isValidSelector(selector: any): boolean; - _sign(number: number): 1 | -1; - requestAnimFrame(callback: Function): void; - createCanvasElement(): HTMLCanvasElement; - createImageElement(): HTMLImageElement; - _isInDocument(el: any): boolean; - _urlToImage(url: string, callback: Function): void; - _rgbToHex(r: number, g: number, b: number): string; - _hexToRgb(hex: string): import("konva/lib/types").RGB; - getRandomColor(): string; - isCanvasFarblingActive(): boolean; - getHitColor(): string; - getHitColorKey(r: number, g: number, b: number): string; - getSnappedHexColor(hex: string): string; - getRGB(color: string): import("konva/lib/types").RGB; - colorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _namedColorToRBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | null; - _rgbColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _rgbaColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex8ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex6ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex4ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex3ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hslColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - haveIntersection(r1: import("konva/lib/types").IRect, r2: import("konva/lib/types").IRect): boolean; - cloneObject(obj: Any): Any; - cloneArray(arr: Array): any[]; - degToRad(deg: number): number; - radToDeg(rad: number): number; - _degToRad(deg: number): number; - _radToDeg(rad: number): number; - _getRotation(radians: number): number; - _capitalize(str: string): string; - throw(str: string): never; - error(str: string): void; - warn(str: string): void; - each(obj: object, func: Function): void; - _inRange(val: number, left: number, right: number): boolean; - _getProjectionToSegment(x1: any, y1: any, x2: any, y2: any, x3: any, y3: any): any[]; - _getProjectionToLine(pt: import("konva/lib/types").Vector2d, line: Array, isClosed: boolean): import("konva/lib/types").Vector2d; - _prepareArrayForTween(startArray: any, endArray: any, isClosed: any): number[]; - _prepareToStringify(obj: any): T | null; - _assign(target: T, source: U): T & U; - _getFirstPointerId(evt: any): any; - releaseCanvas(...canvases: HTMLCanvasElement[]): void; - drawRoundedRectPath(context: import("konva/lib/Context").Context, width: number, height: number, cornerRadius: number | number[]): void; - drawRoundedPolygonPath(context: import("konva/lib/Context").Context, points: import("konva/lib/types").Vector2d[], sides: number, radius: number, cornerRadius: number | number[]): void; -} -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Vector2d.mdx b/references/1.4.0/graphics-2d/Vector2d.mdx deleted file mode 100644 index 4e2e07d..0000000 --- a/references/1.4.0/graphics-2d/Vector2d.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Vector2d type" -icon: "file-code" -description: "Vector2d API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Vector2d -## Signature - -```typescript -type Vector2d = Konva.Vector2d; -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/Wedge.mdx b/references/1.4.0/graphics-2d/Wedge.mdx deleted file mode 100644 index 6083fc3..0000000 --- a/references/1.4.0/graphics-2d/Wedge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Wedge variable" -icon: "variable" -description: "Wedge API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Wedge -## Signature - -```typescript -Wedge: typeof import("konva/lib/shapes/Wedge").Wedge -``` \ No newline at end of file diff --git a/references/1.4.0/graphics-2d/WedgeConfig.mdx b/references/1.4.0/graphics-2d/WedgeConfig.mdx deleted file mode 100644 index 8d8e8b9..0000000 --- a/references/1.4.0/graphics-2d/WedgeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "WedgeConfig type" -icon: "file-code" -description: "WedgeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# WedgeConfig -## Signature - -```typescript -type WedgeConfig = Konva.WedgeConfig; -``` \ No newline at end of file diff --git a/references/1.4.0/input/0-index.mdx b/references/1.4.0/input/0-index.mdx deleted file mode 100644 index 78e9f6d..0000000 --- a/references/1.4.0/input/0-index.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Input" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/input` is an input manager for handling keyboard and mouse events. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/input -yarn add @nanoforge-dev/input -pnpm add @nanoforge-dev/input -bun add @nanoforge-dev/input -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { InputLibrary } from "@nanoforge-dev/input"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const input = new InputLibrary(); - - app.useInput(input); - - await app.init(options); - - await app.run(); -} -``` - -Use to check for key presses - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const input = ctx.libs.getInput(); - - const isArrowUpPressed = input.isKeyPressed(InputEnum.ArrowUp); - - // Do something with the input -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/input -[npm]: https://www.npmjs.com/package/@nanoforge-dev/input -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/input/InputEnum.mdx b/references/1.4.0/input/InputEnum.mdx deleted file mode 100644 index 3f4cba1..0000000 --- a/references/1.4.0/input/InputEnum.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: "InputEnum enum" -icon: "list" -description: "Enumeration of keyboard keys and mouse buttons supported by InputLibrary." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InputEnum - -## Summary - -Enumeration of keyboard keys and mouse buttons supported by `InputLibrary`. - -## Members -| Member | Description | -| ------ | ----------- | -| `AltLeft` | | -| `AltRight` | | -| `ArrowDown` | | -| `ArrowLeft` | | -| `ArrowRight` | | -| `ArrowUp` | | -| `AudioVolumeMute` | | -| `Back` | | -| `Backquote` | | -| `Backslash` | | -| `Backspace` | | -| `BracketLeft` | | -| `BracketRight` | | -| `BrowserBack` | | -| `BrowserFavorites` | | -| `BrowserForward` | | -| `BrowserHome` | | -| `BrowserRefresh` | | -| `BrowserSearch` | | -| `BrowserStop` | | -| `CapsLock` | | -| `Comma` | | -| `ContextMenu` | | -| `ControlLeft` | | -| `ControlRight` | | -| `Convert` | | -| `Delete` | | -| `Digit0` | | -| `Digit1` | | -| `Digit2` | | -| `Digit3` | | -| `Digit4` | | -| `Digit5` | | -| `Digit6` | | -| `Digit7` | | -| `Digit8` | | -| `Digit9` | | -| `End` | | -| `Enter` | | -| `Equal` | | -| `Escape` | | -| `F1` | | -| `F10` | | -| `F11` | | -| `F12` | | -| `F13` | | -| `F14` | | -| `F15` | | -| `F16` | | -| `F17` | | -| `F18` | | -| `F19` | | -| `F2` | | -| `F20` | | -| `F21` | | -| `F22` | | -| `F23` | | -| `F24` | | -| `F3` | | -| `F4` | | -| `F5` | | -| `F6` | | -| `F7` | | -| `F8` | | -| `F9` | | -| `Forward` | | -| `Home` | | -| `Insert` | | -| `IntlBackslash` | | -| `IntlRo` | | -| `IntlYen` | | -| `KanaMode` | | -| `KeyA` | | -| `KeyB` | | -| `KeyC` | | -| `KeyD` | | -| `KeyE` | | -| `KeyF` | | -| `KeyG` | | -| `KeyH` | | -| `KeyI` | | -| `KeyJ` | | -| `KeyK` | | -| `KeyL` | | -| `KeyM` | | -| `KeyN` | | -| `KeyO` | | -| `KeyP` | | -| `KeyQ` | | -| `KeyR` | | -| `KeyS` | | -| `KeyT` | | -| `KeyU` | | -| `KeyV` | | -| `KeyW` | | -| `KeyX` | | -| `KeyY` | | -| `KeyZ` | | -| `Lang1` | | -| `Lang2` | | -| `LaunchApp1` | | -| `LaunchApp2` | | -| `LaunchMail` | | -| `MediaPlayPause` | | -| `MediaStop` | | -| `MediaTrackNext` | | -| `MediaTrackPrevious` | | -| `MetaLeft` | | -| `MetaRight` | | -| `Minus` | | -| `MouseLeft` | | -| `MouseMiddle` | | -| `MouseRight` | | -| `NonConvert` | | -| `NumLock` | | -| `Numpad0` | | -| `Numpad1` | | -| `Numpad2` | | -| `Numpad3` | | -| `Numpad4` | | -| `Numpad5` | | -| `Numpad6` | | -| `Numpad7` | | -| `Numpad8` | | -| `Numpad9` | | -| `NumpadAdd` | | -| `NumpadComma` | | -| `NumpadDecimal` | | -| `NumpadDivide` | | -| `NumpadEnter` | | -| `NumpadEqual` | | -| `NumpadMultiply` | | -| `NumpadSubtract` | | -| `PageDown` | | -| `PageUp` | | -| `Pause` | | -| `Period` | | -| `Power` | | -| `PrintScreen` | | -| `Quote` | | -| `ScrollLock` | | -| `Semicolon` | | -| `ShiftLeft` | | -| `ShiftRight` | | -| `Slash` | | -| `Space` | | -| `Tab` | | - -## Remarks - - Values correspond to the `KeyboardEvent.code` string for keyboard keys and to synthetic button identifiers for mouse buttons. Use with `InputLibrary.isKeyPressed` and `InputLibrary.isDragging`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary.mdx b/references/1.4.0/input/InputLibrary.mdx deleted file mode 100644 index 5f59d81..0000000 --- a/references/1.4.0/input/InputLibrary.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "InputLibrary class" -icon: "box" -description: "Built-in input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InputLibrary - -## Summary - -Built-in input library. -## Signature - -```typescript -declare class InputLibrary extends BaseInputLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getDragState - -Return the current drag state. - -### getMousePosition - -Return the current mouse cursor position. - -### getMouseState - -Return the full mouse state snapshot for the current frame. - -### getPressedKeys - -Return a list of all keys and mouse buttons that are currently pressed. - -### getWheelState - -Return the scroll-wheel state accumulated during the current frame. - -### isDragging - -Return whether a drag operation is in progress. - -### isKeyPressed - -Return whether a key or mouse button is currently held down. - -## Remarks - - Listens to browser `keydown`, `keyup`, `mousedown`, `mouseup`, `mousemove`, and `wheel` events and exposes a per-frame snapshot of the current input state. Must be registered after the graphics library because it uses `runAfter: [GRAPHICS_LIBRARY]`. Register with the application: Access in a system's `__run` hook: \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary/constructor.mdx b/references/1.4.0/input/InputLibrary/constructor.mdx deleted file mode 100644 index 5182682..0000000 --- a/references/1.4.0/input/InputLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the InputLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `InputLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary/getDragState.mdx b/references/1.4.0/input/InputLibrary/getDragState.mdx deleted file mode 100644 index 22815ac..0000000 --- a/references/1.4.0/input/InputLibrary/getDragState.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getDragState" -icon: "function" -description: "Return the current drag state." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getDragState - -## Summary - -Return the current drag state. -## Signature - -```typescript -getDragState(): DragState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`DragState` - -Return the current drag state. \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary/getMousePosition.mdx b/references/1.4.0/input/InputLibrary/getMousePosition.mdx deleted file mode 100644 index 11f70d7..0000000 --- a/references/1.4.0/input/InputLibrary/getMousePosition.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "getMousePosition" -icon: "function" -description: "Return the current mouse cursor position." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMousePosition - -## Summary - -Return the current mouse cursor position. -## Signature - -```typescript -getMousePosition(): { - x: number; - y: number; - }; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**: - -```typescript -{ - x: number; - y: number; - } -``` - - -Return the current mouse cursor position. \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary/getMouseState.mdx b/references/1.4.0/input/InputLibrary/getMouseState.mdx deleted file mode 100644 index 32127b9..0000000 --- a/references/1.4.0/input/InputLibrary/getMouseState.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMouseState" -icon: "function" -description: "Return the full mouse state snapshot for the current frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMouseState - -## Summary - -Return the full mouse state snapshot for the current frame. -## Signature - -```typescript -getMouseState(): MouseState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`MouseState` - -Return the full mouse state snapshot for the current frame. \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary/getPressedKeys.mdx b/references/1.4.0/input/InputLibrary/getPressedKeys.mdx deleted file mode 100644 index 4f3d1d6..0000000 --- a/references/1.4.0/input/InputLibrary/getPressedKeys.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getPressedKeys" -icon: "function" -description: "Return a list of all keys and mouse buttons that are currently pressed." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getPressedKeys - -## Summary - -Return a list of all keys and mouse buttons that are currently pressed. -## Signature - -```typescript -getPressedKeys(): InputEnum[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`InputEnum[]` - -Return a list of all keys and mouse buttons that are currently pressed. \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary/getWheelState.mdx b/references/1.4.0/input/InputLibrary/getWheelState.mdx deleted file mode 100644 index 6d68d7c..0000000 --- a/references/1.4.0/input/InputLibrary/getWheelState.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getWheelState" -icon: "function" -description: "Return the scroll-wheel state accumulated during the current frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getWheelState - -## Summary - -Return the scroll-wheel state accumulated during the current frame. -## Signature - -```typescript -getWheelState(): WheelState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`WheelState` - -Return the scroll-wheel state accumulated during the current frame. - -## Remarks - - All deltas are reset to `0` at the start of the next frame. \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary/isDragging.mdx b/references/1.4.0/input/InputLibrary/isDragging.mdx deleted file mode 100644 index 7315313..0000000 --- a/references/1.4.0/input/InputLibrary/isDragging.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "isDragging" -icon: "function" -description: "Return whether a drag operation is in progress." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isDragging - -## Summary - -Return whether a drag operation is in progress. -## Signature - -```typescript -isDragging(button?: InputEnum): boolean; -``` - -## Parameters - -### button -**Type**:`InputEnum` -**Optional**: Yes - -If provided, only returns true when a drag was started with this specific button. - -## Returns - -**Type**:`boolean` - -Return whether a drag operation is in progress. \ No newline at end of file diff --git a/references/1.4.0/input/InputLibrary/isKeyPressed.mdx b/references/1.4.0/input/InputLibrary/isKeyPressed.mdx deleted file mode 100644 index 85eb226..0000000 --- a/references/1.4.0/input/InputLibrary/isKeyPressed.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "isKeyPressed" -icon: "function" -description: "Return whether a key or mouse button is currently held down." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isKeyPressed - -## Summary - -Return whether a key or mouse button is currently held down. -## Signature - -```typescript -isKeyPressed(key: InputEnum): boolean | undefined; -``` - -## Parameters - -### key -**Type**:`InputEnum` - -The key or button to query (see InputEnum). - -## Returns - -**Type**:`boolean | undefined` - -Return whether a key or mouse button is currently held down. \ No newline at end of file diff --git a/references/1.4.0/music/0-index.mdx b/references/1.4.0/music/0-index.mdx deleted file mode 100644 index c76aa73..0000000 --- a/references/1.4.0/music/0-index.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "Music" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/music` is a music player for your game. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/music -yarn add @nanoforge-dev/music -pnpm add @nanoforge-dev/music -bun add @nanoforge-dev/music -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { MusicLibrary } from "@nanoforge-dev/music"; - -export const MUSIC_SYM = Symbol("music"); - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const assetManager = new AssetManagerLibrary(); - const music = new MusicLibrary(); - - app.useAssetManager(assetManager); - app.use(MUSIC_SYM, music); - - await app.init(options); - - music.load("music", assetManager.getAsset("/path/to/music.mp3").path); - - await app.run(); -} -``` - -Use to play music - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - const music = ctx.libs.get(MUSIC_SYM); - - music.play("music"); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/music -[npm]: https://www.npmjs.com/package/@nanoforge-dev/music -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/music/MusicLibrary.mdx b/references/1.4.0/music/MusicLibrary.mdx deleted file mode 100644 index ee8ccc9..0000000 --- a/references/1.4.0/music/MusicLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "MusicLibrary class" -icon: "box" -description: "Built-in music library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# MusicLibrary - -## Summary - -Built-in music library. -## Signature - -```typescript -declare class MusicLibrary extends BaseMusicLibrary -``` - -## Methods - -### load - -Register a music track under a unique key. - -### mute - -Toggle the muted state of all loaded music tracks. - -### play - -Stop the currently playing track and start the requested one. - -## Remarks - - Manages a collection of named `HTMLAudioElement` instances and ensures only one track plays at a time. Load tracks with `load` and start playback with `play`. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.0/music/MusicLibrary/load.mdx b/references/1.4.0/music/MusicLibrary/load.mdx deleted file mode 100644 index 9d2bba2..0000000 --- a/references/1.4.0/music/MusicLibrary/load.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "load" -icon: "function" -description: "Register a music track under a unique key." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# load - -## Summary - -Register a music track under a unique key. -## Signature - -```typescript -load(music: string, file: string): void; -``` - -## Parameters - -### music -**Type**:`string` - -Unique key used to reference this track (e.g. "theme"). - -### file -**Type**:`string` - -URL or path to the audio file. - -## Returns - -**Type**:`void` - -Register a music track under a unique key. - -## Remarks - - Creates an `HTMLAudioElement` from the provided URL. The track respects the current muted state at load time. \ No newline at end of file diff --git a/references/1.4.0/music/MusicLibrary/mute.mdx b/references/1.4.0/music/MusicLibrary/mute.mdx deleted file mode 100644 index 982880b..0000000 --- a/references/1.4.0/music/MusicLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded music tracks." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded music tracks. -## Signature - -```typescript -mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded music tracks. \ No newline at end of file diff --git a/references/1.4.0/music/MusicLibrary/play.mdx b/references/1.4.0/music/MusicLibrary/play.mdx deleted file mode 100644 index 441f600..0000000 --- a/references/1.4.0/music/MusicLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Stop the currently playing track and start the requested one." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Stop the currently playing track and start the requested one. -## Signature - -```typescript -play(music: string): void; -``` - -## Parameters - -### music -**Type**:`string` - -Key that identifies the track (as passed to load). - -## Returns - -**Type**:`void` - -Stop the currently playing track and start the requested one. \ No newline at end of file diff --git a/references/1.4.0/network-client/0-index.mdx b/references/1.4.0/network-client/0-index.mdx deleted file mode 100644 index 3b234ab..0000000 --- a/references/1.4.0/network-client/0-index.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "Network Client" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/network-client` is a network lib with tcp and udp support for client-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/network-client -yarn add @nanoforge-dev/network-client -pnpm add @nanoforge-dev/network-client -bun add @nanoforge-dev/network-client -``` - -## Example usage - -Initilize the library in your main file. - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkClientLibrary } from "@nanoforge-dev/network-client"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const network = new NetworkClientLibrary(); - - app.useNetwork(network); - - await app.init(options); - - await app.run(); -} -``` - -Use to receive packets - -```ts -export function myReceiveSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - network.tcp.getReceivedPackets().forEach((packet) => { - const data = JSON.parse(new TextDecoder().decode(packet)); - // Do something with the data - }); -} -``` - -Use to send packets - -```ts -export function mySendSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - // Do something to get a data - const packet = new TextEncoder().encode(JSON.stringify(data)); - network.tcp.sendPacket(packet); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-client -[npm]: https://www.npmjs.com/package/@nanoforge-dev/network-client -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/network-client/NetworkClientLibrary.mdx b/references/1.4.0/network-client/NetworkClientLibrary.mdx deleted file mode 100644 index f37e2d1..0000000 --- a/references/1.4.0/network-client/NetworkClientLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "NetworkClientLibrary class" -icon: "box" -description: "Built-in network library for client-side applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NetworkClientLibrary - -## Summary - -Built-in network library for client-side applications. -## Signature - -```typescript -declare class NetworkClientLibrary extends BaseNetworkLibrary -``` - -## Properties - -### tcp -**Type**:`tcp: TCPClient;` - -Reliable, ordered WebSocket-based connection to the server. - -### udp -**Type**:`udp: UDPClient;` - -Unreliable, unordered WebRTC data-channel connection to the server. - -## Remarks - - Reads network configuration from the environment via `ClientConfigNetwork` and automatically connects to the server over TCP (WebSocket), UDP (WebRTC data channel), or both. Register with: Configuration (via environment variables): - `SERVER_ADDRESS` — hostname or IP of the server (required). - `SERVER_TCP_PORT` — WebSocket port for TCP (optional). - `SERVER_UDP_PORT` — signaling port for UDP/WebRTC (optional). - `MAGIC_VALUE` — packet framing delimiter (default: `"PACKET_END"`). - `WSS` — set to `"true"` to use `wss://` / `https://` (default: `false`). After `init`, access the connections via `tcp` and `udp`. \ No newline at end of file diff --git a/references/1.4.0/network-client/NetworkClientLibrary/tcp.mdx b/references/1.4.0/network-client/NetworkClientLibrary/tcp.mdx deleted file mode 100644 index b681439..0000000 --- a/references/1.4.0/network-client/NetworkClientLibrary/tcp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "tcp" -icon: "variable" -description: "Reliable, ordered WebSocket-based connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# tcp - -## Summary - -Reliable, ordered WebSocket-based connection to the server. - -## Remarks - - Only available when `SERVER_TCP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.0/network-client/NetworkClientLibrary/udp.mdx b/references/1.4.0/network-client/NetworkClientLibrary/udp.mdx deleted file mode 100644 index 234baaf..0000000 --- a/references/1.4.0/network-client/NetworkClientLibrary/udp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "udp" -icon: "variable" -description: "Unreliable, unordered WebRTC data-channel connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# udp - -## Summary - -Unreliable, unordered WebRTC data-channel connection to the server. - -## Remarks - - Only available when `SERVER_UDP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.0/network-client/TCPClient.mdx b/references/1.4.0/network-client/TCPClient.mdx deleted file mode 100644 index 15ab23e..0000000 --- a/references/1.4.0/network-client/TCPClient.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "TCPClient class" -icon: "box" -description: "Reliable, ordered WebSocket-based client connection to a NanoForge TCP server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TCPClient - -## Summary - -Reliable, ordered WebSocket-based client connection to a NanoForge TCP server. -## Signature - -```typescript -declare class TCPClient -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### connect - -Initiate a WebSocket connection to the server. - -### getReceivedPackets - -Parse and return all complete packets received since the last call. - -### isConnected - -Return when the underlying WebSocket is open. - -### sendData - -Send a payload to the server. - -## Remarks - - Packets are framed with a configurable magic delimiter so that partial WebSocket frames can be reassembled. The connection is established by calling `connect` and status can be queried with `isConnected`. Typical usage is through `NetworkClientLibrary` which instantiates and connects this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.0/network-client/TCPClient/connect.mdx b/references/1.4.0/network-client/TCPClient/connect.mdx deleted file mode 100644 index 895e5f5..0000000 --- a/references/1.4.0/network-client/TCPClient/connect.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "connect" -icon: "function" -description: "Initiate a WebSocket connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# connect - -## Summary - -Initiate a WebSocket connection to the server. -## Signature - -```typescript -connect(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Initiate a WebSocket connection to the server. - -## Remarks - - Connects to `ws[s]://:`. Resolves as soon as the connection attempt is dispatched (the socket may not be fully open yet — check `isConnected`). \ No newline at end of file diff --git a/references/1.4.0/network-client/TCPClient/constructor.mdx b/references/1.4.0/network-client/TCPClient/constructor.mdx deleted file mode 100644 index f12435d..0000000 --- a/references/1.4.0/network-client/TCPClient/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the TCPClient class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `TCPClient` class -## Signature - -```typescript -constructor(_port: number, _ip: string, magicValue: string, _wss: boolean); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _ip -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _wss -- **Type**:`boolean` \ No newline at end of file diff --git a/references/1.4.0/network-client/TCPClient/getReceivedPackets.mdx b/references/1.4.0/network-client/TCPClient/getReceivedPackets.mdx deleted file mode 100644 index 01155c8..0000000 --- a/references/1.4.0/network-client/TCPClient/getReceivedPackets.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return all complete packets received since the last call." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return all complete packets received since the last call. -## Signature - -```typescript -getReceivedPackets(): Uint8Array[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Uint8Array[]` - -Parse and return all complete packets received since the last call. - -## Remarks - - Partial packets are retained internally and combined with future chunks until they are complete. Call this method once per frame. \ No newline at end of file diff --git a/references/1.4.0/network-client/TCPClient/isConnected.mdx b/references/1.4.0/network-client/TCPClient/isConnected.mdx deleted file mode 100644 index 30d6bd7..0000000 --- a/references/1.4.0/network-client/TCPClient/isConnected.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isConnected" -icon: "function" -description: "Return true when the underlying WebSocket is open." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isConnected - -## Summary - -Return `true` when the underlying WebSocket is open. -## Signature - -```typescript -isConnected(): boolean; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`boolean` - -Return when the underlying WebSocket is open. \ No newline at end of file diff --git a/references/1.4.0/network-client/TCPClient/sendData.mdx b/references/1.4.0/network-client/TCPClient/sendData.mdx deleted file mode 100644 index da18065..0000000 --- a/references/1.4.0/network-client/TCPClient/sendData.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "sendData" -icon: "function" -description: "Send a payload to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendData - -## Summary - -Send a payload to the server. -## Signature - -```typescript -sendData(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to the server. - -## Remarks - - The payload is wrapped in a magic framing packet before being sent. \ No newline at end of file diff --git a/references/1.4.0/network-client/UDPClient.mdx b/references/1.4.0/network-client/UDPClient.mdx deleted file mode 100644 index 51f4853..0000000 --- a/references/1.4.0/network-client/UDPClient.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "UDPClient class" -icon: "box" -description: "Unreliable, unordered WebRTC data-channel client connection to a NanoForge UDP server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# UDPClient - -## Summary - -Unreliable, unordered WebRTC data-channel client connection to a NanoForge UDP server. -## Signature - -```typescript -declare class UDPClient -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### connect - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. - -### getReceivedPackets - -Parse and return all complete packets received since the last call. - -### isConnected - -Return when the RTCDataChannel is open. - -### sendData - -Send a payload on the data channel. - -## Remarks - - Uses a WebSocket signaling channel to perform the SDP/ICE handshake and then communicates over an RTCDataChannel with `ordered: false` and `maxRetransmits: 0` for minimal latency. Typical usage is through `NetworkClientLibrary` which instantiates and connects this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.0/network-client/UDPClient/connect.mdx b/references/1.4.0/network-client/UDPClient/connect.mdx deleted file mode 100644 index eada6f5..0000000 --- a/references/1.4.0/network-client/UDPClient/connect.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "connect" -icon: "function" -description: "Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# connect - -## Summary - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. -## Signature - -```typescript -connect(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. - -## Remarks - - Resolves once the offer has been dispatched. The data channel may become open shortly after — check `isConnected`. \ No newline at end of file diff --git a/references/1.4.0/network-client/UDPClient/constructor.mdx b/references/1.4.0/network-client/UDPClient/constructor.mdx deleted file mode 100644 index 8009fa3..0000000 --- a/references/1.4.0/network-client/UDPClient/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the UDPClient class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `UDPClient` class -## Signature - -```typescript -constructor(_port: number, _ip: string, magicValue: string, _wss: boolean); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _ip -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _wss -- **Type**:`boolean` \ No newline at end of file diff --git a/references/1.4.0/network-client/UDPClient/getReceivedPackets.mdx b/references/1.4.0/network-client/UDPClient/getReceivedPackets.mdx deleted file mode 100644 index 01155c8..0000000 --- a/references/1.4.0/network-client/UDPClient/getReceivedPackets.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return all complete packets received since the last call." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return all complete packets received since the last call. -## Signature - -```typescript -getReceivedPackets(): Uint8Array[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Uint8Array[]` - -Parse and return all complete packets received since the last call. - -## Remarks - - Partial packets are retained internally and combined with future chunks until they are complete. Call this method once per frame. \ No newline at end of file diff --git a/references/1.4.0/network-client/UDPClient/isConnected.mdx b/references/1.4.0/network-client/UDPClient/isConnected.mdx deleted file mode 100644 index 54dbdbb..0000000 --- a/references/1.4.0/network-client/UDPClient/isConnected.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isConnected" -icon: "function" -description: "Return true when the RTCDataChannel is open." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isConnected - -## Summary - -Return `true` when the RTCDataChannel is open. -## Signature - -```typescript -isConnected(): boolean; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`boolean` - -Return when the RTCDataChannel is open. \ No newline at end of file diff --git a/references/1.4.0/network-client/UDPClient/sendData.mdx b/references/1.4.0/network-client/UDPClient/sendData.mdx deleted file mode 100644 index fc35584..0000000 --- a/references/1.4.0/network-client/UDPClient/sendData.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "sendData" -icon: "function" -description: "Send a payload on the data channel." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendData - -## Summary - -Send a payload on the data channel. -## Signature - -```typescript -sendData(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload on the data channel. - -## Remarks - - The payload is wrapped in a magic framing packet before being sent. \ No newline at end of file diff --git a/references/1.4.0/network-server/0-index.mdx b/references/1.4.0/network-server/0-index.mdx deleted file mode 100644 index 613fff1..0000000 --- a/references/1.4.0/network-server/0-index.mdx +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "Network Server" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/network-server` is a network lib with tcp and udp support for server-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/network-server -yarn add @nanoforge-dev/network-server -pnpm add @nanoforge-dev/network-server -bun add @nanoforge-dev/network-server -``` - -## Example usage - -Initilize the library in your main file. - -```ts -import { type IRunServerOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkServerLibrary } from "@nanoforge-dev/network-server"; - -export async function main(options: IRunServerOptions) { - const app = NanoforgeFactory.createServer(); - - const network = new NetworkServerLibrary(); - - app.useNetwork(network); - - await app.init(options); - - await app.run(); -} -``` - -Use to receive packets - -```ts -export function myReceiveSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - network.tcp.getReceivedPackets().forEach((packets, client) => { - packets.forEach((packet) => { - const data = JSON.parse(new TextDecoder().decode(packet)); - // Do something with the data - }); - }); -} -``` - -Use to send packets to everyones - -```ts -export function mySendSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - // Do something to get a data - const packet = new TextEncoder().encode(JSON.stringify(data)); - network.tcp.sendToEverybody(packet); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-server -[npm]: https://www.npmjs.com/package/@nanoforge-dev/network-server -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/network-server/NetworkServerLibrary.mdx b/references/1.4.0/network-server/NetworkServerLibrary.mdx deleted file mode 100644 index 522057c..0000000 --- a/references/1.4.0/network-server/NetworkServerLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "NetworkServerLibrary class" -icon: "box" -description: "Built-in network library for server-side applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NetworkServerLibrary - -## Summary - -Built-in network library for server-side applications. -## Signature - -```typescript -declare class NetworkServerLibrary extends BaseNetworkLibrary -``` - -## Properties - -### tcp -**Type**:`tcp: TCPServer;` - -Reliable, ordered WebSocket-based server for connected clients. - -### udp -**Type**:`udp: UDPServer;` - -Unreliable, unordered WebRTC data-channel server for connected clients. - -## Remarks - - Reads network configuration from the environment via `ServerConfigNetwork` and starts TCP (WebSocket) and/or UDP (WebRTC) servers. Register with: Configuration (via environment variables): - `LISTENING_INTERFACE` — bind address (default: `"0.0.0.0"`). - `LISTENING_TCP_PORT` — WebSocket listen port for TCP (optional). - `LISTENING_UDP_PORT` — signaling listen port for UDP (optional). - `MAGIC_VALUE` — packet framing delimiter (default: `"PACKET_END"`). - `WSS_CERT` / `WSS_KEY` — paths to TLS certificate and key files for WSS (optional). After `init`, access the servers via `tcp` and `udp`. \ No newline at end of file diff --git a/references/1.4.0/network-server/NetworkServerLibrary/tcp.mdx b/references/1.4.0/network-server/NetworkServerLibrary/tcp.mdx deleted file mode 100644 index 7aa300b..0000000 --- a/references/1.4.0/network-server/NetworkServerLibrary/tcp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "tcp" -icon: "variable" -description: "Reliable, ordered WebSocket-based server for connected clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# tcp - -## Summary - -Reliable, ordered WebSocket-based server for connected clients. - -## Remarks - - Only available when `LISTENING_TCP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.0/network-server/NetworkServerLibrary/udp.mdx b/references/1.4.0/network-server/NetworkServerLibrary/udp.mdx deleted file mode 100644 index 686ddc8..0000000 --- a/references/1.4.0/network-server/NetworkServerLibrary/udp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "udp" -icon: "variable" -description: "Unreliable, unordered WebRTC data-channel server for connected clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# udp - -## Summary - -Unreliable, unordered WebRTC data-channel server for connected clients. - -## Remarks - - Only available when `LISTENING_UDP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.0/network-server/TCPServer.mdx b/references/1.4.0/network-server/TCPServer.mdx deleted file mode 100644 index 68f8595..0000000 --- a/references/1.4.0/network-server/TCPServer.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "TCPServer class" -icon: "box" -description: "Reliable, ordered WebSocket-based server that manages multiple TCP clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TCPServer - -## Summary - -Reliable, ordered WebSocket-based server that manages multiple TCP clients. -## Signature - -```typescript -declare class TCPServer -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getConnectedClients - -Return a snapshot array of numeric client IDs currently connected. - -### getReceivedPackets - -Parse and return complete packets received from each client. Each packet is a buffer. - -### listen - -Start the WebSocket server and begin accepting clients. - -### sendToClient - -Send a payload to the client identified by . - -### sendToEverybody - -Send a payload to every connected client. - -## Remarks - - Each client that connects is assigned a numeric ID. Use `getConnectedClients` to enumerate active clients, `sendToClient` / `sendToEverybody` to push data, and `getReceivedPackets` to consume incoming packets per frame. Typical usage is through `NetworkServerLibrary` which instantiates and starts this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.0/network-server/TCPServer/constructor.mdx b/references/1.4.0/network-server/TCPServer/constructor.mdx deleted file mode 100644 index 34a13cb..0000000 --- a/references/1.4.0/network-server/TCPServer/constructor.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the TCPServer class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `TCPServer` class -## Signature - -```typescript -constructor(_port: number, _host: string, magicValue: string, _cert?: string | undefined, _key?: string | undefined); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _host -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _cert -- **Type**:`string | undefined` -- **Optional**: Yes - - - -### _key -- **Type**:`string | undefined` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.4.0/network-server/TCPServer/getConnectedClients.mdx b/references/1.4.0/network-server/TCPServer/getConnectedClients.mdx deleted file mode 100644 index fa695c5..0000000 --- a/references/1.4.0/network-server/TCPServer/getConnectedClients.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getConnectedClients" -icon: "function" -description: "Return a snapshot array of numeric client IDs currently connected." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConnectedClients - -## Summary - -Return a snapshot array of numeric client IDs currently connected. -## Signature - -```typescript -getConnectedClients(): number[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`number[]` - -Return a snapshot array of numeric client IDs currently connected. \ No newline at end of file diff --git a/references/1.4.0/network-server/TCPServer/getReceivedPackets.mdx b/references/1.4.0/network-server/TCPServer/getReceivedPackets.mdx deleted file mode 100644 index 0a64e6a..0000000 --- a/references/1.4.0/network-server/TCPServer/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return complete packets received from each client. Each packet is a Uint8Array buffer." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return complete packets received from each client. Each packet is a `Uint8Array` buffer. -## Signature - -```typescript -getReceivedPackets(): Map; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Map` - -Parse and return complete packets received from each client. Each packet is a buffer. \ No newline at end of file diff --git a/references/1.4.0/network-server/TCPServer/listen.mdx b/references/1.4.0/network-server/TCPServer/listen.mdx deleted file mode 100644 index 0ed1244..0000000 --- a/references/1.4.0/network-server/TCPServer/listen.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "listen" -icon: "function" -description: "Start the WebSocket server and begin accepting clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# listen - -## Summary - -Start the WebSocket server and begin accepting clients. -## Signature - -```typescript -listen(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Start the WebSocket server and begin accepting clients. \ No newline at end of file diff --git a/references/1.4.0/network-server/TCPServer/sendToClient.mdx b/references/1.4.0/network-server/TCPServer/sendToClient.mdx deleted file mode 100644 index 7bef494..0000000 --- a/references/1.4.0/network-server/TCPServer/sendToClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "sendToClient" -icon: "function" -description: "Send a payload to the client identified by clientId." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToClient - -## Summary - -Send a payload to the client identified by `clientId`. -## Signature - -```typescript -sendToClient(clientId: number, data: Uint8Array): void; -``` - -## Parameters - -### clientId -**Type**:`number` - -number — numeric client identifier. - -### data -**Type**:`Uint8Array` - -Uint8Array — payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to the client identified by . \ No newline at end of file diff --git a/references/1.4.0/network-server/TCPServer/sendToEverybody.mdx b/references/1.4.0/network-server/TCPServer/sendToEverybody.mdx deleted file mode 100644 index f2b2d58..0000000 --- a/references/1.4.0/network-server/TCPServer/sendToEverybody.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendToEverybody" -icon: "function" -description: "Send a payload to every connected client." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToEverybody - -## Summary - -Send a payload to every connected client. -## Signature - -```typescript -sendToEverybody(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Uint8Array — raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to every connected client. \ No newline at end of file diff --git a/references/1.4.0/network-server/UDPServer.mdx b/references/1.4.0/network-server/UDPServer.mdx deleted file mode 100644 index 4b7de31..0000000 --- a/references/1.4.0/network-server/UDPServer.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "UDPServer class" -icon: "box" -description: "Unreliable, unordered WebRTC data-channel server that manages multiple UDP clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# UDPServer - -## Summary - -Unreliable, unordered WebRTC data-channel server that manages multiple UDP clients. -## Signature - -```typescript -declare class UDPServer -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getConnectedClients - -Return a snapshot array of client IDs with active data channels. - -### getReceivedPackets - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. - -### listen - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). - -### sendToClient - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. - -### sendToEverybody - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. - -## Remarks - - Uses a WebSocket signaling server to complete SDP/ICE handshakes and then communicates over RTCDataChannels. Each connected client is assigned a numeric ID. Use `getConnectedClients` to enumerate active clients, `sendToClient` / `sendToEverybody` to push data, and `getReceivedPackets` to consume incoming packets per frame. Typical usage is through `NetworkServerLibrary` which instantiates and starts this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.0/network-server/UDPServer/constructor.mdx b/references/1.4.0/network-server/UDPServer/constructor.mdx deleted file mode 100644 index 8cb0274..0000000 --- a/references/1.4.0/network-server/UDPServer/constructor.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the UDPServer class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `UDPServer` class -## Signature - -```typescript -constructor(_port: number, _host: string, magicValue: string, _cert?: string | undefined, _key?: string | undefined); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _host -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _cert -- **Type**:`string | undefined` -- **Optional**: Yes - - - -### _key -- **Type**:`string | undefined` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.4.0/network-server/UDPServer/getConnectedClients.mdx b/references/1.4.0/network-server/UDPServer/getConnectedClients.mdx deleted file mode 100644 index 9d035cb..0000000 --- a/references/1.4.0/network-server/UDPServer/getConnectedClients.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getConnectedClients" -icon: "function" -description: "Return a snapshot array of client IDs with active data channels." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConnectedClients - -## Summary - -Return a snapshot array of client IDs with active data channels. -## Signature - -```typescript -getConnectedClients(): number[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`number[]` - -Return a snapshot array of client IDs with active data channels. \ No newline at end of file diff --git a/references/1.4.0/network-server/UDPServer/getReceivedPackets.mdx b/references/1.4.0/network-server/UDPServer/getReceivedPackets.mdx deleted file mode 100644 index e50aa0d..0000000 --- a/references/1.4.0/network-server/UDPServer/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Reassemble buffered chunks and return a map of clientId => complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. -## Signature - -```typescript -getReceivedPackets(): Map; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Map` - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. \ No newline at end of file diff --git a/references/1.4.0/network-server/UDPServer/listen.mdx b/references/1.4.0/network-server/UDPServer/listen.mdx deleted file mode 100644 index 539353a..0000000 --- a/references/1.4.0/network-server/UDPServer/listen.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "listen" -icon: "function" -description: "Start the signaling WebSocket and accept incoming client offers (SDP/ICE)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# listen - -## Summary - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). -## Signature - -```typescript -listen(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). \ No newline at end of file diff --git a/references/1.4.0/network-server/UDPServer/sendToClient.mdx b/references/1.4.0/network-server/UDPServer/sendToClient.mdx deleted file mode 100644 index 9e34361..0000000 --- a/references/1.4.0/network-server/UDPServer/sendToClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "sendToClient" -icon: "function" -description: "Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToClient - -## Summary - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. -## Signature - -```typescript -sendToClient(clientId: number, data: Uint8Array): void; -``` - -## Parameters - -### clientId -**Type**:`number` - -Numeric client identifier returned by listen() events - -### data -**Type**:`Uint8Array` - -Raw packet bytes (Uint8Array) to send - -## Returns - -**Type**:`void` - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. \ No newline at end of file diff --git a/references/1.4.0/network-server/UDPServer/sendToEverybody.mdx b/references/1.4.0/network-server/UDPServer/sendToEverybody.mdx deleted file mode 100644 index 7a0489c..0000000 --- a/references/1.4.0/network-server/UDPServer/sendToEverybody.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendToEverybody" -icon: "function" -description: "Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToEverybody - -## Summary - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. -## Signature - -```typescript -sendToEverybody(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw packet bytes (Uint8Array) to send to every client - -## Returns - -**Type**:`void` - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. \ No newline at end of file diff --git a/references/1.4.0/sound/0-index.mdx b/references/1.4.0/sound/0-index.mdx deleted file mode 100644 index 3372673..0000000 --- a/references/1.4.0/sound/0-index.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Sound" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/sound` is a sound manager for your game. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/sound -yarn add @nanoforge-dev/sound -pnpm add @nanoforge-dev/sound -bun add @nanoforge-dev/sound -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { SoundLibrary } from "@nanoforge-dev/sound"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const assetManager = new AssetManagerLibrary(); - const sound = new SoundLibrary(); - - app.useAssetManager(assetManager); - app.useSound(sound); - - await app.init(options); - - sound.load("sound", assetManager.getAssetPath("/path/to/sound.mp3").path); - - await app.run(); -} -``` - -Use to play sound - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - const sound = ctx.libs.getSound(); - - sound.play("sound"); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/sound -[npm]: https://www.npmjs.com/package/@nanoforge-dev/sound -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.0/sound/SoundLibrary.mdx b/references/1.4.0/sound/SoundLibrary.mdx deleted file mode 100644 index 7077d2a..0000000 --- a/references/1.4.0/sound/SoundLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "SoundLibrary class" -icon: "box" -description: "Built-in sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SoundLibrary - -## Summary - -Built-in sound-effect library. -## Signature - -```typescript -declare class SoundLibrary extends BaseSoundLibrary -``` - -## Methods - -### load - -Register a sound effect under a unique key. - -### mute - -Toggle the muted state of all loaded sound effects. - -### play - -Play a previously loaded sound effect. - -## Remarks - - Manages a collection of named `HTMLAudioElement` instances. Load sounds with `load` and trigger playback with `play`. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.0/sound/SoundLibrary/load.mdx b/references/1.4.0/sound/SoundLibrary/load.mdx deleted file mode 100644 index 7995630..0000000 --- a/references/1.4.0/sound/SoundLibrary/load.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "load" -icon: "function" -description: "Register a sound effect under a unique key." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# load - -## Summary - -Register a sound effect under a unique key. -## Signature - -```typescript -load(sound: string, file: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Unique key used to reference this sound (e.g. "explosion"). - -### file -**Type**:`string` - -URL or path to the audio file. - -## Returns - -**Type**:`void` - -Register a sound effect under a unique key. - -## Remarks - - Creates an `HTMLAudioElement` from the provided URL. The sound respects the current muted state at load time. \ No newline at end of file diff --git a/references/1.4.0/sound/SoundLibrary/mute.mdx b/references/1.4.0/sound/SoundLibrary/mute.mdx deleted file mode 100644 index aa6aae2..0000000 --- a/references/1.4.0/sound/SoundLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded sound effects." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded sound effects. -## Signature - -```typescript -mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded sound effects. \ No newline at end of file diff --git a/references/1.4.0/sound/SoundLibrary/play.mdx b/references/1.4.0/sound/SoundLibrary/play.mdx deleted file mode 100644 index f072fab..0000000 --- a/references/1.4.0/sound/SoundLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Play a previously loaded sound effect." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Play a previously loaded sound effect. -## Signature - -```typescript -play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the sound (as passed to load). - -## Returns - -**Type**:`void` - -Play a previously loaded sound effect. \ No newline at end of file diff --git a/references/1.4.1/.tsdocs/client/ValidRefs.js b/references/1.4.1/.tsdocs/client/ValidRefs.js deleted file mode 100644 index e1205f1..0000000 --- a/references/1.4.1/.tsdocs/client/ValidRefs.js +++ /dev/null @@ -1,29 +0,0 @@ -// @ts-nocheck -/** - * Valid API Reference IDs - * Auto-generated by mint-tsdocs during documentation build. - * Used by RefLink component for runtime validation. - * - * @generated - */ - -// Expose VALID_REFS on window for use by RefLink component -// This avoids ES6 module import issues with .jsx MIME types -if (typeof window !== 'undefined') { - window.VALID_REFS = new Set([ - "core-editor", - "core-editor.CoreEvents", - "core-editor.EditorEvents", - "core-editor.EventEmitter", - "core-editor.EventEmitter.constructor", - "core-editor.EventEmitter.emit", - "core-editor.EventEmitter.on", - "core-editor.EventEmitter.runEvents", - "core-editor.NanoforgeClient", - "core-editor.NanoforgeClient.useGraphics", - "core-editor.NanoforgeClient.useInput", - "core-editor.NanoforgeClient.useSound", - "core-editor.NanoforgeFactory", - "core-editor.NanoforgeServer" -]); -} diff --git a/references/1.4.1/.tsdocs/client/tsdocs-config.js b/references/1.4.1/.tsdocs/client/tsdocs-config.js deleted file mode 100644 index f0b4e0b..0000000 --- a/references/1.4.1/.tsdocs/client/tsdocs-config.js +++ /dev/null @@ -1,28 +0,0 @@ -/** - * TSDocs Runtime Configuration - * Auto-generated by mint-tsdocs during documentation build. - * Loaded globally as a custom script for all documentation pages. - * - * This provides runtime configuration to TSDocs components (RefLink, PageLink, etc.) - * without requiring imports between snippet files. - * - * @generated - */ -(function() { - 'use strict'; - - // Global TSDocs configuration accessible to all components - window.TSDOCS_CONFIG = { - basePath: "/core-editor", - packageName: "core-editor", - generatedAt: "2026-07-06T12:34:36.541Z" - }; - - // Helper function to generate absolute path for an API reference - window.getRefPath = function(refId) { - var segments = refId.split('.').filter(function(s) { return s.length > 0; }); - return segments.length > 0 - ? window.TSDOCS_CONFIG.basePath + '/' + segments.join('/') - : window.TSDOCS_CONFIG.basePath; - }; -})(); diff --git a/references/1.4.1/.tsdocs/client/tsdocs-styles.css b/references/1.4.1/.tsdocs/client/tsdocs-styles.css deleted file mode 100644 index 0541fd9..0000000 --- a/references/1.4.1/.tsdocs/client/tsdocs-styles.css +++ /dev/null @@ -1,65 +0,0 @@ -/** - * TSDocs Default Styles - * Auto-generated by mint-tsdocs during documentation generation - * - * To override any style, add more specific selectors in docs/style.css: - * - * Example: - * .prose .tsdocs-reflink.broken-link { - * border-bottom: 3px solid orange !important; - * } - */ - -/* ============================================================================ - * Broken Link Indicators - * ============================================================================ - * Used by RefLink and PageLink components to highlight invalid references - */ - -/* RefLink broken links */ -.prose .tsdocs-reflink.broken-link { - border-bottom: 2px dotted #ef4444 !important; - color: #ef4444 !important; - text-decoration: wavy underline !important; -} - -/* PageLink broken links */ -.prose .tsdocs-pagelink.broken-link { - border-bottom: 2px dotted #ef4444 !important; - color: #ef4444 !important; - text-decoration: wavy underline !important; -} - -/* Dark mode variants */ -.dark .prose .tsdocs-reflink.broken-link { - border-bottom-color: #f87171 !important; - color: #f87171 !important; -} - -.dark .prose .tsdocs-pagelink.broken-link { - border-bottom-color: #f87171 !important; - color: #f87171 !important; -} - -/* ============================================================================ - * TypeTree Component Styles - * ============================================================================ - * Currently uses Mintlify's native ResponseField and Expandable components - * Use this selector for custom TypeTree styling: - * [data-component="tsdocs-typetree"] { } - */ - -/* ============================================================================ - * Preview Component Styles - * ============================================================================ - * Wrapper for code examples and previews - * Use this selector for custom Preview styling: - * [data-component="tsdocs-preview"] { } - */ - -/* ============================================================================ - * Feature Component Styles - * ============================================================================ - * The Feature component now uses Tailwind CSS classes directly. - * No custom styles needed - matches Mintlify Card component styling. - */ diff --git a/references/1.4.1/.tsdocs/global.d.ts b/references/1.4.1/.tsdocs/global.d.ts deleted file mode 100644 index 7284151..0000000 --- a/references/1.4.1/.tsdocs/global.d.ts +++ /dev/null @@ -1,145 +0,0 @@ -/** - * Global type declarations for mint-tsdocs - * Auto-generated during documentation build. - * - * This file provides: - * - Mintlify component type declarations (ResponseField, Expandable) - * - Window object augmentations for runtime scripts - * - Type-safe ValidRefId and ValidPageId unions - * - * @generated - */ - -// ============================================================================ -// Mintlify Component Declarations -// ============================================================================ - -/** - * Global type declarations for Mintlify components. - * These components are provided by Mintlify at runtime. - */ -declare namespace JSX { - interface IntrinsicElements { - ResponseField: any; - Expandable: any; - } -} - -// Also declare as global React components -declare const ResponseField: React.FC; -declare const Expandable: React.FC; - -// ============================================================================ -// ValidRefs Types -// ============================================================================ - -/** - * Union type of all valid API reference IDs - * - * Generated from the API model structure during documentation build. - * Used by RefLink component for type-safe reference validation. - */ -export type ValidRefId = - | "core-editor" - | "core-editor.CoreEvents" - | "core-editor.EditorEvents" - | "core-editor.EventEmitter" - | "core-editor.EventEmitter.constructor" - | "core-editor.EventEmitter.emit" - | "core-editor.EventEmitter.on" - | "core-editor.EventEmitter.runEvents" - | "core-editor.NanoforgeClient" - | "core-editor.NanoforgeClient.useGraphics" - | "core-editor.NanoforgeClient.useInput" - | "core-editor.NanoforgeClient.useSound" - | "core-editor.NanoforgeFactory" - | "core-editor.NanoforgeServer"; - -/** - * Check if a RefId is valid - * - * @param refId - The reference ID to check - * @returns True if the refId is valid - */ -export function isValidRef(refId: string): refId is ValidRefId; - -// ============================================================================ -// ValidPages Types -// ============================================================================ - -/** - * Union type of all valid page IDs from docs.json - * - * Generated from docs.json navigation structure during documentation build. - * Used by PageLink component for type-safe page validation. - */ -export type ValidPageId = - never; - -/** - * Check if a PageId is valid - * - * @param pageId - The page ID to check - * @returns True if the pageId is valid - */ -export function isValidPage(pageId: string): pageId is ValidPageId; - -// ============================================================================ -// TsdocsConfig Types -// ============================================================================ - -/** - * Runtime configuration for TSDocs components - * - * Available via window.TSDOCS_CONFIG after tsdocs-config.js loads. - */ -export interface TsdocsConfig { - /** Base path for API reference pages (e.g., "/reference") */ - basePath: string; - - /** Package name */ - packageName: string; - - /** Generated timestamp (ISO 8601) */ - generatedAt: string; -} - -// ============================================================================ -// Window Object Augmentation -// ============================================================================ - -declare global { - interface Window { - /** - * Set of all valid RefIds in the documentation - * Populated by ValidRefs.js at runtime - */ - VALID_REFS?: Set; - - /** - * Set of all valid PageIds in the documentation - * Populated by ValidPages.js at runtime - */ - VALID_PAGES?: Set; - - /** - * Runtime configuration object - * Populated by tsdocs-config.js at runtime - */ - TSDOCS_CONFIG?: TsdocsConfig; - - /** - * Get absolute path for an API reference - * - * @param refId - The RefId (e.g., "mint-tsdocs.MarkdownDocumenter") - * @returns Absolute path (e.g., "/reference/mint-tsdocs/MarkdownDocumenter") - * - * @example - * getRefPath("mint-tsdocs.MarkdownDocumenter") - * // Returns: "/reference/mint-tsdocs/MarkdownDocumenter" - */ - getRefPath?: (refId: string) => string; - } -} - -export {}; diff --git a/references/1.4.1/asset-manager/0-index.mdx b/references/1.4.1/asset-manager/0-index.mdx deleted file mode 100644 index 0733d87..0000000 --- a/references/1.4.1/asset-manager/0-index.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "Asset Manager" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/asset-manager` is a manager for loading assets to uniform work with between client and server. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/asset-manager -yarn add @nanoforge-dev/asset-manager -pnpm add @nanoforge-dev/asset-manager -bun add @nanoforge-dev/asset-manager -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; - -export async function main(options: IRunOptions) { - const app = NanoforgeFactory.createClient(); // Or NanoforgeFactory.createServer() - - const assetManager = new AssetManagerLibrary(); - - app.useAssetManager(assetManager); - - await app.init(options); - - await app.run(); -} -``` - -Use to load assets - -```ts -export async function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - - const file = assetManager.getAsset("/path/to/file.txt"); - const text = await file.text(); - - // Do something with file or text -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/asset-manager -[npm]: https://www.npmjs.com/package/@nanoforge-dev/asset-manager -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/asset-manager/AssetManagerLibrary.mdx b/references/1.4.1/asset-manager/AssetManagerLibrary.mdx deleted file mode 100644 index 966b860..0000000 --- a/references/1.4.1/asset-manager/AssetManagerLibrary.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "AssetManagerLibrary class" -icon: "box" -description: "Built-in asset-manager library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# AssetManagerLibrary - -## Summary - -Built-in asset-manager library. -## Signature - -```typescript -declare class AssetManagerLibrary extends BaseAssetManagerLibrary -``` - -## Methods - -### getAsset - -Retrieve a registered file asset by its virtual path. - -### getAsset - - - -## Remarks - - Stores the file map injected by the NanoForge loader (`nf start`) and exposes assets via `getAsset`. Register it with the application before calling `init`: File paths are normalised on lookup: leading slashes are collapsed to a single `/`, duplicate slashes are removed, and trailing slashes are stripped. \ No newline at end of file diff --git a/references/1.4.1/asset-manager/AssetManagerLibrary/getAsset.mdx b/references/1.4.1/asset-manager/AssetManagerLibrary/getAsset.mdx deleted file mode 100644 index 192a448..0000000 --- a/references/1.4.1/asset-manager/AssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "Retrieve a registered file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a registered file asset by its virtual path. -## Signature - -```typescript -getAsset(path: string): NfFile; -``` - -## Parameters - -### path -**Type**:`string` - -Virtual path of the asset (e.g. "/textures/hero.png"). - -## Returns - -**Type**:`NfFile` - -Retrieve a registered file asset by its virtual path. - -## Remarks - - The path is normalised before lookup: leading and duplicate slashes are collapsed and trailing slashes are removed. \ No newline at end of file diff --git a/references/1.4.1/asset-manager/AssetManagerLibrary/getAsset_1.mdx b/references/1.4.1/asset-manager/AssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index b06123b..0000000 --- a/references/1.4.1/asset-manager/AssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset -## Signature - -```typescript -getAsset(path: "" | undefined): undefined; -``` - -## Parameters - -### path -**Type**:`"" | undefined` - - - -## Returns - -**Type**:`undefined` \ No newline at end of file diff --git a/references/1.4.1/common/0-index.mdx b/references/1.4.1/common/0-index.mdx deleted file mode 100644 index 0de4539..0000000 --- a/references/1.4.1/common/0-index.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "Common" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/common` is library with common interfaces and utilities used by Nanoforge Engine. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/common -yarn add @nanoforge-dev/common -pnpm add @nanoforge-dev/common -bun add @nanoforge-dev/common -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/common -[npm]: https://www.npmjs.com/package/@nanoforge-dev/common -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/common/ASSET_MANAGER_LIBRARY.mdx b/references/1.4.1/common/ASSET_MANAGER_LIBRARY.mdx deleted file mode 100644 index 55eed46..0000000 --- a/references/1.4.1/common/ASSET_MANAGER_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ASSET_MANAGER_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the asset-manager library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ASSET_MANAGER_LIBRARY - -## Summary - -Registration symbol for the asset-manager library slot. -## Signature - -```typescript -ASSET_MANAGER_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.useAssetManager` or use it as a dependency in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.1/common/ApplicationContext.mdx b/references/1.4.1/common/ApplicationContext.mdx deleted file mode 100644 index 5c94d56..0000000 --- a/references/1.4.1/common/ApplicationContext.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "ApplicationContext class" -icon: "box" -description: "Holds runtime state that is shared across all libraries during the game loop." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ApplicationContext - -## Summary - -Holds runtime state that is shared across all libraries during the game loop. -## Signature - -```typescript -declare abstract class ApplicationContext -``` - -## Properties - -### delta -**Modifiers**: readonly -**Type**:`get delta(): number;` - -Elapsed time in milliseconds since the last frame. - -### isRunning -**Modifiers**: readonly -**Type**:`get isRunning(): boolean;` - -Whether the engine game loop is currently executing. - -## Remarks - - An instance of this class is available to every library via `BaseContext.application`. Libraries may read `isRunning` and `delta` to make frame-rate-independent decisions. \ No newline at end of file diff --git a/references/1.4.1/common/ApplicationContext/delta.mdx b/references/1.4.1/common/ApplicationContext/delta.mdx deleted file mode 100644 index 3e3d8cc..0000000 --- a/references/1.4.1/common/ApplicationContext/delta.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "delta" -icon: "variable" -description: "Elapsed time in milliseconds since the last frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# delta - -## Summary - -Elapsed time in milliseconds since the last frame. \ No newline at end of file diff --git a/references/1.4.1/common/ApplicationContext/isRunning.mdx b/references/1.4.1/common/ApplicationContext/isRunning.mdx deleted file mode 100644 index 631b6fd..0000000 --- a/references/1.4.1/common/ApplicationContext/isRunning.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "isRunning" -icon: "variable" -description: "Whether the engine game loop is currently executing." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isRunning - -## Summary - -Whether the engine game loop is currently executing. \ No newline at end of file diff --git a/references/1.4.1/common/BaseAssetManagerLibrary.mdx b/references/1.4.1/common/BaseAssetManagerLibrary.mdx deleted file mode 100644 index 3294405..0000000 --- a/references/1.4.1/common/BaseAssetManagerLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseAssetManagerLibrary class" -icon: "box" -description: "Abstract base class for asset-manager libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseAssetManagerLibrary - -## Summary - -Abstract base class for asset-manager libraries. -## Signature - -```typescript -declare abstract class BaseAssetManagerLibrary extends Library implements IAssetManagerLibrary -``` - -## Methods - -### getAsset -**Modifiers**: abstract - -Retrieve a file asset by its virtual path. - -### getAsset -**Modifiers**: abstract - - - -## Remarks - - Extend this class to implement a custom asset-manager and register it with `NanoforgeApplication.useAssetManager`. The built-in implementation is `AssetManagerLibrary`. \ No newline at end of file diff --git a/references/1.4.1/common/BaseAssetManagerLibrary/getAsset.mdx b/references/1.4.1/common/BaseAssetManagerLibrary/getAsset.mdx deleted file mode 100644 index f492d02..0000000 --- a/references/1.4.1/common/BaseAssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "Retrieve a file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a file asset by its virtual path. -## Signature - -```typescript -abstract getAsset(path: string): NfFile; -``` - -## Parameters - -### path -**Type**:`string` - -Virtual path as registered in the engine's file map (e.g. "/textures/hero.png"). - -## Returns - -**Type**:`NfFile` - -Retrieve a file asset by its virtual path. \ No newline at end of file diff --git a/references/1.4.1/common/BaseAssetManagerLibrary/getAsset_1.mdx b/references/1.4.1/common/BaseAssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index baa7fe8..0000000 --- a/references/1.4.1/common/BaseAssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset -## Signature - -```typescript -abstract getAsset(path: "" | undefined): undefined; -``` - -## Parameters - -### path -**Type**:`"" | undefined` - - - -## Returns - -**Type**:`undefined` \ No newline at end of file diff --git a/references/1.4.1/common/BaseComponentSystemLibrary.mdx b/references/1.4.1/common/BaseComponentSystemLibrary.mdx deleted file mode 100644 index 0104678..0000000 --- a/references/1.4.1/common/BaseComponentSystemLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseComponentSystemLibrary class" -icon: "box" -description: "Abstract base class for component-system (ECS) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseComponentSystemLibrary - -## Summary - -Abstract base class for component-system (ECS) libraries. -## Signature - -```typescript -declare abstract class BaseComponentSystemLibrary extends Library implements IComponentSystemLibrary -``` - -## Remarks - - Extend this class (or the higher-level `AbstractECSLibrary`) to implement a custom ECS back-end and register it with `NanoforgeApplication.useComponentSystem`. The built-in implementations are `ECSClientLibrary` and `ECSServerLibrary`. \ No newline at end of file diff --git a/references/1.4.1/common/BaseGraphicsLibrary.mdx b/references/1.4.1/common/BaseGraphicsLibrary.mdx deleted file mode 100644 index 91ff228..0000000 --- a/references/1.4.1/common/BaseGraphicsLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseGraphicsLibrary class" -icon: "box" -description: "Abstract base class for graphics libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseGraphicsLibrary - -## Summary - -Abstract base class for graphics libraries. -## Signature - -```typescript -declare abstract class BaseGraphicsLibrary extends Library implements IGraphicsLibrary -``` - -## Remarks - - Extend this class to implement a custom rendering backend and register it with `NanoforgeClient.useGraphics`. The built-in implementation is `Graphics2DLibrary`. \ No newline at end of file diff --git a/references/1.4.1/common/BaseInputLibrary.mdx b/references/1.4.1/common/BaseInputLibrary.mdx deleted file mode 100644 index 9d79933..0000000 --- a/references/1.4.1/common/BaseInputLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseInputLibrary class" -icon: "box" -description: "Abstract base class for input libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseInputLibrary - -## Summary - -Abstract base class for input libraries. -## Signature - -```typescript -declare abstract class BaseInputLibrary extends Library implements IInputLibrary -``` - -## Remarks - - Extend this class to implement a custom input back-end and register it with `NanoforgeClient.useInput`. The built-in implementation is `InputLibrary`. \ No newline at end of file diff --git a/references/1.4.1/common/BaseMusicLibrary.mdx b/references/1.4.1/common/BaseMusicLibrary.mdx deleted file mode 100644 index 355c2ed..0000000 --- a/references/1.4.1/common/BaseMusicLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseMusicLibrary class" -icon: "box" -description: "Abstract base class for music libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseMusicLibrary - -## Summary - -Abstract base class for music libraries. -## Signature - -```typescript -declare abstract class BaseMusicLibrary extends Library implements IMusicLibrary -``` - -## Methods - -### mute -**Modifiers**: abstract - -Toggle the muted state of all loaded music tracks. - -### play -**Modifiers**: abstract - -Stop the currently playing track (if any) and start playing the requested one. - -## Remarks - - Extend this class to implement a custom music library and register it with `NanoforgeApplication.use` using the `MUSIC_LIBRARY` symbol. The built-in implementation is `MusicLibrary`. \ No newline at end of file diff --git a/references/1.4.1/common/BaseMusicLibrary/mute.mdx b/references/1.4.1/common/BaseMusicLibrary/mute.mdx deleted file mode 100644 index 870e300..0000000 --- a/references/1.4.1/common/BaseMusicLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded music tracks." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded music tracks. -## Signature - -```typescript -abstract mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded music tracks. \ No newline at end of file diff --git a/references/1.4.1/common/BaseMusicLibrary/play.mdx b/references/1.4.1/common/BaseMusicLibrary/play.mdx deleted file mode 100644 index c01e955..0000000 --- a/references/1.4.1/common/BaseMusicLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Stop the currently playing track (if any) and start playing the requested one." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Stop the currently playing track (if any) and start playing the requested one. -## Signature - -```typescript -abstract play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the music track (as passed to load). - -## Returns - -**Type**:`void` - -Stop the currently playing track (if any) and start playing the requested one. \ No newline at end of file diff --git a/references/1.4.1/common/BaseNetworkLibrary.mdx b/references/1.4.1/common/BaseNetworkLibrary.mdx deleted file mode 100644 index b1ac7fa..0000000 --- a/references/1.4.1/common/BaseNetworkLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseNetworkLibrary class" -icon: "box" -description: "Abstract base class for network libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseNetworkLibrary - -## Summary - -Abstract base class for network libraries. -## Signature - -```typescript -declare abstract class BaseNetworkLibrary extends Library implements INetworkLibrary -``` - -## Remarks - - Extend this class to implement a custom network library and register it with `NanoforgeApplication.useNetwork`. The built-in implementations are `NetworkClientLibrary` and `NetworkServerLibrary`. \ No newline at end of file diff --git a/references/1.4.1/common/BaseSoundLibrary.mdx b/references/1.4.1/common/BaseSoundLibrary.mdx deleted file mode 100644 index 7655039..0000000 --- a/references/1.4.1/common/BaseSoundLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseSoundLibrary class" -icon: "box" -description: "Abstract base class for sound libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseSoundLibrary - -## Summary - -Abstract base class for sound libraries. -## Signature - -```typescript -declare abstract class BaseSoundLibrary extends Library implements ISoundLibrary -``` - -## Methods - -### mute -**Modifiers**: abstract - -Toggle the muted state of all loaded sound effects. - -### play -**Modifiers**: abstract - -Play a previously loaded sound effect. - -## Remarks - - Extend this class to implement a custom sound library and register it with `NanoforgeClient.useSound`. The built-in implementation is `SoundLibrary`. \ No newline at end of file diff --git a/references/1.4.1/common/BaseSoundLibrary/mute.mdx b/references/1.4.1/common/BaseSoundLibrary/mute.mdx deleted file mode 100644 index 9fcd48e..0000000 --- a/references/1.4.1/common/BaseSoundLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded sound effects." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded sound effects. -## Signature - -```typescript -abstract mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded sound effects. \ No newline at end of file diff --git a/references/1.4.1/common/BaseSoundLibrary/play.mdx b/references/1.4.1/common/BaseSoundLibrary/play.mdx deleted file mode 100644 index c7040b6..0000000 --- a/references/1.4.1/common/BaseSoundLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Play a previously loaded sound effect." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Play a previously loaded sound effect. -## Signature - -```typescript -abstract play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the sound (as passed to load). - -## Returns - -**Type**:`void` - -Play a previously loaded sound effect. \ No newline at end of file diff --git a/references/1.4.1/common/COMPONENT_SYSTEM_LIBRARY.mdx b/references/1.4.1/common/COMPONENT_SYSTEM_LIBRARY.mdx deleted file mode 100644 index 484ad21..0000000 --- a/references/1.4.1/common/COMPONENT_SYSTEM_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "COMPONENT_SYSTEM_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the component-system (ECS) library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# COMPONENT_SYSTEM_LIBRARY - -## Summary - -Registration symbol for the component-system (ECS) library slot. -## Signature - -```typescript -COMPONENT_SYSTEM_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.use` when registering a custom component-system library, or use the shorthand `NanoforgeApplication.useComponentSystem`. \ No newline at end of file diff --git a/references/1.4.1/common/ClearContext.mdx b/references/1.4.1/common/ClearContext.mdx deleted file mode 100644 index b3a6704..0000000 --- a/references/1.4.1/common/ClearContext.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ClearContext class" -icon: "box" -description: "Context passed to a library's clear lifecycle hook during application shutdown." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ClearContext - -## Summary - -Context passed to a library's `__clear` lifecycle hook during application shutdown. -## Signature - -```typescript -declare class ClearContext extends BaseContext -``` - -## Remarks - - Use the inherited `application` and `libraries` accessors to access shared state and other libraries while tearing down resources. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager.mdx b/references/1.4.1/common/ClientLibraryManager.mdx deleted file mode 100644 index 75f7404..0000000 --- a/references/1.4.1/common/ClientLibraryManager.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "ClientLibraryManager class" -icon: "box" -description: "Convenience wrapper around LibraryManager that unwraps LibraryHandle values and returns the library instance directly." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ClientLibraryManager - -## Summary - -Convenience wrapper around `LibraryManager` that unwraps `LibraryHandle` values and returns the library instance directly. -## Signature - -```typescript -declare class ClientLibraryManager -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### get - -Retrieve a library registered under a custom symbol. - -### getAssetManager - -Retrieve the registered asset-manager library instance. - -### getComponentSystem - -Retrieve the registered component-system (ECS) library instance. - -### getGraphics - -Retrieve the registered graphics library instance. - -### getInput - -Retrieve the registered input library instance. - -### getMusic - -Retrieve the registered music library instance. - -### getNetwork - -Retrieve the registered network library instance. - -### getSound - -Retrieve the registered sound library instance. - -## Remarks - - Typically accessed inside a library's lifecycle hooks through the execution context's `libraries` property after being constructed with a concrete `LibraryManager`. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/constructor.mdx b/references/1.4.1/common/ClientLibraryManager/constructor.mdx deleted file mode 100644 index e84b462..0000000 --- a/references/1.4.1/common/ClientLibraryManager/constructor.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ClientLibraryManager class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ClientLibraryManager` class -## Signature - -```typescript -constructor(libraryManager: LibraryManager); -``` - -## Parameters - -### libraryManager -- **Type**:`LibraryManager` - -The underlying manager to delegate lookups to. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/get.mdx b/references/1.4.1/common/ClientLibraryManager/get.mdx deleted file mode 100644 index 9b5edaf..0000000 --- a/references/1.4.1/common/ClientLibraryManager/get.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "get" -icon: "function" -description: "Retrieve a library registered under a custom symbol." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# get - -## Summary - -Retrieve a library registered under a custom symbol. -## Signature - -```typescript -get(sym: symbol): T; -``` - -## Parameters - -### sym -**Type**:`symbol` - -The symbol the library was registered with. - -## Returns - -**Type**:`T` - -Retrieve a library registered under a custom symbol. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/getAssetManager.mdx b/references/1.4.1/common/ClientLibraryManager/getAssetManager.mdx deleted file mode 100644 index 3f9dc8a..0000000 --- a/references/1.4.1/common/ClientLibraryManager/getAssetManager.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getAssetManager" -icon: "function" -description: "Retrieve the registered asset-manager library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAssetManager - -## Summary - -Retrieve the registered asset-manager library instance. -## Signature - -```typescript -getAssetManager(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered asset-manager library instance. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/getComponentSystem.mdx b/references/1.4.1/common/ClientLibraryManager/getComponentSystem.mdx deleted file mode 100644 index 0618c44..0000000 --- a/references/1.4.1/common/ClientLibraryManager/getComponentSystem.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getComponentSystem" -icon: "function" -description: "Retrieve the registered component-system (ECS) library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentSystem - -## Summary - -Retrieve the registered component-system (ECS) library instance. -## Signature - -```typescript -getComponentSystem(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered component-system (ECS) library instance. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/getGraphics.mdx b/references/1.4.1/common/ClientLibraryManager/getGraphics.mdx deleted file mode 100644 index 279e0e7..0000000 --- a/references/1.4.1/common/ClientLibraryManager/getGraphics.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getGraphics" -icon: "function" -description: "Retrieve the registered graphics library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getGraphics - -## Summary - -Retrieve the registered graphics library instance. -## Signature - -```typescript -getGraphics(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered graphics library instance. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/getInput.mdx b/references/1.4.1/common/ClientLibraryManager/getInput.mdx deleted file mode 100644 index ecb04fa..0000000 --- a/references/1.4.1/common/ClientLibraryManager/getInput.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getInput" -icon: "function" -description: "Retrieve the registered input library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getInput - -## Summary - -Retrieve the registered input library instance. -## Signature - -```typescript -getInput(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered input library instance. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/getMusic.mdx b/references/1.4.1/common/ClientLibraryManager/getMusic.mdx deleted file mode 100644 index ec91ce8..0000000 --- a/references/1.4.1/common/ClientLibraryManager/getMusic.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMusic" -icon: "function" -description: "Retrieve the registered music library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMusic - -## Summary - -Retrieve the registered music library instance. -## Signature - -```typescript -getMusic(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered music library instance. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/getNetwork.mdx b/references/1.4.1/common/ClientLibraryManager/getNetwork.mdx deleted file mode 100644 index 91f2bfd..0000000 --- a/references/1.4.1/common/ClientLibraryManager/getNetwork.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getNetwork" -icon: "function" -description: "Retrieve the registered network library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getNetwork - -## Summary - -Retrieve the registered network library instance. -## Signature - -```typescript -getNetwork(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered network library instance. \ No newline at end of file diff --git a/references/1.4.1/common/ClientLibraryManager/getSound.mdx b/references/1.4.1/common/ClientLibraryManager/getSound.mdx deleted file mode 100644 index fcfd477..0000000 --- a/references/1.4.1/common/ClientLibraryManager/getSound.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getSound" -icon: "function" -description: "Retrieve the registered sound library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getSound - -## Summary - -Retrieve the registered sound library instance. -## Signature - -```typescript -getSound(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered sound library instance. \ No newline at end of file diff --git a/references/1.4.1/common/Context.mdx b/references/1.4.1/common/Context.mdx deleted file mode 100644 index 92d8ed5..0000000 --- a/references/1.4.1/common/Context.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Context class" -icon: "box" -description: "Context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Context -## Signature - -```typescript -declare class Context -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### app -**Modifiers**: readonly -**Type**:`get app(): ApplicationContext;` - - - -### libs -**Modifiers**: readonly -**Type**:`get libs(): ClientLibraryManager;` \ No newline at end of file diff --git a/references/1.4.1/common/Context/app.mdx b/references/1.4.1/common/Context/app.mdx deleted file mode 100644 index 0912bb7..0000000 --- a/references/1.4.1/common/Context/app.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "app" -icon: "variable" -description: "app API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# app \ No newline at end of file diff --git a/references/1.4.1/common/Context/constructor.mdx b/references/1.4.1/common/Context/constructor.mdx deleted file mode 100644 index 5688f33..0000000 --- a/references/1.4.1/common/Context/constructor.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the Context class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `Context` class -## Signature - -```typescript -constructor(applicationContext: ApplicationContext, libraryManager: ClientLibraryManager); -``` - -## Parameters - -### applicationContext -- **Type**:`ApplicationContext` - - - -### libraryManager -- **Type**:`ClientLibraryManager` \ No newline at end of file diff --git a/references/1.4.1/common/Context/libs.mdx b/references/1.4.1/common/Context/libs.mdx deleted file mode 100644 index eb4c68b..0000000 --- a/references/1.4.1/common/Context/libs.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "libs" -icon: "variable" -description: "libs API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# libs \ No newline at end of file diff --git a/references/1.4.1/common/DefaultLibrariesEnum.mdx b/references/1.4.1/common/DefaultLibrariesEnum.mdx deleted file mode 100644 index b82062a..0000000 --- a/references/1.4.1/common/DefaultLibrariesEnum.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "DefaultLibrariesEnum enum" -icon: "list" -description: "Numeric index keys for the built-in library slots." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# DefaultLibrariesEnum - -## Summary - -Numeric index keys for the built-in library slots. - -## Members -| Member | Description | -| ------ | ----------- | -| `ASSET_MANAGER` | | -| `COMPONENT_SYSTEM` | | -| `GRAPHICS` | | -| `INPUT` | | -| `MUSIC` | | -| `NETWORK` | | -| `SOUND` | | - -## Remarks - - Used internally by `LibraryManager` to keep O(1) access to the well-known library positions. Game code should not reference these values directly — use the typed accessor methods on `LibraryManager` instead. \ No newline at end of file diff --git a/references/1.4.1/common/ExecutionContext.mdx b/references/1.4.1/common/ExecutionContext.mdx deleted file mode 100644 index b6ef64b..0000000 --- a/references/1.4.1/common/ExecutionContext.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ExecutionContext class" -icon: "box" -description: "Context passed to a library's run hook on every game-loop tick." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ExecutionContext - -## Summary - -Context passed to a library's `__run` hook on every game-loop tick. -## Signature - -```typescript -declare class ExecutionContext extends BaseContext -``` - -## Remarks - - Use the inherited `application` and `libraries` accessors to read the current delta time and interact with other libraries during the frame update. \ No newline at end of file diff --git a/references/1.4.1/common/GRAPHICS_LIBRARY.mdx b/references/1.4.1/common/GRAPHICS_LIBRARY.mdx deleted file mode 100644 index 149ddc0..0000000 --- a/references/1.4.1/common/GRAPHICS_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "GRAPHICS_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the graphics library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# GRAPHICS_LIBRARY - -## Summary - -Registration symbol for the graphics library slot. -## Signature - -```typescript -GRAPHICS_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useGraphics` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.1/common/IAssetManagerLibrary.mdx b/references/1.4.1/common/IAssetManagerLibrary.mdx deleted file mode 100644 index 81e2913..0000000 --- a/references/1.4.1/common/IAssetManagerLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IAssetManagerLibrary interface" -icon: "plug" -description: "Interface for asset-manager libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IAssetManagerLibrary - -## Summary - -Interface for asset-manager libraries. -## Signature - -```typescript -interface IAssetManagerLibrary extends IExposedLibrary -``` - -## Remarks - - Implemented by `BaseAssetManagerLibrary` and its concrete subclass `AssetManagerLibrary`. Access an instance via `ctx.libraries.getAssetManager().library`. \ No newline at end of file diff --git a/references/1.4.1/common/IAssetManagerLibrary/getAsset.mdx b/references/1.4.1/common/IAssetManagerLibrary/getAsset.mdx deleted file mode 100644 index 89ba6b7..0000000 --- a/references/1.4.1/common/IAssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getAsset" -icon: "file" -description: "Retrieve a registered file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a registered file asset by its virtual path. - -## Description - -Retrieve a registered file asset by its virtual path. \ No newline at end of file diff --git a/references/1.4.1/common/IAssetManagerLibrary/getAsset_1.mdx b/references/1.4.1/common/IAssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index 9698eef..0000000 --- a/references/1.4.1/common/IAssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getAsset" -icon: "file" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Description \ No newline at end of file diff --git a/references/1.4.1/common/IComponentSystemLibrary.mdx b/references/1.4.1/common/IComponentSystemLibrary.mdx deleted file mode 100644 index 4e173f3..0000000 --- a/references/1.4.1/common/IComponentSystemLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IComponentSystemLibrary interface" -icon: "plug" -description: "Interface for component-system (ECS) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IComponentSystemLibrary - -## Summary - -Interface for component-system (ECS) libraries. -## Signature - -```typescript -interface IComponentSystemLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseComponentSystemLibrary` and the higher-level `AbstractECSLibrary`, with concrete subclasses `ECSClientLibrary` and `ECSServerLibrary`. Access an instance via `ctx.libraries.getComponentSystem().library`. \ No newline at end of file diff --git a/references/1.4.1/common/IConfigRegistry.mdx b/references/1.4.1/common/IConfigRegistry.mdx deleted file mode 100644 index 7ef36a4..0000000 --- a/references/1.4.1/common/IConfigRegistry.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "IConfigRegistry interface" -icon: "plug" -description: "Resolves and validates typed configuration objects from the runtime environment." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IConfigRegistry - -## Summary - -Resolves and validates typed configuration objects from the runtime environment. -## Signature - -```typescript -interface IConfigRegistry -``` - -## Remarks - - An instance is available in `InitContext.config`. Configuration classes must be decorated with `class-transformer` (`@Expose`, `@Default`) and `class-validator` (`@IsPort`, `@IsIpOrURL`, etc.) decorators from `@nanoforge-dev/config`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/common/IConfigRegistry/registerConfig.mdx b/references/1.4.1/common/IConfigRegistry/registerConfig.mdx deleted file mode 100644 index d093467..0000000 --- a/references/1.4.1/common/IConfigRegistry/registerConfig.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "registerConfig" -icon: "file" -description: "Instantiate, populate from the runtime environment, transform, and validate a configuration class." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registerConfig - -## Summary - -Instantiate, populate from the runtime environment, transform, and validate a configuration class. - -## Description - -Instantiate, populate from the runtime environment, transform, and validate a configuration class. \ No newline at end of file diff --git a/references/1.4.1/common/IExposedLibrary.mdx b/references/1.4.1/common/IExposedLibrary.mdx deleted file mode 100644 index 488520d..0000000 --- a/references/1.4.1/common/IExposedLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IExposedLibrary interface" -icon: "plug" -description: "Marker interface for libraries that are directly accessible to game code via the ClientLibraryManager." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IExposedLibrary - -## Summary - -Marker interface for libraries that are directly accessible to game code via the `ClientLibraryManager`. -## Signature - -```typescript -interface IExposedLibrary extends ILibrary -``` - -## Remarks - - All built-in typed library interfaces (e.g. `IAssetManagerLibrary`, `ISoundLibrary`) extend this interface. \ No newline at end of file diff --git a/references/1.4.1/common/IGraphicsLibrary.mdx b/references/1.4.1/common/IGraphicsLibrary.mdx deleted file mode 100644 index 22daee8..0000000 --- a/references/1.4.1/common/IGraphicsLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IGraphicsLibrary interface" -icon: "plug" -description: "Interface for graphics libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IGraphicsLibrary - -## Summary - -Interface for graphics libraries. -## Signature - -```typescript -interface IGraphicsLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseGraphicsLibrary` and its concrete subclass `Graphics2DLibrary`. Access an instance via `ctx.libraries.getGraphics().library`. \ No newline at end of file diff --git a/references/1.4.1/common/IInputLibrary.mdx b/references/1.4.1/common/IInputLibrary.mdx deleted file mode 100644 index bff971f..0000000 --- a/references/1.4.1/common/IInputLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IInputLibrary interface" -icon: "plug" -description: "Interface for input libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IInputLibrary - -## Summary - -Interface for input libraries. -## Signature - -```typescript -interface IInputLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseInputLibrary` and its concrete subclass `InputLibrary`. Access an instance via `ctx.libraries.getInput().library`. \ No newline at end of file diff --git a/references/1.4.1/common/ILibrary.mdx b/references/1.4.1/common/ILibrary.mdx deleted file mode 100644 index cc0a1ea..0000000 --- a/references/1.4.1/common/ILibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ILibrary interface" -icon: "plug" -description: "Core interface that every NanoForge library must satisfy." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ILibrary - -## Summary - -Core interface that every NanoForge library must satisfy. -## Signature - -```typescript -interface ILibrary -``` - -## Remarks - - Implement this interface (or extend an abstract base such as `BaseAssetManagerLibrary`) to create a custom library and register it with the engine via `NanoforgeApplication.use`. \ No newline at end of file diff --git a/references/1.4.1/common/IMusicLibrary.mdx b/references/1.4.1/common/IMusicLibrary.mdx deleted file mode 100644 index 64ef5cb..0000000 --- a/references/1.4.1/common/IMusicLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IMusicLibrary interface" -icon: "plug" -description: "Interface for music libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IMusicLibrary - -## Summary - -Interface for music libraries. -## Signature - -```typescript -interface IMusicLibrary extends IExposedLibrary, IMutableLibrary -``` - -## Remarks - - Implemented by `BaseMusicLibrary` and its concrete subclass `MusicLibrary`. Access an instance via `ctx.libraries.getMusic().library`. \ No newline at end of file diff --git a/references/1.4.1/common/IMutableLibrary.mdx b/references/1.4.1/common/IMutableLibrary.mdx deleted file mode 100644 index 9300072..0000000 --- a/references/1.4.1/common/IMutableLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IMutableLibrary interface" -icon: "plug" -description: "Interface for libraries that support muting/unmuting audio playback." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IMutableLibrary - -## Summary - -Interface for libraries that support muting/unmuting audio playback. -## Signature - -```typescript -interface IMutableLibrary extends ILibrary -``` - -## Remarks - - Implemented by `ISoundLibrary` and `IMusicLibrary`. \ No newline at end of file diff --git a/references/1.4.1/common/IMutableLibrary/mute.mdx b/references/1.4.1/common/IMutableLibrary/mute.mdx deleted file mode 100644 index 74a6415..0000000 --- a/references/1.4.1/common/IMutableLibrary/mute.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "mute" -icon: "file" -description: "Toggle the muted state. Mutes when currently unmuted, and vice versa." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state. Mutes when currently unmuted, and vice versa. - -## Description - -Toggle the muted state. Mutes when currently unmuted, and vice versa. \ No newline at end of file diff --git a/references/1.4.1/common/INPUT_LIBRARY.mdx b/references/1.4.1/common/INPUT_LIBRARY.mdx deleted file mode 100644 index 52d6c76..0000000 --- a/references/1.4.1/common/INPUT_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "INPUT_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the input library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# INPUT_LIBRARY - -## Summary - -Registration symbol for the input library slot. -## Signature - -```typescript -INPUT_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useInput` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.1/common/INetworkLibrary.mdx b/references/1.4.1/common/INetworkLibrary.mdx deleted file mode 100644 index 9f1d44a..0000000 --- a/references/1.4.1/common/INetworkLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "INetworkLibrary interface" -icon: "plug" -description: "Interface for network libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# INetworkLibrary - -## Summary - -Interface for network libraries. -## Signature - -```typescript -interface INetworkLibrary extends IExposedLibrary -``` - -## Remarks - - Implemented by `BaseNetworkLibrary` and its concrete subclasses `NetworkClientLibrary` and `NetworkServerLibrary`. Access an instance via `ctx.libraries.getNetwork().library`. \ No newline at end of file diff --git a/references/1.4.1/common/IRunClientOptions.mdx b/references/1.4.1/common/IRunClientOptions.mdx deleted file mode 100644 index d9362af..0000000 --- a/references/1.4.1/common/IRunClientOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunClientOptions interface" -icon: "plug" -description: "Run options for a client-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunClientOptions - -## Summary - -Run options for a client-side NanoForge application. -## Signature - -```typescript -interface IRunClientOptions -``` - -## Remarks - - Pass an instance to `NanoforgeApplication.init` when running in the browser. The engine bundler (`nf build`) automatically generates and injects `files` and `env` at build time. \ No newline at end of file diff --git a/references/1.4.1/common/IRunClientOptions/container.mdx b/references/1.4.1/common/IRunClientOptions/container.mdx deleted file mode 100644 index 80e02b6..0000000 --- a/references/1.4.1/common/IRunClientOptions/container.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "container" -icon: "file" -description: "DOM element that will host the game canvas." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# container - -## Summary - -DOM element that will host the game canvas. - -## Description - -DOM element that will host the game canvas. - -## Remarks - - The element's current `offsetWidth` and `offsetHeight` are used to set the initial canvas dimensions. \ No newline at end of file diff --git a/references/1.4.1/common/IRunClientOptions/env.mdx b/references/1.4.1/common/IRunClientOptions/env.mdx deleted file mode 100644 index d416585..0000000 --- a/references/1.4.1/common/IRunClientOptions/env.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "env" -icon: "file" -description: "Runtime environment variables available to all libraries via InitContext.env." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Runtime environment variables available to all libraries via `InitContext.env`. - -## Description - -Runtime environment variables available to all libraries via . \ No newline at end of file diff --git a/references/1.4.1/common/IRunClientOptions/files.mdx b/references/1.4.1/common/IRunClientOptions/files.mdx deleted file mode 100644 index 2697027..0000000 --- a/references/1.4.1/common/IRunClientOptions/files.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "files" -icon: "file" -description: "Map of virtual file paths to their resolved URL strings." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their resolved URL strings. - -## Description - -Map of virtual file paths to their resolved URL strings. - -## Remarks - - Populated automatically by the NanoForge bundler. Keys are normalised paths such as `"/textures/hero.png"`. \ No newline at end of file diff --git a/references/1.4.1/common/IRunOptions.mdx b/references/1.4.1/common/IRunOptions.mdx deleted file mode 100644 index 725c3e0..0000000 --- a/references/1.4.1/common/IRunOptions.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "IRunOptions type" -icon: "file-code" -description: "Union of client and server run options accepted by NanoforgeApplication.init." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunOptions - -## Summary - -Union of client and server run options accepted by `NanoforgeApplication.init`. -## Signature - -```typescript -type IRunOptions = IRunClientOptions | IRunServerOptions; -``` \ No newline at end of file diff --git a/references/1.4.1/common/IRunServerOptions.mdx b/references/1.4.1/common/IRunServerOptions.mdx deleted file mode 100644 index 2c28702..0000000 --- a/references/1.4.1/common/IRunServerOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunServerOptions interface" -icon: "plug" -description: "Run options for a server-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunServerOptions - -## Summary - -Run options for a server-side NanoForge application. -## Signature - -```typescript -interface IRunServerOptions -``` - -## Remarks - - Pass an instance to `NanoforgeApplication.init` when running in a Node.js server process. \ No newline at end of file diff --git a/references/1.4.1/common/IRunServerOptions/env.mdx b/references/1.4.1/common/IRunServerOptions/env.mdx deleted file mode 100644 index d416585..0000000 --- a/references/1.4.1/common/IRunServerOptions/env.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "env" -icon: "file" -description: "Runtime environment variables available to all libraries via InitContext.env." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Runtime environment variables available to all libraries via `InitContext.env`. - -## Description - -Runtime environment variables available to all libraries via . \ No newline at end of file diff --git a/references/1.4.1/common/IRunServerOptions/files.mdx b/references/1.4.1/common/IRunServerOptions/files.mdx deleted file mode 100644 index 35be311..0000000 --- a/references/1.4.1/common/IRunServerOptions/files.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "files" -icon: "file" -description: "Map of virtual file paths to their resolved URL strings." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their resolved URL strings. - -## Description - -Map of virtual file paths to their resolved URL strings. - -## Remarks - - Populated automatically by the NanoForge bundler. Keys are normalised paths such as `"/data/config.json"`. \ No newline at end of file diff --git a/references/1.4.1/common/IRunnerLibrary.mdx b/references/1.4.1/common/IRunnerLibrary.mdx deleted file mode 100644 index ca7ec08..0000000 --- a/references/1.4.1/common/IRunnerLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunnerLibrary interface" -icon: "plug" -description: "Interface for libraries that participate in the per-frame game loop." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunnerLibrary - -## Summary - -Interface for libraries that participate in the per-frame game loop. -## Signature - -```typescript -interface IRunnerLibrary extends ILibrary -``` - -## Remarks - - The engine calls `__run` on every tick for all registered runner libraries in the order determined by their `ILibraryOptions.runBefore` / `ILibraryOptions.runAfter` relationships. \ No newline at end of file diff --git a/references/1.4.1/common/ISoundLibrary.mdx b/references/1.4.1/common/ISoundLibrary.mdx deleted file mode 100644 index f653be2..0000000 --- a/references/1.4.1/common/ISoundLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ISoundLibrary interface" -icon: "plug" -description: "Interface for sound-effect libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ISoundLibrary - -## Summary - -Interface for sound-effect libraries. -## Signature - -```typescript -interface ISoundLibrary extends IExposedLibrary, IMutableLibrary -``` - -## Remarks - - Implemented by `BaseSoundLibrary` and its concrete subclass `SoundLibrary`. Access an instance via `ctx.libraries.getSound().library`. \ No newline at end of file diff --git a/references/1.4.1/common/InitContext.mdx b/references/1.4.1/common/InitContext.mdx deleted file mode 100644 index 2cb673a..0000000 --- a/references/1.4.1/common/InitContext.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "InitContext class" -icon: "box" -description: "Context object passed to every library's init lifecycle hook." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InitContext - -## Summary - -Context object passed to every library's `__init` lifecycle hook. -## Signature - -```typescript -declare class InitContext extends BaseContext -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### config -**Modifiers**: readonly -**Type**:`get config(): IConfigRegistry;` - -Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment. - -### container -**Modifiers**: readonly -**Type**:`get container(): IRunClientOptions["container"] | undefined;` - -The that should host the game canvas. - -### env -**Modifiers**: readonly -**Type**:`get env(): Record;` - -Key/value map of environment variables made available at runtime. - -### files -**Modifiers**: readonly -**Type**:`get files(): IRunOptions["files"];` - -Map of virtual file paths to their URL strings, pre-loaded by the engine bundler. - -## Remarks - - Provides libraries with all the information they need during start-up: the canvas container, pre-loaded asset files, environment variables, and a config registry for loading structured configuration classes. Access it in a library's `__init` override: \ No newline at end of file diff --git a/references/1.4.1/common/InitContext/config.mdx b/references/1.4.1/common/InitContext/config.mdx deleted file mode 100644 index 862c74c..0000000 --- a/references/1.4.1/common/InitContext/config.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "config" -icon: "variable" -description: "Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# config - -## Summary - -Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment. - -## Remarks - - Call `ctx.config.registerConfig(MyConfigClass)` to get a validated and transformed instance populated from `ctx.env`. \ No newline at end of file diff --git a/references/1.4.1/common/InitContext/constructor.mdx b/references/1.4.1/common/InitContext/constructor.mdx deleted file mode 100644 index 9966e29..0000000 --- a/references/1.4.1/common/InitContext/constructor.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the InitContext class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `InitContext` class -## Signature - -```typescript -constructor(context: ApplicationContext, libraryManager: LibraryManager, configRegistry: IConfigRegistry, options: IRunOptions); -``` - -## Parameters - -### context -- **Type**:`ApplicationContext` - -Shared application-level runtime state. - -### libraryManager -- **Type**:`LibraryManager` - -Manager giving access to other registered libraries. - -### configRegistry -- **Type**:`IConfigRegistry` - -Registry used to resolve typed configuration objects. - -### options -- **Type**:`IRunOptions` - -Run options forwarded from NanoforgeApplication.init. \ No newline at end of file diff --git a/references/1.4.1/common/InitContext/container.mdx b/references/1.4.1/common/InitContext/container.mdx deleted file mode 100644 index 93f8c55..0000000 --- a/references/1.4.1/common/InitContext/container.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "container" -icon: "variable" -description: "The HTMLDivElement that should host the game canvas." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# container - -## Summary - -The `HTMLDivElement` that should host the game canvas. - -## Remarks - - Only available in client contexts; `undefined` on the server. \ No newline at end of file diff --git a/references/1.4.1/common/InitContext/env.mdx b/references/1.4.1/common/InitContext/env.mdx deleted file mode 100644 index 3e29538..0000000 --- a/references/1.4.1/common/InitContext/env.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "env" -icon: "variable" -description: "Key/value map of environment variables made available at runtime." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Key/value map of environment variables made available at runtime. \ No newline at end of file diff --git a/references/1.4.1/common/InitContext/files.mdx b/references/1.4.1/common/InitContext/files.mdx deleted file mode 100644 index cfebe1f..0000000 --- a/references/1.4.1/common/InitContext/files.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "files" -icon: "variable" -description: "Map of virtual file paths to their URL strings, pre-loaded by the engine bundler." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their URL strings, pre-loaded by the engine bundler. \ No newline at end of file diff --git a/references/1.4.1/common/Library.mdx b/references/1.4.1/common/Library.mdx deleted file mode 100644 index 71d845c..0000000 --- a/references/1.4.1/common/Library.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Library class" -icon: "box" -description: "Base class for all NanoForge libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Library - -## Summary - -Base class for all NanoForge libraries. -## Signature - -```typescript -declare abstract class Library implements ILibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### _relationship -**Modifiers**: protected -**Type**:`protected _relationship: RelationshipHandler;` - - - -## Remarks - - Extend this class (or one of its typed subclasses such as `BaseAssetManagerLibrary`, `BaseSoundLibrary`, etc.) to create a custom library. At minimum you must implement the `ILibrary.__name` getter and register the library with the engine before calling `NanoforgeApplication.init`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/common/Library/_relationship.mdx b/references/1.4.1/common/Library/_relationship.mdx deleted file mode 100644 index b5f1747..0000000 --- a/references/1.4.1/common/Library/_relationship.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "_relationship" -icon: "variable" -description: "_relationship API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _relationship \ No newline at end of file diff --git a/references/1.4.1/common/Library/constructor.mdx b/references/1.4.1/common/Library/constructor.mdx deleted file mode 100644 index f891ea6..0000000 --- a/references/1.4.1/common/Library/constructor.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the Library class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `Library` class -## Signature - -```typescript -constructor(rawOptions?: Partial); -``` - -## Parameters - -### rawOptions -- **Type**:`Partial` -- **Optional**: Yes - -Optional dependency and execution-order overrides. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryContext.mdx b/references/1.4.1/common/LibraryContext.mdx deleted file mode 100644 index 4697fb9..0000000 --- a/references/1.4.1/common/LibraryContext.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "LibraryContext class" -icon: "box" -description: "Tracks the current lifecycle state of a single library registration." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryContext - -## Summary - -Tracks the current lifecycle state of a single library registration. -## Signature - -```typescript -declare class LibraryContext -``` - -## Properties - -### status -**Modifiers**: readonly -**Type**:`get status(): LibraryStatusEnum;` - -Current lifecycle state of the associated library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryContext/status.mdx b/references/1.4.1/common/LibraryContext/status.mdx deleted file mode 100644 index 6f801c7..0000000 --- a/references/1.4.1/common/LibraryContext/status.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "status" -icon: "variable" -description: "Current lifecycle state of the associated library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# status - -## Summary - -Current lifecycle state of the associated library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryHandle.mdx b/references/1.4.1/common/LibraryHandle.mdx deleted file mode 100644 index 4aa0753..0000000 --- a/references/1.4.1/common/LibraryHandle.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "LibraryHandle class" -icon: "box" -description: "An opaque handle returned by LibraryManager accessors." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryHandle - -## Summary - -An opaque handle returned by `LibraryManager` accessors. -## Signature - -```typescript -declare class LibraryHandle -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### context -**Modifiers**: readonly -**Type**:`get context(): LibraryContext;` - -Current lifecycle context tracking the library's status. - -### library -**Modifiers**: readonly -**Type**:`get library(): T;` - -The underlying library instance. - -### symbol -**Modifiers**: readonly -**Type**:`get symbol(): symbol;` - -The registration symbol used to look up this library. - -## Remarks - - Bundles the library instance together with its registration symbol and lifecycle context. Prefer using the strongly-typed accessor methods on `LibraryManager` or `ClientLibraryManager` rather than constructing handles directly. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryHandle/constructor.mdx b/references/1.4.1/common/LibraryHandle/constructor.mdx deleted file mode 100644 index d2367b0..0000000 --- a/references/1.4.1/common/LibraryHandle/constructor.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the LibraryHandle class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `LibraryHandle` class -## Signature - -```typescript -constructor(sym: symbol, library: T, defaultContext: LibraryContext); -``` - -## Parameters - -### sym -- **Type**:`symbol` - -Registration symbol for this library. - -### library -- **Type**:`T` - -The library instance. - -### defaultContext -- **Type**:`LibraryContext` - -Initial lifecycle context. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryHandle/context.mdx b/references/1.4.1/common/LibraryHandle/context.mdx deleted file mode 100644 index 28d7907..0000000 --- a/references/1.4.1/common/LibraryHandle/context.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "context" -icon: "variable" -description: "Current lifecycle context tracking the library's status." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# context - -## Summary - -Current lifecycle context tracking the library's status. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryHandle/library.mdx b/references/1.4.1/common/LibraryHandle/library.mdx deleted file mode 100644 index c0f9812..0000000 --- a/references/1.4.1/common/LibraryHandle/library.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "library" -icon: "variable" -description: "The underlying library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# library - -## Summary - -The underlying library instance. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryHandle/symbol.mdx b/references/1.4.1/common/LibraryHandle/symbol.mdx deleted file mode 100644 index b47145d..0000000 --- a/references/1.4.1/common/LibraryHandle/symbol.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "symbol" -icon: "variable" -description: "The registration symbol used to look up this library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# symbol - -## Summary - -The registration symbol used to look up this library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager.mdx b/references/1.4.1/common/LibraryManager.mdx deleted file mode 100644 index 011fdfd..0000000 --- a/references/1.4.1/common/LibraryManager.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "LibraryManager class" -icon: "box" -description: "Central registry for all libraries registered with a NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryManager - -## Summary - -Central registry for all libraries registered with a NanoForge application. -## Signature - -```typescript -declare class LibraryManager extends BaseLibraryManager -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getAssetManager - -Retrieve the registered asset-manager library. - -### getComponentSystem - -Retrieve the registered component-system (ECS) library. - -### getGraphics - -Retrieve the registered graphics library. - -### getInput - -Retrieve the registered input library. - -### getMusic - -Retrieve the registered music library. - -### getNetwork - -Retrieve the registered network library. - -### getSound - -Retrieve the registered sound library. - -## Remarks - - An instance is available inside every lifecycle context via `BaseContext.libraries`. Use the typed accessor methods to retrieve any built-in library, or call `BaseLibraryManager.get` with a custom symbol for user-defined libraries. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager/constructor.mdx b/references/1.4.1/common/LibraryManager/constructor.mdx deleted file mode 100644 index f4a0c93..0000000 --- a/references/1.4.1/common/LibraryManager/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the LibraryManager class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `LibraryManager` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager/getAssetManager.mdx b/references/1.4.1/common/LibraryManager/getAssetManager.mdx deleted file mode 100644 index 7f2ea14..0000000 --- a/references/1.4.1/common/LibraryManager/getAssetManager.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getAssetManager" -icon: "function" -description: "Retrieve the registered asset-manager library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAssetManager - -## Summary - -Retrieve the registered asset-manager library. -## Signature - -```typescript -getAssetManager(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered asset-manager library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager/getComponentSystem.mdx b/references/1.4.1/common/LibraryManager/getComponentSystem.mdx deleted file mode 100644 index 45020f1..0000000 --- a/references/1.4.1/common/LibraryManager/getComponentSystem.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getComponentSystem" -icon: "function" -description: "Retrieve the registered component-system (ECS) library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentSystem - -## Summary - -Retrieve the registered component-system (ECS) library. -## Signature - -```typescript -getComponentSystem(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered component-system (ECS) library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager/getGraphics.mdx b/references/1.4.1/common/LibraryManager/getGraphics.mdx deleted file mode 100644 index fa2c568..0000000 --- a/references/1.4.1/common/LibraryManager/getGraphics.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getGraphics" -icon: "function" -description: "Retrieve the registered graphics library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getGraphics - -## Summary - -Retrieve the registered graphics library. -## Signature - -```typescript -getGraphics(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered graphics library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager/getInput.mdx b/references/1.4.1/common/LibraryManager/getInput.mdx deleted file mode 100644 index 238f50f..0000000 --- a/references/1.4.1/common/LibraryManager/getInput.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getInput" -icon: "function" -description: "Retrieve the registered input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getInput - -## Summary - -Retrieve the registered input library. -## Signature - -```typescript -getInput(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered input library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager/getMusic.mdx b/references/1.4.1/common/LibraryManager/getMusic.mdx deleted file mode 100644 index e8fc5f8..0000000 --- a/references/1.4.1/common/LibraryManager/getMusic.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMusic" -icon: "function" -description: "Retrieve the registered music library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMusic - -## Summary - -Retrieve the registered music library. -## Signature - -```typescript -getMusic(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered music library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager/getNetwork.mdx b/references/1.4.1/common/LibraryManager/getNetwork.mdx deleted file mode 100644 index b5df49a..0000000 --- a/references/1.4.1/common/LibraryManager/getNetwork.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getNetwork" -icon: "function" -description: "Retrieve the registered network library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getNetwork - -## Summary - -Retrieve the registered network library. -## Signature - -```typescript -getNetwork(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered network library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryManager/getSound.mdx b/references/1.4.1/common/LibraryManager/getSound.mdx deleted file mode 100644 index 3e4c97a..0000000 --- a/references/1.4.1/common/LibraryManager/getSound.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getSound" -icon: "function" -description: "Retrieve the registered sound library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getSound - -## Summary - -Retrieve the registered sound library. -## Signature - -```typescript -getSound(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered sound library. \ No newline at end of file diff --git a/references/1.4.1/common/LibraryStatusEnum.mdx b/references/1.4.1/common/LibraryStatusEnum.mdx deleted file mode 100644 index 747ba33..0000000 --- a/references/1.4.1/common/LibraryStatusEnum.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "LibraryStatusEnum enum" -icon: "list" -description: "Lifecycle states a library can be in." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryStatusEnum - -## Summary - -Lifecycle states a library can be in. - -## Members -| Member | Description | -| ------ | ----------- | -| `CLEAR` | The library has been cleared and its resources released. | -| `LOADED` | The library has been successfully initialised and is ready to use. | -| `UNLOADED` | The library has not been initialised yet. | \ No newline at end of file diff --git a/references/1.4.1/common/MUSIC_LIBRARY.mdx b/references/1.4.1/common/MUSIC_LIBRARY.mdx deleted file mode 100644 index 1ed1240..0000000 --- a/references/1.4.1/common/MUSIC_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "MUSIC_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the music library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# MUSIC_LIBRARY - -## Summary - -Registration symbol for the music library slot. -## Signature - -```typescript -MUSIC_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.use` with a custom music library or use it as a dependency symbol in `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.1/common/NETWORK_LIBRARY.mdx b/references/1.4.1/common/NETWORK_LIBRARY.mdx deleted file mode 100644 index eedcf69..0000000 --- a/references/1.4.1/common/NETWORK_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "NETWORK_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the network library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NETWORK_LIBRARY - -## Summary - -Registration symbol for the network library slot. -## Signature - -```typescript -NETWORK_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.useNetwork` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.1/common/NfConfigException.mdx b/references/1.4.1/common/NfConfigException.mdx deleted file mode 100644 index 1777a60..0000000 --- a/references/1.4.1/common/NfConfigException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfConfigException class" -icon: "box" -description: "Thrown when a library configuration is invalid or incomplete." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfConfigException - -## Summary - -Thrown when a library configuration is invalid or incomplete. -## Signature - -```typescript -declare class NfConfigException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Remarks - - Typically raised during `__init` when required environment variables are missing or fail validation. For example, `NetworkClientLibrary` throws this when neither `SERVER_TCP_PORT` nor `SERVER_UDP_PORT` is provided. \ No newline at end of file diff --git a/references/1.4.1/common/NfConfigException/code.mdx b/references/1.4.1/common/NfConfigException/code.mdx deleted file mode 100644 index 3401684..0000000 --- a/references/1.4.1/common/NfConfigException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 400." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `400`. \ No newline at end of file diff --git a/references/1.4.1/common/NfConfigException/constructor.mdx b/references/1.4.1/common/NfConfigException/constructor.mdx deleted file mode 100644 index 27d50ba..0000000 --- a/references/1.4.1/common/NfConfigException/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfConfigException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfConfigException` class -## Signature - -```typescript -constructor(message: string, library?: string); -``` - -## Parameters - -### message -- **Type**:`string` - -Description of the configuration error. - -### library -- **Type**:`string` -- **Optional**: Yes - -Optional library name that detected the error. \ No newline at end of file diff --git a/references/1.4.1/common/NfFetchException.mdx b/references/1.4.1/common/NfFetchException.mdx deleted file mode 100644 index 91501a8..0000000 --- a/references/1.4.1/common/NfFetchException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfFetchException class" -icon: "box" -description: "Thrown when an HTTP fetch performed internally by the engine fails." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfFetchException - -## Summary - -Thrown when an HTTP fetch performed internally by the engine fails. -## Signature - -```typescript -declare class NfFetchException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -The HTTP status code returned by the failed request (e.g. , ). - -## Remarks - - Raised by `NfFile` methods (e.g. `arrayBuffer`, `text`) when the underlying `fetch` call returns a non-OK HTTP response. \ No newline at end of file diff --git a/references/1.4.1/common/NfFetchException/code.mdx b/references/1.4.1/common/NfFetchException/code.mdx deleted file mode 100644 index f832308..0000000 --- a/references/1.4.1/common/NfFetchException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "The HTTP status code returned by the failed request (e.g. 404, 500)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -The HTTP status code returned by the failed request (e.g. `404`, `500`). \ No newline at end of file diff --git a/references/1.4.1/common/NfFetchException/constructor.mdx b/references/1.4.1/common/NfFetchException/constructor.mdx deleted file mode 100644 index 2fb11ee..0000000 --- a/references/1.4.1/common/NfFetchException/constructor.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfFetchException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfFetchException` class -## Signature - -```typescript -constructor(code: number, text: string); -``` - -## Parameters - -### code -- **Type**:`number` - -HTTP status code of the failed response. - -### text -- **Type**:`string` - -Status text of the failed response. \ No newline at end of file diff --git a/references/1.4.1/common/NfFile.mdx b/references/1.4.1/common/NfFile.mdx deleted file mode 100644 index 80bfa2e..0000000 --- a/references/1.4.1/common/NfFile.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "NfFile class" -icon: "box" -description: "Represents a file asset that has been registered with the engine." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfFile - -## Summary - -Represents a file asset that has been registered with the engine. -## Signature - -```typescript -declare class NfFile -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### path -**Modifiers**: readonly -**Type**:`get path(): string;` - -Internal URL path used to fetch the file. - -## Methods - -### arrayBuffer - -Fetch the file and return its content as an . - -### blob - -Fetch the file and return its content as a . - -### bytes - -Fetch the file and return its content as a . - -### formData - -Fetch the file and return its content as . - -### json - -Fetch the file, parse it as JSON, and return the result. - -### text - -Fetch the file and return its content as a UTF-8 string. - -## Remarks - - Instances are returned by `AssetManagerLibrary.getAsset`. Each method lazily fetches the file from the engine's virtual file system and returns the content in the requested format. All read methods throw `NfFetchException` when the underlying `fetch` returns a non-OK response. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/common/NfFile/arrayBuffer.mdx b/references/1.4.1/common/NfFile/arrayBuffer.mdx deleted file mode 100644 index 0a94d62..0000000 --- a/references/1.4.1/common/NfFile/arrayBuffer.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "arrayBuffer" -icon: "function" -description: "Fetch the file and return its content as an ArrayBuffer." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# arrayBuffer - -## Summary - -Fetch the file and return its content as an `ArrayBuffer`. -## Signature - -```typescript -arrayBuffer(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as an . \ No newline at end of file diff --git a/references/1.4.1/common/NfFile/blob.mdx b/references/1.4.1/common/NfFile/blob.mdx deleted file mode 100644 index f5a1fd4..0000000 --- a/references/1.4.1/common/NfFile/blob.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "blob" -icon: "function" -description: "Fetch the file and return its content as a Blob." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# blob - -## Summary - -Fetch the file and return its content as a `Blob`. -## Signature - -```typescript -blob(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as a . \ No newline at end of file diff --git a/references/1.4.1/common/NfFile/bytes.mdx b/references/1.4.1/common/NfFile/bytes.mdx deleted file mode 100644 index c43ba59..0000000 --- a/references/1.4.1/common/NfFile/bytes.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "bytes" -icon: "function" -description: "Fetch the file and return its content as a Uint8Array." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# bytes - -## Summary - -Fetch the file and return its content as a `Uint8Array`. -## Signature - -```typescript -bytes(): Promise>; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise>` - -Fetch the file and return its content as a . \ No newline at end of file diff --git a/references/1.4.1/common/NfFile/constructor.mdx b/references/1.4.1/common/NfFile/constructor.mdx deleted file mode 100644 index 3e80d1f..0000000 --- a/references/1.4.1/common/NfFile/constructor.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfFile class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfFile` class -## Signature - -```typescript -constructor(path: string); -``` - -## Parameters - -### path -- **Type**:`string` - -Internal URL path used to fetch the file. \ No newline at end of file diff --git a/references/1.4.1/common/NfFile/formData.mdx b/references/1.4.1/common/NfFile/formData.mdx deleted file mode 100644 index 93ab538..0000000 --- a/references/1.4.1/common/NfFile/formData.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "formData" -icon: "function" -description: "Fetch the file and return its content as FormData." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# formData - -## Summary - -Fetch the file and return its content as `FormData`. -## Signature - -```typescript -formData(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as . \ No newline at end of file diff --git a/references/1.4.1/common/NfFile/json.mdx b/references/1.4.1/common/NfFile/json.mdx deleted file mode 100644 index 350501a..0000000 --- a/references/1.4.1/common/NfFile/json.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "json" -icon: "function" -description: "Fetch the file, parse it as JSON, and return the result." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# json - -## Summary - -Fetch the file, parse it as JSON, and return the result. -## Signature - -```typescript -json(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file, parse it as JSON, and return the result. \ No newline at end of file diff --git a/references/1.4.1/common/NfFile/path.mdx b/references/1.4.1/common/NfFile/path.mdx deleted file mode 100644 index 4653fc5..0000000 --- a/references/1.4.1/common/NfFile/path.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "path" -icon: "variable" -description: "Internal URL path used to fetch the file." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# path - -## Summary - -Internal URL path used to fetch the file. \ No newline at end of file diff --git a/references/1.4.1/common/NfFile/text.mdx b/references/1.4.1/common/NfFile/text.mdx deleted file mode 100644 index 87ed647..0000000 --- a/references/1.4.1/common/NfFile/text.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "text" -icon: "function" -description: "Fetch the file and return its content as a UTF-8 string." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# text - -## Summary - -Fetch the file and return its content as a UTF-8 string. -## Signature - -```typescript -text(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as a UTF-8 string. \ No newline at end of file diff --git a/references/1.4.1/common/NfNotFound.mdx b/references/1.4.1/common/NfNotFound.mdx deleted file mode 100644 index 656e89d..0000000 --- a/references/1.4.1/common/NfNotFound.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "NfNotFound class" -icon: "box" -description: "Thrown when a requested resource (asset, sound, music track, etc.) cannot be found in the engine's registry." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfNotFound - -## Summary - -Thrown when a requested resource (asset, sound, music track, etc.) cannot be found in the engine's registry. -## Signature - -```typescript -declare class NfNotFound extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/common/NfNotFound/code.mdx b/references/1.4.1/common/NfNotFound/code.mdx deleted file mode 100644 index 8bd0665..0000000 --- a/references/1.4.1/common/NfNotFound/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 404." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `404`. \ No newline at end of file diff --git a/references/1.4.1/common/NfNotFound/constructor.mdx b/references/1.4.1/common/NfNotFound/constructor.mdx deleted file mode 100644 index 8165021..0000000 --- a/references/1.4.1/common/NfNotFound/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfNotFound class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfNotFound` class -## Signature - -```typescript -constructor(item: string, type?: string); -``` - -## Parameters - -### item -- **Type**:`string` - -Name or path of the missing resource. - -### type -- **Type**:`string` -- **Optional**: Yes - -Optional category label (e.g. "Asset", "Sound"). \ No newline at end of file diff --git a/references/1.4.1/common/NfNotInitializedException.mdx b/references/1.4.1/common/NfNotInitializedException.mdx deleted file mode 100644 index a6bfda6..0000000 --- a/references/1.4.1/common/NfNotInitializedException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfNotInitializedException class" -icon: "box" -description: "Thrown when a method is called on a library or engine component before it has been initialised via init." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfNotInitializedException - -## Summary - -Thrown when a method is called on a library or engine component before it has been initialised via `__init`. -## Signature - -```typescript -declare class NfNotInitializedException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Remarks - - This exception is raised automatically by the helper method `Library.throwNotInitializedError()`. Ensure that `NanoforgeApplication.init` has resolved before interacting with any library. \ No newline at end of file diff --git a/references/1.4.1/common/NfNotInitializedException/code.mdx b/references/1.4.1/common/NfNotInitializedException/code.mdx deleted file mode 100644 index 8bd0665..0000000 --- a/references/1.4.1/common/NfNotInitializedException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 404." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `404`. \ No newline at end of file diff --git a/references/1.4.1/common/NfNotInitializedException/constructor.mdx b/references/1.4.1/common/NfNotInitializedException/constructor.mdx deleted file mode 100644 index f26a60c..0000000 --- a/references/1.4.1/common/NfNotInitializedException/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfNotInitializedException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfNotInitializedException` class -## Signature - -```typescript -constructor(item: string, type?: string); -``` - -## Parameters - -### item -- **Type**:`string` - -Name of the uninitialised component (e.g. the library's __name). - -### type -- **Type**:`string` -- **Optional**: Yes - -Optional category label (e.g. "Library"). \ No newline at end of file diff --git a/references/1.4.1/common/SOUND_LIBRARY.mdx b/references/1.4.1/common/SOUND_LIBRARY.mdx deleted file mode 100644 index 3f53355..0000000 --- a/references/1.4.1/common/SOUND_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "SOUND_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the sound library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SOUND_LIBRARY - -## Summary - -Registration symbol for the sound library slot. -## Signature - -```typescript -SOUND_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useSound` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.1/config/0-index.mdx b/references/1.4.1/config/0-index.mdx deleted file mode 100644 index 40c1d35..0000000 --- a/references/1.4.1/config/0-index.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: "Config" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/config` is a wrapper of [class-validator][class-validator] and [class-transformer][class-transformer] to imports validation and transformation decorators. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/config -yarn add @nanoforge-dev/config -pnpm add @nanoforge-dev/config -bun add @nanoforge-dev/config -``` - -## Warning - -This library is of exclusive usage for other libraries. To put variables in the environment to allow libraries to use it through this config library, you must put it in `.env` file at the root of your project (or in your environment) : - -```dotenv -NANOFORGE_CLIENT_SERVER_TCP_PORT=4445 -NANOFORGE_CLIENT_SERVER_UDP_PORT=4444 -NANOFORGE_CLIENT_SERVER_ADDRESS=127.0.0.1 -``` - -You must prefix your variables according to this table : - -| Prefix | Availability | -| :------------------ | :----------------------- | -| `NANOFORGE_CLIENT_` | Available in client only | -| `NANOFORGE_SERVER_` | Available in server only | -| `NANOFORGE_` | Available in both apps | - -⚠️ Prefixs are removed in libs - -You can also put it in init options (every value must be string or undefined) : - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkLibrary } from "@nanoforge-dev/network"; - -export async function main(options: IRunOptions) { - const app = NanoforgeFactory.createClient(); - - const network = new NetworkLibrary(); - - app.useNetwork(network); - - await app.init({ - ...options, - env: { - ...options.env, - SERVER_TCP_PORT: "4445", - SERVER_UDP_PORT: "4444", - SERVER_ADDRESS: "127.0.0.1", - }, - }); - - await app.run(); -} -``` - -## Example usage - -Initialize the library in your main file. - -```ts -export class NetworkClientLibrary extends BaseNetworkLibrary { - get __name(): string { - return "NetworkClientLibrary"; - } - - public override async __init(context: InitContext): Promise { - const config = await context.config.registerConfig(ClientConfigNetwork); - - // Do something with config - } -} -``` - -Using this config - -```ts -import { - Default, - Expose, - IsByteLength, - IsIpOrURL, - IsOptional, - IsPort, -} from "@nanoforge-dev/config"; - -export class ClientConfigNetwork { - // This var must be a string port (ex: "4444") but can be undefined - @Expose() - @IsOptional() - @IsPort() - SERVER_TCP_PORT?: string; - - @Expose() - @IsOptional() - @IsPort() - SERVER_UDP_PORT?: string; - - // This var must be ip address or fqdn (it cannot be undefined) - @Expose() - @IsIpOrURL() - SERVER_ADDRESS?: string; - - // This var must be a byte length between 2 and 64. It can be undefined as it as a default value. - @Expose() - @Default("PACKET_END") - @IsByteLength(2, 64) - MAGIC_VALUE!: string; -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/config -[npm]: https://www.npmjs.com/package/@nanoforge-dev/config -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md -[class-validator]: https://github.com/typestack/class-validator -[class-transformer]: https://github.com/typestack/class-transformer diff --git a/references/1.4.1/config/Default.mdx b/references/1.4.1/config/Default.mdx deleted file mode 100644 index aeb1dc4..0000000 --- a/references/1.4.1/config/Default.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Default function" -icon: "function" -description: "Property decorator that supplies a fallback value when the environment variable is undefined or null." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Default - -## Summary - -Property decorator that supplies a fallback value when the environment variable is `undefined` or `null`. -## Signature - -```typescript -declare function Default(defaultValue: unknown): PropertyDecorator; -``` - -## Parameters - -### defaultValue -**Type**:`unknown` - -The value to use when the property is absent. - -## Returns - -**Type**:`PropertyDecorator` - -Property decorator that supplies a fallback value when the environment variable is or . - -## Remarks - - Pairs with `class-transformer`'s `@Expose` and `class-validator` decorators. The default is deep-cloned via `JSON.parse(JSON.stringify(…))` so objects are not shared between instances. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/config/IsIpOrURL.mdx b/references/1.4.1/config/IsIpOrURL.mdx deleted file mode 100644 index 07e9197..0000000 --- a/references/1.4.1/config/IsIpOrURL.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "IsIpOrURL function" -icon: "function" -description: "Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (URL)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IsIpOrURL - -## Summary - -Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (URL). -## Signature - -```typescript -IsIpOrURL: (validationOptions?: ValidationOptions) => (object: object, propertyName: string) => void -``` - -## Parameters - -### validationOptions -**Type**:`ValidationOptions` -**Optional**: Yes - -Optional class-validator validation options. - -## Returns - -**Type**:`(object: object, propertyName: string) => void` - -Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (URL). - -## Remarks - - Built on top of `class-validator`'s `isIP` and `isURL` helpers. Use on config properties that represent server hostnames or addresses. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/config/TransformToBoolean.mdx b/references/1.4.1/config/TransformToBoolean.mdx deleted file mode 100644 index 4efdf4e..0000000 --- a/references/1.4.1/config/TransformToBoolean.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "TransformToBoolean function" -icon: "function" -description: "Property decorator that transforms the string environment variable value \"true\" or \"false\" into a native boolean." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TransformToBoolean - -## Summary - -Property decorator that transforms the string environment variable value `"true"` or `"false"` into a native `boolean`. -## Signature - -```typescript -TransformToBoolean: () => PropertyDecorator -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`PropertyDecorator` - -Property decorator that transforms the string environment variable value or into a native . - -## Remarks - - Returns `undefined` for any value that is neither `"true"` nor `"false"`. Pair with `@IsBoolean()` and `@Default(false)` for a fully validated and defaulted boolean config property. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/core-editor/0-index.mdx b/references/1.4.1/core-editor/0-index.mdx deleted file mode 100644 index 339d811..0000000 --- a/references/1.4.1/core-editor/0-index.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Core Editor" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/core-editor` is a package made to allow the editor to make change to a game even if it's already compiled and running. - -If you want a core to run your game use the `@nanoforge-dev/core`. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/core-editor -yarn add @nanoforge-dev/core-editor -pnpm add @nanoforge-dev/core-editor -bun add @nanoforge-dev/core-editor -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/core-editor -[npm]: https://www.npmjs.com/package/@nanoforge-dev/core-editor -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/core-editor/CoreEvents.mdx b/references/1.4.1/core-editor/CoreEvents.mdx deleted file mode 100644 index 1fc259b..0000000 --- a/references/1.4.1/core-editor/CoreEvents.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "CoreEvents enum" -icon: "list" -description: "Events that the NanoForge editor can emit to the running engine." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# CoreEvents - -## Summary - -Events that the NanoForge editor can emit to the running engine. - -## Members -| Member | Description | -| ------ | ----------- | -| `HARD_RELOAD` | Reload all entities component params | -| `HOT_RELOAD` | Reload only changed entity components params (live-patch) | -| `PAUSE_GAME` | Don't execute the run function until UNPAUSE_GAME | -| `STOP_GAME` | End main loop and clear | -| `UNPAUSE_GAME` | resume executing the run function | \ No newline at end of file diff --git a/references/1.4.1/core-editor/EditorEvents.mdx b/references/1.4.1/core-editor/EditorEvents.mdx deleted file mode 100644 index d62aa05..0000000 --- a/references/1.4.1/core-editor/EditorEvents.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "EditorEvents enum" -icon: "list" -description: "EditorEvents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorEvents - -## Members -| Member | Description | -| ------ | ----------- | -| `MOVE_COMPONENT` | | \ No newline at end of file diff --git a/references/1.4.1/core-editor/EventEmitter.mdx b/references/1.4.1/core-editor/EventEmitter.mdx deleted file mode 100644 index 12dd7b2..0000000 --- a/references/1.4.1/core-editor/EventEmitter.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "EventEmitter class" -icon: "box" -description: "EventEmitter API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EventEmitter -## Signature - -```typescript -declare class EventEmitter -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### emit - - - -### on - - - -### runEvents \ No newline at end of file diff --git a/references/1.4.1/core-editor/EventEmitter/constructor.mdx b/references/1.4.1/core-editor/EventEmitter/constructor.mdx deleted file mode 100644 index 1a46ef1..0000000 --- a/references/1.4.1/core-editor/EventEmitter/constructor.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the EventEmitter class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `EventEmitter` class -## Signature - -```typescript -constructor(opts: IRunOptions["editor"]); -``` - -## Parameters - -### opts -- **Type**:`IRunOptions["editor"]` \ No newline at end of file diff --git a/references/1.4.1/core-editor/EventEmitter/emit.mdx b/references/1.4.1/core-editor/EventEmitter/emit.mdx deleted file mode 100644 index c3eedbd..0000000 --- a/references/1.4.1/core-editor/EventEmitter/emit.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "emit" -icon: "function" -description: "emit API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# emit -## Signature - -```typescript -emit(event: K, ...args: EditorEventsMap[K]): void; -``` - -## Parameters - -### event -**Type**:`K` - - - -### args -**Type**:`EditorEventsMap[K]` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.1/core-editor/EventEmitter/on.mdx b/references/1.4.1/core-editor/EventEmitter/on.mdx deleted file mode 100644 index 21e7823..0000000 --- a/references/1.4.1/core-editor/EventEmitter/on.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "on" -icon: "function" -description: "on API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# on -## Signature - -```typescript -on(event: K, listener: ListenerType): void; -``` - -## Parameters - -### event -**Type**:`K` - - - -### listener -**Type**:`ListenerType` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.1/core-editor/EventEmitter/runEvents.mdx b/references/1.4.1/core-editor/EventEmitter/runEvents.mdx deleted file mode 100644 index 15658b2..0000000 --- a/references/1.4.1/core-editor/EventEmitter/runEvents.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "runEvents" -icon: "function" -description: "runEvents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# runEvents -## Signature - -```typescript -runEvents(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.1/core-editor/NanoforgeClient.mdx b/references/1.4.1/core-editor/NanoforgeClient.mdx deleted file mode 100644 index 7efda75..0000000 --- a/references/1.4.1/core-editor/NanoforgeClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NanoforgeClient class" -icon: "box" -description: "Client-side NanoForge application for editor mode." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeClient - -## Summary - -Client-side NanoForge application for editor mode. -## Signature - -```typescript -declare class NanoforgeClient extends NanoforgeApplication -``` - -## Methods - -### useGraphics - -Register the graphics library. - -### useInput - -Register the input library. - -### useSound - -Register the sound-effect library. - -## Remarks - - Extends `NanoforgeApplication` with graphics, input, and sound library slots. Create via the `core-editor` `NanoforgeFactory`. \ No newline at end of file diff --git a/references/1.4.1/core-editor/NanoforgeClient/useGraphics.mdx b/references/1.4.1/core-editor/NanoforgeClient/useGraphics.mdx deleted file mode 100644 index 27045ab..0000000 --- a/references/1.4.1/core-editor/NanoforgeClient/useGraphics.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useGraphics" -icon: "function" -description: "Register the graphics library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useGraphics - -## Summary - -Register the graphics library. -## Signature - -```typescript -useGraphics(library: IGraphicsLibrary): void; -``` - -## Parameters - -### library -**Type**:`IGraphicsLibrary` - -Graphics library instance (e.g. Graphics2DLibrary). - -## Returns - -**Type**:`void` - -Register the graphics library. \ No newline at end of file diff --git a/references/1.4.1/core-editor/NanoforgeClient/useInput.mdx b/references/1.4.1/core-editor/NanoforgeClient/useInput.mdx deleted file mode 100644 index 799cad5..0000000 --- a/references/1.4.1/core-editor/NanoforgeClient/useInput.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useInput" -icon: "function" -description: "Register the input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useInput - -## Summary - -Register the input library. -## Signature - -```typescript -useInput(library: IInputLibrary): void; -``` - -## Parameters - -### library -**Type**:`IInputLibrary` - -Input library instance (e.g. InputLibrary). - -## Returns - -**Type**:`void` - -Register the input library. \ No newline at end of file diff --git a/references/1.4.1/core-editor/NanoforgeClient/useSound.mdx b/references/1.4.1/core-editor/NanoforgeClient/useSound.mdx deleted file mode 100644 index 30f6b34..0000000 --- a/references/1.4.1/core-editor/NanoforgeClient/useSound.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useSound" -icon: "function" -description: "Register the sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useSound - -## Summary - -Register the sound-effect library. -## Signature - -```typescript -useSound(library: ISoundLibrary): void; -``` - -## Parameters - -### library -**Type**:`ISoundLibrary` - -Sound library instance (e.g. SoundLibrary). - -## Returns - -**Type**:`void` - -Register the sound-effect library. \ No newline at end of file diff --git a/references/1.4.1/core-editor/NanoforgeFactory.mdx b/references/1.4.1/core-editor/NanoforgeFactory.mdx deleted file mode 100644 index 88d924e..0000000 --- a/references/1.4.1/core-editor/NanoforgeFactory.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeFactory variable" -icon: "variable" -description: "Singleton factory for creating editor-mode NanoForge client and server applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeFactory - -## Summary - -Singleton factory for creating editor-mode NanoForge client and server applications. -## Signature - -```typescript -NanoforgeFactory: NanoforgeFactoryStatic -``` - -## Remarks - - Use `NanoforgeFactory.createClient` or `NanoforgeFactory.createServer` to obtain an application instance that accepts `IEditorRunOptions` on `init`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/core-editor/NanoforgeServer.mdx b/references/1.4.1/core-editor/NanoforgeServer.mdx deleted file mode 100644 index 81c27e0..0000000 --- a/references/1.4.1/core-editor/NanoforgeServer.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "NanoforgeServer class" -icon: "box" -description: "Server-side NanoForge application for editor mode." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeServer - -## Summary - -Server-side NanoForge application for editor mode. -## Signature - -```typescript -declare class NanoforgeServer extends NanoforgeApplication -``` - -## Remarks - - Extends `NanoforgeApplication` for use in server processes during editor sessions. Create via the `core-editor` `NanoforgeFactory`. \ No newline at end of file diff --git a/references/1.4.1/core/0-index.mdx b/references/1.4.1/core/0-index.mdx deleted file mode 100644 index 4f7f4ac..0000000 --- a/references/1.4.1/core/0-index.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "Core" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/core` is a core package that contains game main loop. It is used to initialize the game and run it. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/core -yarn add @nanoforge-dev/core -pnpm add @nanoforge-dev/core -bun add @nanoforge-dev/core -``` - -## Example usage - -Initialize the game in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - await app.init(options); - - await app.run(); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/core -[npm]: https://www.npmjs.com/package/@nanoforge-dev/core -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/core/NanoforgeClient.mdx b/references/1.4.1/core/NanoforgeClient.mdx deleted file mode 100644 index eab01be..0000000 --- a/references/1.4.1/core/NanoforgeClient.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "NanoforgeClient class" -icon: "box" -description: "Client-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeClient - -## Summary - -Client-side NanoForge application. -## Signature - -```typescript -declare class NanoforgeClient extends NanoforgeApplication -``` - -## Methods - -### useGraphics - -Register the graphics library used to render the game. - -### useInput - -Register the input library used to read keyboard and mouse state. - -### useSound - -Register the sound-effect library. - -## Remarks - - Extends `NanoforgeApplication` with client-specific library slots for graphics, input, and sound. Create an instance via `NanoforgeFactory.createClient`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/core/NanoforgeClient/useGraphics.mdx b/references/1.4.1/core/NanoforgeClient/useGraphics.mdx deleted file mode 100644 index ce92bfb..0000000 --- a/references/1.4.1/core/NanoforgeClient/useGraphics.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useGraphics" -icon: "function" -description: "Register the graphics library used to render the game." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useGraphics - -## Summary - -Register the graphics library used to render the game. -## Signature - -```typescript -useGraphics(library: IGraphicsLibrary): void; -``` - -## Parameters - -### library -**Type**:`IGraphicsLibrary` - -Graphics library instance (e.g. Graphics2DLibrary). - -## Returns - -**Type**:`void` - -Register the graphics library used to render the game. \ No newline at end of file diff --git a/references/1.4.1/core/NanoforgeClient/useInput.mdx b/references/1.4.1/core/NanoforgeClient/useInput.mdx deleted file mode 100644 index 2e014a7..0000000 --- a/references/1.4.1/core/NanoforgeClient/useInput.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useInput" -icon: "function" -description: "Register the input library used to read keyboard and mouse state." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useInput - -## Summary - -Register the input library used to read keyboard and mouse state. -## Signature - -```typescript -useInput(library: IInputLibrary): void; -``` - -## Parameters - -### library -**Type**:`IInputLibrary` - -Input library instance (e.g. InputLibrary). - -## Returns - -**Type**:`void` - -Register the input library used to read keyboard and mouse state. \ No newline at end of file diff --git a/references/1.4.1/core/NanoforgeClient/useSound.mdx b/references/1.4.1/core/NanoforgeClient/useSound.mdx deleted file mode 100644 index 30f6b34..0000000 --- a/references/1.4.1/core/NanoforgeClient/useSound.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useSound" -icon: "function" -description: "Register the sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useSound - -## Summary - -Register the sound-effect library. -## Signature - -```typescript -useSound(library: ISoundLibrary): void; -``` - -## Parameters - -### library -**Type**:`ISoundLibrary` - -Sound library instance (e.g. SoundLibrary). - -## Returns - -**Type**:`void` - -Register the sound-effect library. \ No newline at end of file diff --git a/references/1.4.1/core/NanoforgeFactory.mdx b/references/1.4.1/core/NanoforgeFactory.mdx deleted file mode 100644 index a383a67..0000000 --- a/references/1.4.1/core/NanoforgeFactory.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeFactory variable" -icon: "variable" -description: "Singleton factory for creating NanoForge client and server applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeFactory - -## Summary - -Singleton factory for creating NanoForge client and server applications. -## Signature - -```typescript -NanoforgeFactory: NanoforgeFactoryStatic -``` - -## Remarks - - Use `NanoforgeFactory.createClient` or `NanoforgeFactory.createServer` to obtain a new application instance, then attach libraries and call `init` / `run`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/core/NanoforgeServer.mdx b/references/1.4.1/core/NanoforgeServer.mdx deleted file mode 100644 index 5430293..0000000 --- a/references/1.4.1/core/NanoforgeServer.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeServer class" -icon: "box" -description: "Server-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeServer - -## Summary - -Server-side NanoForge application. -## Signature - -```typescript -declare class NanoforgeServer extends NanoforgeApplication -``` - -## Remarks - - Extends `NanoforgeApplication` for use in Node.js server processes. Create an instance via `NanoforgeFactory.createServer`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-client/0-index.mdx b/references/1.4.1/ecs-client/0-index.mdx deleted file mode 100644 index fb79025..0000000 --- a/references/1.4.1/ecs-client/0-index.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Ecs Client" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-client` is a wrapper of `@nanoforge-dev/ecs-lib` for client-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-client -yarn add @nanoforge-dev/ecs-client -pnpm add @nanoforge-dev/ecs-client -bun add @nanoforge-dev/ecs-client -``` - -## Example usage - -Initialize the library in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSClientLibrary } from "@nanoforge-dev/ecs-client"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const ecs = new ECSClientLibrary(); - - app.useComponentSystem(ecs); - - await app.init(options); - - const registry = ecs.registry; - - const entity = registry.spawnEntity(); - registry.addComponent(entity, new ExampleComponent("foo", 42)); - - registry.addSystem(exampleSystem); - - await app.run(); -} -``` - -With component - -```ts -export class ExampleComponent { - name = this.constructor.name; - - constructor( - public paramA: string, - public paramB: number, - public paramC: boolean = false, - ) {} - - get foo() { - return "bar"; - } - - get paramAOrDefault() { - return this.paramC ? this.paramA : "default"; - } - - addOne() { - this.paramB += 1; - } -} -``` - -And system - -```ts -export const exampleSystem = (registry: Registry, ctx: Context) => { - const entities = registry.getZipper([ExampleComponent]); - - entities.forEach((entity) => { - if (entity.ExampleComponent.paramA === "end") { - ctx.app.setIsRunning(false); - return; - } - - if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end"; - - if (entity.ExampleComponent.paramB >= 0) - entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1; - }); -}; -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-client -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-client -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/ecs-client/ECSClientLibrary.mdx b/references/1.4.1/ecs-client/ECSClientLibrary.mdx deleted file mode 100644 index d87f98e..0000000 --- a/references/1.4.1/ecs-client/ECSClientLibrary.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ECSClientLibrary class" -icon: "box" -description: "Client-side ECS library backed by the compiled WASM module." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ECSClientLibrary - -## Summary - -Client-side ECS library backed by the compiled WASM module. -## Signature - -```typescript -declare class ECSClientLibrary extends AbstractECSLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Remarks - - Loads `libecs.wasm` from the asset manager and initialises the entity registry. Register with the application: Access the registry in game code: \ No newline at end of file diff --git a/references/1.4.1/ecs-client/ECSClientLibrary/constructor.mdx b/references/1.4.1/ecs-client/ECSClientLibrary/constructor.mdx deleted file mode 100644 index 259968e..0000000 --- a/references/1.4.1/ecs-client/ECSClientLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ECSClientLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ECSClientLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/0-index.mdx b/references/1.4.1/ecs-lib/0-index.mdx deleted file mode 100644 index 54a7543..0000000 --- a/references/1.4.1/ecs-lib/0-index.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "Ecs Lib" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-lib` is a powerful data structure for managing game entities. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-lib -yarn add @nanoforge-dev/ecs-lib -pnpm add @nanoforge-dev/ecs-lib -bun add @nanoforge-dev/ecs-lib -``` - -## Warning - -This library is not usable on its own. You must use either the [ECS Client][ecs-client] or [ECS Server][ecs-server]. - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-lib -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-lib -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md -[ecs-client]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-client -[ecs-server]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-server diff --git a/references/1.4.1/ecs-lib/AbstractECSLibrary.mdx b/references/1.4.1/ecs-lib/AbstractECSLibrary.mdx deleted file mode 100644 index 73fd0d9..0000000 --- a/references/1.4.1/ecs-lib/AbstractECSLibrary.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "AbstractECSLibrary class" -icon: "box" -description: "Abstract base class for WASM-backed ECS (Entity Component System) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# AbstractECSLibrary - -## Summary - -Abstract base class for WASM-backed ECS (Entity Component System) libraries. -## Signature - -```typescript -declare abstract class AbstractECSLibrary extends BaseComponentSystemLibrary -``` - -## Constructors - -### constructor -**Modifiers**: protected - -Constructs a new instance of the class - -## Properties - -### _registry -**Modifiers**: protected -**Type**:`protected _registry?: Registry;` -**Optional**: Yes - - - -### module -**Modifiers**: protected -**Type**:`protected module?: MainModule;` -**Optional**: Yes - - - -### path -**Modifiers**: protected -**Type**:`protected path: string;` - - - -### registry -**Modifiers**: readonly -**Type**:`get registry(): Registry;` - -The WASM-backed entity/component registry. - -## Remarks - - Loads a compiled `libecs.wasm` binary via the asset manager and initialises a `Registry` from the resulting module. Concrete subclasses only need to set `this.path` (the asset path to the `.wasm` file) and call `super()` — see `ECSClientLibrary` and `ECSServerLibrary`. Requires the `ASSET_MANAGER_LIBRARY` dependency and runs after `GRAPHICS_LIBRARY`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/AbstractECSLibrary/_registry.mdx b/references/1.4.1/ecs-lib/AbstractECSLibrary/_registry.mdx deleted file mode 100644 index 342b7fc..0000000 --- a/references/1.4.1/ecs-lib/AbstractECSLibrary/_registry.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "_registry" -icon: "variable" -description: "_registry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _registry \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/AbstractECSLibrary/constructor.mdx b/references/1.4.1/ecs-lib/AbstractECSLibrary/constructor.mdx deleted file mode 100644 index 8b8f644..0000000 --- a/references/1.4.1/ecs-lib/AbstractECSLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the AbstractECSLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `AbstractECSLibrary` class -## Signature - -```typescript -protected constructor(); -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/AbstractECSLibrary/module.mdx b/references/1.4.1/ecs-lib/AbstractECSLibrary/module.mdx deleted file mode 100644 index ec9dbeb..0000000 --- a/references/1.4.1/ecs-lib/AbstractECSLibrary/module.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "module" -icon: "variable" -description: "module API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# module \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/AbstractECSLibrary/path.mdx b/references/1.4.1/ecs-lib/AbstractECSLibrary/path.mdx deleted file mode 100644 index 914b96c..0000000 --- a/references/1.4.1/ecs-lib/AbstractECSLibrary/path.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "path" -icon: "variable" -description: "path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# path \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/AbstractECSLibrary/registry.mdx b/references/1.4.1/ecs-lib/AbstractECSLibrary/registry.mdx deleted file mode 100644 index 9926955..0000000 --- a/references/1.4.1/ecs-lib/AbstractECSLibrary/registry.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "registry" -icon: "variable" -description: "The WASM-backed entity/component registry." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registry - -## Summary - -The WASM-backed entity/component registry. - -## Remarks - - Use this to spawn entities, register components, add systems, and query component data. \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Component.mdx b/references/1.4.1/ecs-lib/Component.mdx deleted file mode 100644 index d75478d..0000000 --- a/references/1.4.1/ecs-lib/Component.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Component type" -icon: "file-code" -description: "Component API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Component -## Signature - -```typescript -type Component = { - name: string; - [key: string]: any; -}; -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/EditorComponentManifest.mdx b/references/1.4.1/ecs-lib/EditorComponentManifest.mdx deleted file mode 100644 index 34e71a1..0000000 --- a/references/1.4.1/ecs-lib/EditorComponentManifest.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "EditorComponentManifest type" -icon: "file-code" -description: "Manifest for a component to be used in the NanoForge Editor" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorComponentManifest - -## Summary - -Manifest for a component to be used in the NanoForge Editor -## Signature - -```typescript -type EditorComponentManifest = { - name: string; - description?: string; - params: ECSElement[]; -}; -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/EditorSystemManifest.mdx b/references/1.4.1/ecs-lib/EditorSystemManifest.mdx deleted file mode 100644 index b8631d9..0000000 --- a/references/1.4.1/ecs-lib/EditorSystemManifest.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "EditorSystemManifest type" -icon: "file-code" -description: "Manifest for a system to be used in the NanoForge Editor" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorSystemManifest - -## Summary - -Manifest for a system to be used in the NanoForge Editor -## Signature - -```typescript -type EditorSystemManifest = { - name: string; - description?: string; - dependencies: string[]; -}; -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Entity.mdx b/references/1.4.1/ecs-lib/Entity.mdx deleted file mode 100644 index b30bd3a..0000000 --- a/references/1.4.1/ecs-lib/Entity.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Entity interface" -icon: "plug" -description: "Entity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Entity -## Signature - -```typescript -interface Entity extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Entity/getId.mdx b/references/1.4.1/ecs-lib/Entity/getId.mdx deleted file mode 100644 index b363787..0000000 --- a/references/1.4.1/ecs-lib/Entity/getId.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getId" -icon: "file" -description: "getId API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getId - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry.mdx b/references/1.4.1/ecs-lib/Registry.mdx deleted file mode 100644 index b505c2e..0000000 --- a/references/1.4.1/ecs-lib/Registry.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Registry interface" -icon: "plug" -description: "Registry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Registry -## Signature - -```typescript -interface Registry extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/addComponent.mdx b/references/1.4.1/ecs-lib/Registry/addComponent.mdx deleted file mode 100644 index 938d691..0000000 --- a/references/1.4.1/ecs-lib/Registry/addComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "addComponent" -icon: "file" -description: "addComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# addComponent - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/addSystem.mdx b/references/1.4.1/ecs-lib/Registry/addSystem.mdx deleted file mode 100644 index 72af2a6..0000000 --- a/references/1.4.1/ecs-lib/Registry/addSystem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "addSystem" -icon: "file" -description: "addSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# addSystem - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/clearEntities.mdx b/references/1.4.1/ecs-lib/Registry/clearEntities.mdx deleted file mode 100644 index 9b5c9d6..0000000 --- a/references/1.4.1/ecs-lib/Registry/clearEntities.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clearEntities" -icon: "file" -description: "clearEntities API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clearEntities - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/clearSystems.mdx b/references/1.4.1/ecs-lib/Registry/clearSystems.mdx deleted file mode 100644 index 8e0053d..0000000 --- a/references/1.4.1/ecs-lib/Registry/clearSystems.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clearSystems" -icon: "file" -description: "clearSystems API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clearSystems - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/entityFromIndex.mdx b/references/1.4.1/ecs-lib/Registry/entityFromIndex.mdx deleted file mode 100644 index 5746a8c..0000000 --- a/references/1.4.1/ecs-lib/Registry/entityFromIndex.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "entityFromIndex" -icon: "file" -description: "entityFromIndex API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# entityFromIndex - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/getComponents.mdx b/references/1.4.1/ecs-lib/Registry/getComponents.mdx deleted file mode 100644 index 7e2eb0c..0000000 --- a/references/1.4.1/ecs-lib/Registry/getComponents.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getComponents" -icon: "file" -description: "getComponents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponents - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/getComponentsConst.mdx b/references/1.4.1/ecs-lib/Registry/getComponentsConst.mdx deleted file mode 100644 index c0c5e75..0000000 --- a/references/1.4.1/ecs-lib/Registry/getComponentsConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getComponentsConst" -icon: "file" -description: "getComponentsConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentsConst - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/getEntityComponent.mdx b/references/1.4.1/ecs-lib/Registry/getEntityComponent.mdx deleted file mode 100644 index 65648c3..0000000 --- a/references/1.4.1/ecs-lib/Registry/getEntityComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getEntityComponent" -icon: "file" -description: "getEntityComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getEntityComponent - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/getEntityComponentConst.mdx b/references/1.4.1/ecs-lib/Registry/getEntityComponentConst.mdx deleted file mode 100644 index de8259d..0000000 --- a/references/1.4.1/ecs-lib/Registry/getEntityComponentConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getEntityComponentConst" -icon: "file" -description: "getEntityComponentConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getEntityComponentConst - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/getIndexedZipper.mdx b/references/1.4.1/ecs-lib/Registry/getIndexedZipper.mdx deleted file mode 100644 index 8232fdb..0000000 --- a/references/1.4.1/ecs-lib/Registry/getIndexedZipper.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getIndexedZipper" -icon: "file" -description: "getIndexedZipper API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getIndexedZipper - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/getZipper.mdx b/references/1.4.1/ecs-lib/Registry/getZipper.mdx deleted file mode 100644 index f7a918c..0000000 --- a/references/1.4.1/ecs-lib/Registry/getZipper.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getZipper" -icon: "file" -description: "getZipper API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getZipper - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/killEntity.mdx b/references/1.4.1/ecs-lib/Registry/killEntity.mdx deleted file mode 100644 index 4979d97..0000000 --- a/references/1.4.1/ecs-lib/Registry/killEntity.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "killEntity" -icon: "file" -description: "killEntity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# killEntity - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/maxEntities.mdx b/references/1.4.1/ecs-lib/Registry/maxEntities.mdx deleted file mode 100644 index f1eb150..0000000 --- a/references/1.4.1/ecs-lib/Registry/maxEntities.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "maxEntities" -icon: "file" -description: "maxEntities API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# maxEntities - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/registerComponent.mdx b/references/1.4.1/ecs-lib/Registry/registerComponent.mdx deleted file mode 100644 index b0540e5..0000000 --- a/references/1.4.1/ecs-lib/Registry/registerComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "registerComponent" -icon: "file" -description: "registerComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registerComponent - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/removeComponent.mdx b/references/1.4.1/ecs-lib/Registry/removeComponent.mdx deleted file mode 100644 index 0efa117..0000000 --- a/references/1.4.1/ecs-lib/Registry/removeComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "removeComponent" -icon: "file" -description: "removeComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# removeComponent - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/removeSystem.mdx b/references/1.4.1/ecs-lib/Registry/removeSystem.mdx deleted file mode 100644 index fea7019..0000000 --- a/references/1.4.1/ecs-lib/Registry/removeSystem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "removeSystem" -icon: "file" -description: "removeSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# removeSystem - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/runSystems.mdx b/references/1.4.1/ecs-lib/Registry/runSystems.mdx deleted file mode 100644 index 4a391a1..0000000 --- a/references/1.4.1/ecs-lib/Registry/runSystems.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "runSystems" -icon: "file" -description: "runSystems API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# runSystems - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/Registry/spawnEntity.mdx b/references/1.4.1/ecs-lib/Registry/spawnEntity.mdx deleted file mode 100644 index 183b6f5..0000000 --- a/references/1.4.1/ecs-lib/Registry/spawnEntity.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "spawnEntity" -icon: "file" -description: "spawnEntity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# spawnEntity - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray.mdx b/references/1.4.1/ecs-lib/SparseArray.mdx deleted file mode 100644 index 48d747f..0000000 --- a/references/1.4.1/ecs-lib/SparseArray.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "SparseArray interface" -icon: "plug" -description: "SparseArray API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SparseArray -## Signature - -```typescript -interface SparseArray extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/clear.mdx b/references/1.4.1/ecs-lib/SparseArray/clear.mdx deleted file mode 100644 index 782f12a..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/clear.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clear" -icon: "file" -description: "clear API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clear - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/empty.mdx b/references/1.4.1/ecs-lib/SparseArray/empty.mdx deleted file mode 100644 index 860f54e..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/empty.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "empty" -icon: "file" -description: "empty API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# empty - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/erase.mdx b/references/1.4.1/ecs-lib/SparseArray/erase.mdx deleted file mode 100644 index 289e964..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/erase.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "erase" -icon: "file" -description: "erase API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# erase - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/get.mdx b/references/1.4.1/ecs-lib/SparseArray/get.mdx deleted file mode 100644 index 18a25bc..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/get.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "get" -icon: "file" -description: "get API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# get - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/getConst.mdx b/references/1.4.1/ecs-lib/SparseArray/getConst.mdx deleted file mode 100644 index 3314654..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/getConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getConst" -icon: "file" -description: "getConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConst - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/getIndex.mdx b/references/1.4.1/ecs-lib/SparseArray/getIndex.mdx deleted file mode 100644 index e6a39d6..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/getIndex.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getIndex" -icon: "file" -description: "getIndex API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getIndex - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/insertAt.mdx b/references/1.4.1/ecs-lib/SparseArray/insertAt.mdx deleted file mode 100644 index 9a5e08b..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/insertAt.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "insertAt" -icon: "file" -description: "insertAt API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# insertAt - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/insertAt_1.mdx b/references/1.4.1/ecs-lib/SparseArray/insertAt_1.mdx deleted file mode 100644 index 9a5e08b..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/insertAt_1.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "insertAt" -icon: "file" -description: "insertAt API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# insertAt - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/resize.mdx b/references/1.4.1/ecs-lib/SparseArray/resize.mdx deleted file mode 100644 index 6e14c19..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/resize.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "resize" -icon: "file" -description: "resize API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# resize - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/set.mdx b/references/1.4.1/ecs-lib/SparseArray/set.mdx deleted file mode 100644 index 008ca6e..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/set.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "set" -icon: "file" -description: "set API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# set - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/setByCopy.mdx b/references/1.4.1/ecs-lib/SparseArray/setByCopy.mdx deleted file mode 100644 index 0da1576..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/setByCopy.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "setByCopy" -icon: "file" -description: "setByCopy API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setByCopy - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/setByMove.mdx b/references/1.4.1/ecs-lib/SparseArray/setByMove.mdx deleted file mode 100644 index d6bb457..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/setByMove.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "setByMove" -icon: "file" -description: "setByMove API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setByMove - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/SparseArray/size.mdx b/references/1.4.1/ecs-lib/SparseArray/size.mdx deleted file mode 100644 index c4186f7..0000000 --- a/references/1.4.1/ecs-lib/SparseArray/size.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "size" -icon: "file" -description: "size API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# size - -## Description \ No newline at end of file diff --git a/references/1.4.1/ecs-lib/System.mdx b/references/1.4.1/ecs-lib/System.mdx deleted file mode 100644 index b171106..0000000 --- a/references/1.4.1/ecs-lib/System.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "System type" -icon: "file-code" -description: "System API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# System -## Signature - -```typescript -type System = (registry: Registry, ctx: Context) => void; -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-server/0-index.mdx b/references/1.4.1/ecs-server/0-index.mdx deleted file mode 100644 index 7c57a23..0000000 --- a/references/1.4.1/ecs-server/0-index.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Ecs Server" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-server` is a wrapper of `@nanoforge-dev/ecs-lib` for server-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-server -yarn add @nanoforge-dev/ecs-server -pnpm add @nanoforge-dev/ecs-server -bun add @nanoforge-dev/ecs-server -``` - -## Example usage - -Initialize the library in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSServerLibrary } from "@nanoforge-dev/ecs-server"; - -export async function main(options: IRunServerOptions) { - const app = NanoforgeFactory.createServer(); - - const ecs = new ECSServerLibrary(); - - app.useComponentSystem(ecs); - - await app.init(options); - - const registry = ecs.registry; - - const entity = registry.spawnEntity(); - registry.addComponent(entity, new ExampleComponent("foo", 42)); - - registry.addSystem(exampleSystem); - - await app.run(); -} -``` - -With component - -```ts -export class ExampleComponent { - name = this.constructor.name; - - constructor( - public paramA: string, - public paramB: number, - public paramC: boolean = false, - ) {} - - get foo() { - return "bar"; - } - - get paramAOrDefault() { - return this.paramC ? this.paramA : "default"; - } - - addOne() { - this.paramB += 1; - } -} -``` - -And system - -```ts -export const exampleSystem = (registry: Registry, ctx: Context) => { - const entities = registry.getZipper([ExampleComponent]); - - entities.forEach((entity) => { - if (entity.ExampleComponent.paramA === "end") { - ctx.app.setIsRunning(false); - return; - } - - if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end"; - - if (entity.ExampleComponent.paramB >= 0) - entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1; - }); -}; -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-server -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-server -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/ecs-server/ECSServerLibrary.mdx b/references/1.4.1/ecs-server/ECSServerLibrary.mdx deleted file mode 100644 index ae983c6..0000000 --- a/references/1.4.1/ecs-server/ECSServerLibrary.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ECSServerLibrary class" -icon: "box" -description: "Server-side ECS library backed by the compiled WASM module." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ECSServerLibrary - -## Summary - -Server-side ECS library backed by the compiled WASM module. -## Signature - -```typescript -declare class ECSServerLibrary extends AbstractECSLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Remarks - - Loads `libecs.wasm` from the asset manager and initialises the entity registry. Register with the application: Access the registry in game code: \ No newline at end of file diff --git a/references/1.4.1/ecs-server/ECSServerLibrary/constructor.mdx b/references/1.4.1/ecs-server/ECSServerLibrary/constructor.mdx deleted file mode 100644 index ce0d21c..0000000 --- a/references/1.4.1/ecs-server/ECSServerLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ECSServerLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ECSServerLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.1/ecs-server/Module.mdx b/references/1.4.1/ecs-server/Module.mdx deleted file mode 100644 index ee8d98d..0000000 --- a/references/1.4.1/ecs-server/Module.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Module variable" -icon: "variable" -description: "Module API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Module -## Signature - -```typescript -Module: typeof MainModuleFactory -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/0-index.mdx b/references/1.4.1/graphics-2d/0-index.mdx deleted file mode 100644 index b0c8cd7..0000000 --- a/references/1.4.1/graphics-2d/0-index.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "Graphics 2d" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/graphics-2d` is a base 2D graphics library. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/graphics-2d -yarn add @nanoforge-dev/graphics-2d -pnpm add @nanoforge-dev/graphics-2d -bun add @nanoforge-dev/graphics-2d -``` - -## Example usage - -Initialize the library in your main file with a red circle. - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSClientLibrary } from "@nanoforge-dev/ecs-client"; -import { Circle, Graphics2DLibrary, Layer } from "@nanoforge-dev/graphics-2d"; - -import { CircleComponent } from "./components/CircleComponent"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const ecs = new ECSClientLibrary(); - const graphics = new Graphics2DLibrary(); - - app.useComponentSystem(ecs); - app.useGraphics(graphics); - - await app.init(options); - - const registry = ecs.registry; - - const layer = new Layer(); - graphics.stage.add(layer); - - const entity = registry.spawnEntity(); - registry.addComponent( - entity, - new CircleComponent( - new Circle({ - radius: 70, - fill: "red", - }), - layer, - ), - ); - - await app.run(); -} -``` - -With circle component defined. - -```ts -import { type Circle, type Layer } from "@nanoforge-dev/graphics-2d"; - -export class CircleComponent { - name = "CircleComponent"; - component: Circle; - - constructor(component: Circle, layer: Layer) { - this.component = component; - layer.add(this.component); - } -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/graphics-2d -[npm]: https://www.npmjs.com/package/@nanoforge-dev/graphics-2d -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/graphics-2d/Animation_2.mdx b/references/1.4.1/graphics-2d/Animation_2.mdx deleted file mode 100644 index ddfaad5..0000000 --- a/references/1.4.1/graphics-2d/Animation_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Animation_2 variable" -icon: "variable" -description: "Animation_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Animation_2 -## Signature - -```typescript -Animation: typeof import("konva/lib/Animation").Animation -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Arc.mdx b/references/1.4.1/graphics-2d/Arc.mdx deleted file mode 100644 index cddf460..0000000 --- a/references/1.4.1/graphics-2d/Arc.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Arc variable" -icon: "variable" -description: "Arc API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Arc -## Signature - -```typescript -Arc: typeof import("konva/lib/shapes/Arc").Arc -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/ArcConfig.mdx b/references/1.4.1/graphics-2d/ArcConfig.mdx deleted file mode 100644 index 54071ac..0000000 --- a/references/1.4.1/graphics-2d/ArcConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ArcConfig type" -icon: "file-code" -description: "ArcConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ArcConfig -## Signature - -```typescript -type ArcConfig = Konva.ArcConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Arrow.mdx b/references/1.4.1/graphics-2d/Arrow.mdx deleted file mode 100644 index 3dfb8ec..0000000 --- a/references/1.4.1/graphics-2d/Arrow.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Arrow variable" -icon: "variable" -description: "Arrow API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Arrow -## Signature - -```typescript -Arrow: typeof import("konva/lib/shapes/Arrow").Arrow -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/ArrowConfig.mdx b/references/1.4.1/graphics-2d/ArrowConfig.mdx deleted file mode 100644 index 140f1f8..0000000 --- a/references/1.4.1/graphics-2d/ArrowConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ArrowConfig type" -icon: "file-code" -description: "ArrowConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ArrowConfig -## Signature - -```typescript -type ArrowConfig = Konva.ArrowConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Canvas.mdx b/references/1.4.1/graphics-2d/Canvas.mdx deleted file mode 100644 index 592d424..0000000 --- a/references/1.4.1/graphics-2d/Canvas.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Canvas variable" -icon: "variable" -description: "Canvas API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Canvas -## Signature - -```typescript -Canvas: typeof import("konva/lib/Canvas").Canvas -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Circle.mdx b/references/1.4.1/graphics-2d/Circle.mdx deleted file mode 100644 index d3294b9..0000000 --- a/references/1.4.1/graphics-2d/Circle.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Circle variable" -icon: "variable" -description: "Circle API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Circle -## Signature - -```typescript -Circle: typeof import("konva/lib/shapes/Circle").Circle -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/CircleConfig.mdx b/references/1.4.1/graphics-2d/CircleConfig.mdx deleted file mode 100644 index 9167a16..0000000 --- a/references/1.4.1/graphics-2d/CircleConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "CircleConfig type" -icon: "file-code" -description: "CircleConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# CircleConfig -## Signature - -```typescript -type CircleConfig = Konva.CircleConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Container.mdx b/references/1.4.1/graphics-2d/Container.mdx deleted file mode 100644 index 2a95a85..0000000 --- a/references/1.4.1/graphics-2d/Container.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Container variable" -icon: "variable" -description: "Container API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Container -## Signature - -```typescript -Container: typeof import("konva/lib/Container").Container -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/ContainerConfig.mdx b/references/1.4.1/graphics-2d/ContainerConfig.mdx deleted file mode 100644 index a11d9c9..0000000 --- a/references/1.4.1/graphics-2d/ContainerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ContainerConfig type" -icon: "file-code" -description: "ContainerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ContainerConfig -## Signature - -```typescript -type ContainerConfig = Konva.ContainerConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Context.mdx b/references/1.4.1/graphics-2d/Context.mdx deleted file mode 100644 index cdb9dcd..0000000 --- a/references/1.4.1/graphics-2d/Context.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Context variable" -icon: "variable" -description: "Context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Context -## Signature - -```typescript -Context: typeof import("konva/lib/Context").Context -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/DD.mdx b/references/1.4.1/graphics-2d/DD.mdx deleted file mode 100644 index 8983841..0000000 --- a/references/1.4.1/graphics-2d/DD.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "DD variable" -icon: "variable" -description: "DD API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# DD -## Signature - -```typescript -DD: { - readonly isDragging: boolean; - justDragged: boolean; - readonly node: import("konva/lib/Node").Node | undefined; - _dragElements: Map; - _drag(evt: any): void; - _endDragBefore(evt?: any): void; - _endDragAfter(evt: any): void; -} -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Easings.mdx b/references/1.4.1/graphics-2d/Easings.mdx deleted file mode 100644 index 5a6a492..0000000 --- a/references/1.4.1/graphics-2d/Easings.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Easings variable" -icon: "variable" -description: "Easings API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Easings -## Signature - -```typescript -Easings: { - BackEaseIn(t: any, b: any, c: any, d: any): any; - BackEaseOut(t: any, b: any, c: any, d: any): any; - BackEaseInOut(t: any, b: any, c: any, d: any): any; - ElasticEaseIn(t: any, b: any, c: any, d: any, a: any, p: any): any; - ElasticEaseOut(t: any, b: any, c: any, d: any, a: any, p: any): any; - ElasticEaseInOut(t: any, b: any, c: any, d: any, a: any, p: any): any; - BounceEaseOut(t: any, b: any, c: any, d: any): any; - BounceEaseIn(t: any, b: any, c: any, d: any): any; - BounceEaseInOut(t: any, b: any, c: any, d: any): any; - EaseIn(t: any, b: any, c: any, d: any): any; - EaseOut(t: any, b: any, c: any, d: any): any; - EaseInOut(t: any, b: any, c: any, d: any): any; - StrongEaseIn(t: any, b: any, c: any, d: any): any; - StrongEaseOut(t: any, b: any, c: any, d: any): any; - StrongEaseInOut(t: any, b: any, c: any, d: any): any; - Linear(t: any, b: any, c: any, d: any): any; -} -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Ellipse.mdx b/references/1.4.1/graphics-2d/Ellipse.mdx deleted file mode 100644 index 96fe50c..0000000 --- a/references/1.4.1/graphics-2d/Ellipse.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Ellipse variable" -icon: "variable" -description: "Ellipse API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Ellipse -## Signature - -```typescript -Ellipse: typeof import("konva/lib/shapes/Ellipse").Ellipse -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/EllipseConfig.mdx b/references/1.4.1/graphics-2d/EllipseConfig.mdx deleted file mode 100644 index 3bf17e4..0000000 --- a/references/1.4.1/graphics-2d/EllipseConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "EllipseConfig type" -icon: "file-code" -description: "EllipseConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EllipseConfig -## Signature - -```typescript -type EllipseConfig = Konva.EllipseConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/FastLayer.mdx b/references/1.4.1/graphics-2d/FastLayer.mdx deleted file mode 100644 index 58f0ee3..0000000 --- a/references/1.4.1/graphics-2d/FastLayer.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "FastLayer variable" -icon: "variable" -description: "FastLayer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# FastLayer -## Signature - -```typescript -FastLayer: typeof import("konva/lib/FastLayer").FastLayer -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Filters.mdx b/references/1.4.1/graphics-2d/Filters.mdx deleted file mode 100644 index 094d800..0000000 --- a/references/1.4.1/graphics-2d/Filters.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "Filters variable" -icon: "variable" -description: "Filters API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Filters -## Signature - -```typescript -Filters: { - Blur: import("konva/lib/Node").Filter; - Brightness: import("konva/lib/Node").Filter; - Brighten: import("konva/lib/Node").Filter; - Contrast: import("konva/lib/Node").Filter; - Emboss: import("konva/lib/Node").Filter; - Enhance: import("konva/lib/Node").Filter; - Grayscale: import("konva/lib/Node").Filter; - HSL: import("konva/lib/Node").Filter; - HSV: import("konva/lib/Node").Filter; - Invert: import("konva/lib/Node").Filter; - Kaleidoscope: import("konva/lib/Node").Filter; - Mask: import("konva/lib/Node").Filter; - Noise: import("konva/lib/Node").Filter; - Pixelate: import("konva/lib/Node").Filter; - Posterize: import("konva/lib/Node").Filter; - RGB: import("konva/lib/Node").Filter; - RGBA: import("konva/lib/Node").Filter; - Sepia: import("konva/lib/Node").Filter; - Solarize: import("konva/lib/Node").Filter; - Threshold: import("konva/lib/Node").Filter; -} -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Graphics2DLibrary.mdx b/references/1.4.1/graphics-2d/Graphics2DLibrary.mdx deleted file mode 100644 index 25ca61d..0000000 --- a/references/1.4.1/graphics-2d/Graphics2DLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Graphics2DLibrary class" -icon: "box" -description: "Built-in 2D graphics library powered by \\Konva\\." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Graphics2DLibrary - -## Summary - -Built-in 2D graphics library powered by [Konva](https://konvajs.org/). -## Signature - -```typescript -declare class Graphics2DLibrary extends BaseGraphicsLibrary -``` - -## Properties - -### baseLayer -**Modifiers**: readonly -**Type**:`get baseLayer(): Layer;` - -The default Konva automatically added to the stage. - -### stage -**Modifiers**: readonly -**Type**:`get stage(): Stage;` - -The Konva that covers the container element. - -## Remarks - - Creates a full-window Konva `Stage` and a default `Layer` during initialisation. Game code interacts with the stage and layer directly to add shapes, images, and animations. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Graphics2DLibrary/baseLayer.mdx b/references/1.4.1/graphics-2d/Graphics2DLibrary/baseLayer.mdx deleted file mode 100644 index ee1d43e..0000000 --- a/references/1.4.1/graphics-2d/Graphics2DLibrary/baseLayer.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "baseLayer" -icon: "variable" -description: "The default Konva Layer automatically added to the stage." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# baseLayer - -## Summary - -The default Konva `Layer` automatically added to the stage. - -## Remarks - - Add shapes and nodes to this layer for them to appear on screen. \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Graphics2DLibrary/stage.mdx b/references/1.4.1/graphics-2d/Graphics2DLibrary/stage.mdx deleted file mode 100644 index 5459bea..0000000 --- a/references/1.4.1/graphics-2d/Graphics2DLibrary/stage.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "stage" -icon: "variable" -description: "The Konva Stage that covers the container element." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# stage - -## Summary - -The Konva `Stage` that covers the container element. - -## Remarks - - Initialised to the container's `offsetWidth` × `offsetHeight` dimensions. \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Group.mdx b/references/1.4.1/graphics-2d/Group.mdx deleted file mode 100644 index 94194fa..0000000 --- a/references/1.4.1/graphics-2d/Group.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Group variable" -icon: "variable" -description: "Group API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Group -## Signature - -```typescript -Group: typeof import("konva/lib/Group").Group -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/GroupConfig.mdx b/references/1.4.1/graphics-2d/GroupConfig.mdx deleted file mode 100644 index e92337a..0000000 --- a/references/1.4.1/graphics-2d/GroupConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "GroupConfig type" -icon: "file-code" -description: "GroupConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# GroupConfig -## Signature - -```typescript -type GroupConfig = Konva.GroupConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/ImageConfig.mdx b/references/1.4.1/graphics-2d/ImageConfig.mdx deleted file mode 100644 index 74c67ae..0000000 --- a/references/1.4.1/graphics-2d/ImageConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ImageConfig type" -icon: "file-code" -description: "ImageConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ImageConfig -## Signature - -```typescript -type ImageConfig = Konva.ImageConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Image_2.mdx b/references/1.4.1/graphics-2d/Image_2.mdx deleted file mode 100644 index bf8a296..0000000 --- a/references/1.4.1/graphics-2d/Image_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Image_2 variable" -icon: "variable" -description: "Image_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Image_2 -## Signature - -```typescript -Image: typeof import("konva/lib/shapes/Image").Image -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/KonvaEventListener.mdx b/references/1.4.1/graphics-2d/KonvaEventListener.mdx deleted file mode 100644 index f83cdd1..0000000 --- a/references/1.4.1/graphics-2d/KonvaEventListener.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaEventListener type" -icon: "file-code" -description: "KonvaEventListener API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaEventListener -## Signature - -```typescript -type KonvaEventListener = Konva.KonvaEventListener; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/KonvaEventObject.mdx b/references/1.4.1/graphics-2d/KonvaEventObject.mdx deleted file mode 100644 index 24c346c..0000000 --- a/references/1.4.1/graphics-2d/KonvaEventObject.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaEventObject type" -icon: "file-code" -description: "KonvaEventObject API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaEventObject -## Signature - -```typescript -type KonvaEventObject = Konva.KonvaEventObject; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/KonvaPointerEvent.mdx b/references/1.4.1/graphics-2d/KonvaPointerEvent.mdx deleted file mode 100644 index d52579e..0000000 --- a/references/1.4.1/graphics-2d/KonvaPointerEvent.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaPointerEvent type" -icon: "file-code" -description: "KonvaPointerEvent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaPointerEvent -## Signature - -```typescript -type KonvaPointerEvent = Konva.KonvaPointerEvent; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Label.mdx b/references/1.4.1/graphics-2d/Label.mdx deleted file mode 100644 index b91d661..0000000 --- a/references/1.4.1/graphics-2d/Label.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Label variable" -icon: "variable" -description: "Label API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Label -## Signature - -```typescript -Label: typeof import("konva/lib/shapes/Label").Label -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/LabelConfig.mdx b/references/1.4.1/graphics-2d/LabelConfig.mdx deleted file mode 100644 index a5d1db5..0000000 --- a/references/1.4.1/graphics-2d/LabelConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LabelConfig type" -icon: "file-code" -description: "LabelConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LabelConfig -## Signature - -```typescript -type LabelConfig = Konva.LabelConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Layer.mdx b/references/1.4.1/graphics-2d/Layer.mdx deleted file mode 100644 index f0cbecc..0000000 --- a/references/1.4.1/graphics-2d/Layer.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Layer variable" -icon: "variable" -description: "Layer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Layer -## Signature - -```typescript -Layer: typeof import("konva/lib/Layer").Layer -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/LayerConfig.mdx b/references/1.4.1/graphics-2d/LayerConfig.mdx deleted file mode 100644 index b6a810a..0000000 --- a/references/1.4.1/graphics-2d/LayerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LayerConfig type" -icon: "file-code" -description: "LayerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LayerConfig -## Signature - -```typescript -type LayerConfig = Konva.LayerConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Line.mdx b/references/1.4.1/graphics-2d/Line.mdx deleted file mode 100644 index 76b62aa..0000000 --- a/references/1.4.1/graphics-2d/Line.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Line variable" -icon: "variable" -description: "Line API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Line -## Signature - -```typescript -Line: typeof import("konva/lib/shapes/Line").Line -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/LineConfig.mdx b/references/1.4.1/graphics-2d/LineConfig.mdx deleted file mode 100644 index a475417..0000000 --- a/references/1.4.1/graphics-2d/LineConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LineConfig type" -icon: "file-code" -description: "LineConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LineConfig -## Signature - -```typescript -type LineConfig = Konva.LineConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/NodeConfig.mdx b/references/1.4.1/graphics-2d/NodeConfig.mdx deleted file mode 100644 index 164684e..0000000 --- a/references/1.4.1/graphics-2d/NodeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "NodeConfig type" -icon: "file-code" -description: "NodeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NodeConfig -## Signature - -```typescript -type NodeConfig = Konva.NodeConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Node_2.mdx b/references/1.4.1/graphics-2d/Node_2.mdx deleted file mode 100644 index cc2dab3..0000000 --- a/references/1.4.1/graphics-2d/Node_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Node_2 variable" -icon: "variable" -description: "Node_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Node_2 -## Signature - -```typescript -Node: typeof import("konva/lib/Node").Node -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Path.mdx b/references/1.4.1/graphics-2d/Path.mdx deleted file mode 100644 index 70ac7a1..0000000 --- a/references/1.4.1/graphics-2d/Path.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Path variable" -icon: "variable" -description: "Path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Path -## Signature - -```typescript -Path: typeof import("konva/lib/shapes/Path").Path -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/PathConfig.mdx b/references/1.4.1/graphics-2d/PathConfig.mdx deleted file mode 100644 index 3f882ea..0000000 --- a/references/1.4.1/graphics-2d/PathConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "PathConfig type" -icon: "file-code" -description: "PathConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# PathConfig -## Signature - -```typescript -type PathConfig = Konva.PathConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Rect.mdx b/references/1.4.1/graphics-2d/Rect.mdx deleted file mode 100644 index e35794b..0000000 --- a/references/1.4.1/graphics-2d/Rect.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Rect variable" -icon: "variable" -description: "Rect API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Rect -## Signature - -```typescript -Rect: typeof import("konva/lib/shapes/Rect").Rect -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/RectConfig.mdx b/references/1.4.1/graphics-2d/RectConfig.mdx deleted file mode 100644 index d4c77fe..0000000 --- a/references/1.4.1/graphics-2d/RectConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RectConfig type" -icon: "file-code" -description: "RectConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RectConfig -## Signature - -```typescript -type RectConfig = Konva.RectConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/RegularPolygon.mdx b/references/1.4.1/graphics-2d/RegularPolygon.mdx deleted file mode 100644 index 9e94364..0000000 --- a/references/1.4.1/graphics-2d/RegularPolygon.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RegularPolygon variable" -icon: "variable" -description: "RegularPolygon API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RegularPolygon -## Signature - -```typescript -RegularPolygon: typeof import("konva/lib/shapes/RegularPolygon").RegularPolygon -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/RegularPolygonConfig.mdx b/references/1.4.1/graphics-2d/RegularPolygonConfig.mdx deleted file mode 100644 index 7eb0178..0000000 --- a/references/1.4.1/graphics-2d/RegularPolygonConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RegularPolygonConfig type" -icon: "file-code" -description: "RegularPolygonConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RegularPolygonConfig -## Signature - -```typescript -type RegularPolygonConfig = Konva.RegularPolygonConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Ring.mdx b/references/1.4.1/graphics-2d/Ring.mdx deleted file mode 100644 index 9b1d5e7..0000000 --- a/references/1.4.1/graphics-2d/Ring.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Ring variable" -icon: "variable" -description: "Ring API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Ring -## Signature - -```typescript -Ring: typeof import("konva/lib/shapes/Ring").Ring -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/RingConfig.mdx b/references/1.4.1/graphics-2d/RingConfig.mdx deleted file mode 100644 index c2d879c..0000000 --- a/references/1.4.1/graphics-2d/RingConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RingConfig type" -icon: "file-code" -description: "RingConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RingConfig -## Signature - -```typescript -type RingConfig = Konva.RingConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Shape.mdx b/references/1.4.1/graphics-2d/Shape.mdx deleted file mode 100644 index 327ffa8..0000000 --- a/references/1.4.1/graphics-2d/Shape.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Shape variable" -icon: "variable" -description: "Shape API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Shape -## Signature - -```typescript -Shape: typeof import("konva/lib/Shape").Shape -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/ShapeConfig.mdx b/references/1.4.1/graphics-2d/ShapeConfig.mdx deleted file mode 100644 index 0dbffd4..0000000 --- a/references/1.4.1/graphics-2d/ShapeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ShapeConfig type" -icon: "file-code" -description: "ShapeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ShapeConfig -## Signature - -```typescript -type ShapeConfig = Konva.ShapeConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Sprite.mdx b/references/1.4.1/graphics-2d/Sprite.mdx deleted file mode 100644 index b18d1db..0000000 --- a/references/1.4.1/graphics-2d/Sprite.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Sprite variable" -icon: "variable" -description: "Sprite API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Sprite -## Signature - -```typescript -Sprite: typeof import("konva/lib/shapes/Sprite").Sprite -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/SpriteConfig.mdx b/references/1.4.1/graphics-2d/SpriteConfig.mdx deleted file mode 100644 index 5897d55..0000000 --- a/references/1.4.1/graphics-2d/SpriteConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "SpriteConfig type" -icon: "file-code" -description: "SpriteConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SpriteConfig -## Signature - -```typescript -type SpriteConfig = Konva.SpriteConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Stage.mdx b/references/1.4.1/graphics-2d/Stage.mdx deleted file mode 100644 index cd1c1df..0000000 --- a/references/1.4.1/graphics-2d/Stage.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Stage variable" -icon: "variable" -description: "Stage API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Stage -## Signature - -```typescript -Stage: typeof import("konva/lib/Stage").Stage -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/StageConfig.mdx b/references/1.4.1/graphics-2d/StageConfig.mdx deleted file mode 100644 index c2105e1..0000000 --- a/references/1.4.1/graphics-2d/StageConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "StageConfig type" -icon: "file-code" -description: "StageConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# StageConfig -## Signature - -```typescript -type StageConfig = Konva.StageConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Star.mdx b/references/1.4.1/graphics-2d/Star.mdx deleted file mode 100644 index 411028f..0000000 --- a/references/1.4.1/graphics-2d/Star.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Star variable" -icon: "variable" -description: "Star API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Star -## Signature - -```typescript -Star: typeof import("konva/lib/shapes/Star").Star -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/StarConfig.mdx b/references/1.4.1/graphics-2d/StarConfig.mdx deleted file mode 100644 index 8d2636b..0000000 --- a/references/1.4.1/graphics-2d/StarConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "StarConfig type" -icon: "file-code" -description: "StarConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# StarConfig -## Signature - -```typescript -type StarConfig = Konva.StarConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Tag.mdx b/references/1.4.1/graphics-2d/Tag.mdx deleted file mode 100644 index 24c03f4..0000000 --- a/references/1.4.1/graphics-2d/Tag.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Tag variable" -icon: "variable" -description: "Tag API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Tag -## Signature - -```typescript -Tag: typeof import("konva/lib/shapes/Label").Tag -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/TagConfig.mdx b/references/1.4.1/graphics-2d/TagConfig.mdx deleted file mode 100644 index 21aba79..0000000 --- a/references/1.4.1/graphics-2d/TagConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TagConfig type" -icon: "file-code" -description: "TagConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TagConfig -## Signature - -```typescript -type TagConfig = Konva.TagConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/TextConfig.mdx b/references/1.4.1/graphics-2d/TextConfig.mdx deleted file mode 100644 index 83d8699..0000000 --- a/references/1.4.1/graphics-2d/TextConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextConfig type" -icon: "file-code" -description: "TextConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextConfig -## Signature - -```typescript -type TextConfig = Konva.TextConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/TextPath.mdx b/references/1.4.1/graphics-2d/TextPath.mdx deleted file mode 100644 index 6864b49..0000000 --- a/references/1.4.1/graphics-2d/TextPath.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextPath variable" -icon: "variable" -description: "TextPath API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextPath -## Signature - -```typescript -TextPath: typeof import("konva/lib/shapes/TextPath").TextPath -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/TextPathConfig.mdx b/references/1.4.1/graphics-2d/TextPathConfig.mdx deleted file mode 100644 index 8fd12d5..0000000 --- a/references/1.4.1/graphics-2d/TextPathConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextPathConfig type" -icon: "file-code" -description: "TextPathConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextPathConfig -## Signature - -```typescript -type TextPathConfig = Konva.TextPathConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Text_2.mdx b/references/1.4.1/graphics-2d/Text_2.mdx deleted file mode 100644 index 6d6f2ce..0000000 --- a/references/1.4.1/graphics-2d/Text_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Text_2 variable" -icon: "variable" -description: "Text_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Text_2 -## Signature - -```typescript -Text: typeof import("konva/lib/shapes/Text").Text -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Transform.mdx b/references/1.4.1/graphics-2d/Transform.mdx deleted file mode 100644 index 3986d65..0000000 --- a/references/1.4.1/graphics-2d/Transform.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Transform variable" -icon: "variable" -description: "Transform API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Transform -## Signature - -```typescript -Transform: typeof import("konva/lib/Util").Transform -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/TransformerConfig.mdx b/references/1.4.1/graphics-2d/TransformerConfig.mdx deleted file mode 100644 index 2b3334a..0000000 --- a/references/1.4.1/graphics-2d/TransformerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TransformerConfig type" -icon: "file-code" -description: "TransformerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TransformerConfig -## Signature - -```typescript -type TransformerConfig = Konva.TransformerConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Transformer_2.mdx b/references/1.4.1/graphics-2d/Transformer_2.mdx deleted file mode 100644 index a676e31..0000000 --- a/references/1.4.1/graphics-2d/Transformer_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Transformer_2 variable" -icon: "variable" -description: "Transformer_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Transformer_2 -## Signature - -```typescript -Transformer: typeof import("konva/lib/shapes/Transformer").Transformer -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Tween.mdx b/references/1.4.1/graphics-2d/Tween.mdx deleted file mode 100644 index 25c1ada..0000000 --- a/references/1.4.1/graphics-2d/Tween.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Tween variable" -icon: "variable" -description: "Tween API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Tween -## Signature - -```typescript -Tween: typeof import("konva/lib/Tween").Tween -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/TweenConfig.mdx b/references/1.4.1/graphics-2d/TweenConfig.mdx deleted file mode 100644 index ed4ae96..0000000 --- a/references/1.4.1/graphics-2d/TweenConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TweenConfig type" -icon: "file-code" -description: "TweenConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TweenConfig -## Signature - -```typescript -type TweenConfig = Konva.TweenConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Util.mdx b/references/1.4.1/graphics-2d/Util.mdx deleted file mode 100644 index 4d6d059..0000000 --- a/references/1.4.1/graphics-2d/Util.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Util variable" -icon: "variable" -description: "Util API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Util -## Signature - -```typescript -Util: { - _isElement(obj: any): obj is Element; - _isFunction(obj: any): boolean; - _isPlainObject(obj: any): boolean; - _isArray(obj: any): obj is Array; - _isNumber(obj: any): obj is number; - _isString(obj: any): obj is string; - _isBoolean(obj: any): obj is boolean; - isObject(val: any): val is object; - isValidSelector(selector: any): boolean; - _sign(number: number): 1 | -1; - requestAnimFrame(callback: Function): void; - createCanvasElement(): HTMLCanvasElement; - createImageElement(): HTMLImageElement; - _isInDocument(el: any): boolean; - _urlToImage(url: string, callback: Function): void; - _rgbToHex(r: number, g: number, b: number): string; - _hexToRgb(hex: string): import("konva/lib/types").RGB; - getRandomColor(): string; - isCanvasFarblingActive(): boolean; - getHitColor(): string; - getHitColorKey(r: number, g: number, b: number): string; - getSnappedHexColor(hex: string): string; - getRGB(color: string): import("konva/lib/types").RGB; - colorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _namedColorToRBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | null; - _rgbColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _rgbaColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex8ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex6ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex4ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex3ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hslColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - haveIntersection(r1: import("konva/lib/types").IRect, r2: import("konva/lib/types").IRect): boolean; - cloneObject(obj: Any): Any; - cloneArray(arr: Array): any[]; - degToRad(deg: number): number; - radToDeg(rad: number): number; - _degToRad(deg: number): number; - _radToDeg(rad: number): number; - _getRotation(radians: number): number; - _capitalize(str: string): string; - throw(str: string): never; - error(str: string): void; - warn(str: string): void; - each(obj: object, func: Function): void; - _inRange(val: number, left: number, right: number): boolean; - _getProjectionToSegment(x1: any, y1: any, x2: any, y2: any, x3: any, y3: any): any[]; - _getProjectionToLine(pt: import("konva/lib/types").Vector2d, line: Array, isClosed: boolean): import("konva/lib/types").Vector2d; - _prepareArrayForTween(startArray: any, endArray: any, isClosed: any): number[]; - _prepareToStringify(obj: any): T | null; - _assign(target: T, source: U): T & U; - _getFirstPointerId(evt: any): any; - releaseCanvas(...canvases: HTMLCanvasElement[]): void; - drawRoundedRectPath(context: import("konva/lib/Context").Context, width: number, height: number, cornerRadius: number | number[]): void; - drawRoundedPolygonPath(context: import("konva/lib/Context").Context, points: import("konva/lib/types").Vector2d[], sides: number, radius: number, cornerRadius: number | number[]): void; -} -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Vector2d.mdx b/references/1.4.1/graphics-2d/Vector2d.mdx deleted file mode 100644 index 4e2e07d..0000000 --- a/references/1.4.1/graphics-2d/Vector2d.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Vector2d type" -icon: "file-code" -description: "Vector2d API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Vector2d -## Signature - -```typescript -type Vector2d = Konva.Vector2d; -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/Wedge.mdx b/references/1.4.1/graphics-2d/Wedge.mdx deleted file mode 100644 index 6083fc3..0000000 --- a/references/1.4.1/graphics-2d/Wedge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Wedge variable" -icon: "variable" -description: "Wedge API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Wedge -## Signature - -```typescript -Wedge: typeof import("konva/lib/shapes/Wedge").Wedge -``` \ No newline at end of file diff --git a/references/1.4.1/graphics-2d/WedgeConfig.mdx b/references/1.4.1/graphics-2d/WedgeConfig.mdx deleted file mode 100644 index 8d8e8b9..0000000 --- a/references/1.4.1/graphics-2d/WedgeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "WedgeConfig type" -icon: "file-code" -description: "WedgeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# WedgeConfig -## Signature - -```typescript -type WedgeConfig = Konva.WedgeConfig; -``` \ No newline at end of file diff --git a/references/1.4.1/input/0-index.mdx b/references/1.4.1/input/0-index.mdx deleted file mode 100644 index 78e9f6d..0000000 --- a/references/1.4.1/input/0-index.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Input" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/input` is an input manager for handling keyboard and mouse events. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/input -yarn add @nanoforge-dev/input -pnpm add @nanoforge-dev/input -bun add @nanoforge-dev/input -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { InputLibrary } from "@nanoforge-dev/input"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const input = new InputLibrary(); - - app.useInput(input); - - await app.init(options); - - await app.run(); -} -``` - -Use to check for key presses - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const input = ctx.libs.getInput(); - - const isArrowUpPressed = input.isKeyPressed(InputEnum.ArrowUp); - - // Do something with the input -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/input -[npm]: https://www.npmjs.com/package/@nanoforge-dev/input -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/input/InputEnum.mdx b/references/1.4.1/input/InputEnum.mdx deleted file mode 100644 index 3f4cba1..0000000 --- a/references/1.4.1/input/InputEnum.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: "InputEnum enum" -icon: "list" -description: "Enumeration of keyboard keys and mouse buttons supported by InputLibrary." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InputEnum - -## Summary - -Enumeration of keyboard keys and mouse buttons supported by `InputLibrary`. - -## Members -| Member | Description | -| ------ | ----------- | -| `AltLeft` | | -| `AltRight` | | -| `ArrowDown` | | -| `ArrowLeft` | | -| `ArrowRight` | | -| `ArrowUp` | | -| `AudioVolumeMute` | | -| `Back` | | -| `Backquote` | | -| `Backslash` | | -| `Backspace` | | -| `BracketLeft` | | -| `BracketRight` | | -| `BrowserBack` | | -| `BrowserFavorites` | | -| `BrowserForward` | | -| `BrowserHome` | | -| `BrowserRefresh` | | -| `BrowserSearch` | | -| `BrowserStop` | | -| `CapsLock` | | -| `Comma` | | -| `ContextMenu` | | -| `ControlLeft` | | -| `ControlRight` | | -| `Convert` | | -| `Delete` | | -| `Digit0` | | -| `Digit1` | | -| `Digit2` | | -| `Digit3` | | -| `Digit4` | | -| `Digit5` | | -| `Digit6` | | -| `Digit7` | | -| `Digit8` | | -| `Digit9` | | -| `End` | | -| `Enter` | | -| `Equal` | | -| `Escape` | | -| `F1` | | -| `F10` | | -| `F11` | | -| `F12` | | -| `F13` | | -| `F14` | | -| `F15` | | -| `F16` | | -| `F17` | | -| `F18` | | -| `F19` | | -| `F2` | | -| `F20` | | -| `F21` | | -| `F22` | | -| `F23` | | -| `F24` | | -| `F3` | | -| `F4` | | -| `F5` | | -| `F6` | | -| `F7` | | -| `F8` | | -| `F9` | | -| `Forward` | | -| `Home` | | -| `Insert` | | -| `IntlBackslash` | | -| `IntlRo` | | -| `IntlYen` | | -| `KanaMode` | | -| `KeyA` | | -| `KeyB` | | -| `KeyC` | | -| `KeyD` | | -| `KeyE` | | -| `KeyF` | | -| `KeyG` | | -| `KeyH` | | -| `KeyI` | | -| `KeyJ` | | -| `KeyK` | | -| `KeyL` | | -| `KeyM` | | -| `KeyN` | | -| `KeyO` | | -| `KeyP` | | -| `KeyQ` | | -| `KeyR` | | -| `KeyS` | | -| `KeyT` | | -| `KeyU` | | -| `KeyV` | | -| `KeyW` | | -| `KeyX` | | -| `KeyY` | | -| `KeyZ` | | -| `Lang1` | | -| `Lang2` | | -| `LaunchApp1` | | -| `LaunchApp2` | | -| `LaunchMail` | | -| `MediaPlayPause` | | -| `MediaStop` | | -| `MediaTrackNext` | | -| `MediaTrackPrevious` | | -| `MetaLeft` | | -| `MetaRight` | | -| `Minus` | | -| `MouseLeft` | | -| `MouseMiddle` | | -| `MouseRight` | | -| `NonConvert` | | -| `NumLock` | | -| `Numpad0` | | -| `Numpad1` | | -| `Numpad2` | | -| `Numpad3` | | -| `Numpad4` | | -| `Numpad5` | | -| `Numpad6` | | -| `Numpad7` | | -| `Numpad8` | | -| `Numpad9` | | -| `NumpadAdd` | | -| `NumpadComma` | | -| `NumpadDecimal` | | -| `NumpadDivide` | | -| `NumpadEnter` | | -| `NumpadEqual` | | -| `NumpadMultiply` | | -| `NumpadSubtract` | | -| `PageDown` | | -| `PageUp` | | -| `Pause` | | -| `Period` | | -| `Power` | | -| `PrintScreen` | | -| `Quote` | | -| `ScrollLock` | | -| `Semicolon` | | -| `ShiftLeft` | | -| `ShiftRight` | | -| `Slash` | | -| `Space` | | -| `Tab` | | - -## Remarks - - Values correspond to the `KeyboardEvent.code` string for keyboard keys and to synthetic button identifiers for mouse buttons. Use with `InputLibrary.isKeyPressed` and `InputLibrary.isDragging`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary.mdx b/references/1.4.1/input/InputLibrary.mdx deleted file mode 100644 index 5f59d81..0000000 --- a/references/1.4.1/input/InputLibrary.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "InputLibrary class" -icon: "box" -description: "Built-in input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InputLibrary - -## Summary - -Built-in input library. -## Signature - -```typescript -declare class InputLibrary extends BaseInputLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getDragState - -Return the current drag state. - -### getMousePosition - -Return the current mouse cursor position. - -### getMouseState - -Return the full mouse state snapshot for the current frame. - -### getPressedKeys - -Return a list of all keys and mouse buttons that are currently pressed. - -### getWheelState - -Return the scroll-wheel state accumulated during the current frame. - -### isDragging - -Return whether a drag operation is in progress. - -### isKeyPressed - -Return whether a key or mouse button is currently held down. - -## Remarks - - Listens to browser `keydown`, `keyup`, `mousedown`, `mouseup`, `mousemove`, and `wheel` events and exposes a per-frame snapshot of the current input state. Must be registered after the graphics library because it uses `runAfter: [GRAPHICS_LIBRARY]`. Register with the application: Access in a system's `__run` hook: \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary/constructor.mdx b/references/1.4.1/input/InputLibrary/constructor.mdx deleted file mode 100644 index 5182682..0000000 --- a/references/1.4.1/input/InputLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the InputLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `InputLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary/getDragState.mdx b/references/1.4.1/input/InputLibrary/getDragState.mdx deleted file mode 100644 index 22815ac..0000000 --- a/references/1.4.1/input/InputLibrary/getDragState.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getDragState" -icon: "function" -description: "Return the current drag state." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getDragState - -## Summary - -Return the current drag state. -## Signature - -```typescript -getDragState(): DragState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`DragState` - -Return the current drag state. \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary/getMousePosition.mdx b/references/1.4.1/input/InputLibrary/getMousePosition.mdx deleted file mode 100644 index 11f70d7..0000000 --- a/references/1.4.1/input/InputLibrary/getMousePosition.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "getMousePosition" -icon: "function" -description: "Return the current mouse cursor position." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMousePosition - -## Summary - -Return the current mouse cursor position. -## Signature - -```typescript -getMousePosition(): { - x: number; - y: number; - }; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**: - -```typescript -{ - x: number; - y: number; - } -``` - - -Return the current mouse cursor position. \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary/getMouseState.mdx b/references/1.4.1/input/InputLibrary/getMouseState.mdx deleted file mode 100644 index 32127b9..0000000 --- a/references/1.4.1/input/InputLibrary/getMouseState.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMouseState" -icon: "function" -description: "Return the full mouse state snapshot for the current frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMouseState - -## Summary - -Return the full mouse state snapshot for the current frame. -## Signature - -```typescript -getMouseState(): MouseState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`MouseState` - -Return the full mouse state snapshot for the current frame. \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary/getPressedKeys.mdx b/references/1.4.1/input/InputLibrary/getPressedKeys.mdx deleted file mode 100644 index 4f3d1d6..0000000 --- a/references/1.4.1/input/InputLibrary/getPressedKeys.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getPressedKeys" -icon: "function" -description: "Return a list of all keys and mouse buttons that are currently pressed." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getPressedKeys - -## Summary - -Return a list of all keys and mouse buttons that are currently pressed. -## Signature - -```typescript -getPressedKeys(): InputEnum[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`InputEnum[]` - -Return a list of all keys and mouse buttons that are currently pressed. \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary/getWheelState.mdx b/references/1.4.1/input/InputLibrary/getWheelState.mdx deleted file mode 100644 index 6d68d7c..0000000 --- a/references/1.4.1/input/InputLibrary/getWheelState.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getWheelState" -icon: "function" -description: "Return the scroll-wheel state accumulated during the current frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getWheelState - -## Summary - -Return the scroll-wheel state accumulated during the current frame. -## Signature - -```typescript -getWheelState(): WheelState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`WheelState` - -Return the scroll-wheel state accumulated during the current frame. - -## Remarks - - All deltas are reset to `0` at the start of the next frame. \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary/isDragging.mdx b/references/1.4.1/input/InputLibrary/isDragging.mdx deleted file mode 100644 index 7315313..0000000 --- a/references/1.4.1/input/InputLibrary/isDragging.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "isDragging" -icon: "function" -description: "Return whether a drag operation is in progress." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isDragging - -## Summary - -Return whether a drag operation is in progress. -## Signature - -```typescript -isDragging(button?: InputEnum): boolean; -``` - -## Parameters - -### button -**Type**:`InputEnum` -**Optional**: Yes - -If provided, only returns true when a drag was started with this specific button. - -## Returns - -**Type**:`boolean` - -Return whether a drag operation is in progress. \ No newline at end of file diff --git a/references/1.4.1/input/InputLibrary/isKeyPressed.mdx b/references/1.4.1/input/InputLibrary/isKeyPressed.mdx deleted file mode 100644 index 85eb226..0000000 --- a/references/1.4.1/input/InputLibrary/isKeyPressed.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "isKeyPressed" -icon: "function" -description: "Return whether a key or mouse button is currently held down." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isKeyPressed - -## Summary - -Return whether a key or mouse button is currently held down. -## Signature - -```typescript -isKeyPressed(key: InputEnum): boolean | undefined; -``` - -## Parameters - -### key -**Type**:`InputEnum` - -The key or button to query (see InputEnum). - -## Returns - -**Type**:`boolean | undefined` - -Return whether a key or mouse button is currently held down. \ No newline at end of file diff --git a/references/1.4.1/music/0-index.mdx b/references/1.4.1/music/0-index.mdx deleted file mode 100644 index c76aa73..0000000 --- a/references/1.4.1/music/0-index.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "Music" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/music` is a music player for your game. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/music -yarn add @nanoforge-dev/music -pnpm add @nanoforge-dev/music -bun add @nanoforge-dev/music -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { MusicLibrary } from "@nanoforge-dev/music"; - -export const MUSIC_SYM = Symbol("music"); - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const assetManager = new AssetManagerLibrary(); - const music = new MusicLibrary(); - - app.useAssetManager(assetManager); - app.use(MUSIC_SYM, music); - - await app.init(options); - - music.load("music", assetManager.getAsset("/path/to/music.mp3").path); - - await app.run(); -} -``` - -Use to play music - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - const music = ctx.libs.get(MUSIC_SYM); - - music.play("music"); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/music -[npm]: https://www.npmjs.com/package/@nanoforge-dev/music -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/music/MusicLibrary.mdx b/references/1.4.1/music/MusicLibrary.mdx deleted file mode 100644 index ee8ccc9..0000000 --- a/references/1.4.1/music/MusicLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "MusicLibrary class" -icon: "box" -description: "Built-in music library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# MusicLibrary - -## Summary - -Built-in music library. -## Signature - -```typescript -declare class MusicLibrary extends BaseMusicLibrary -``` - -## Methods - -### load - -Register a music track under a unique key. - -### mute - -Toggle the muted state of all loaded music tracks. - -### play - -Stop the currently playing track and start the requested one. - -## Remarks - - Manages a collection of named `HTMLAudioElement` instances and ensures only one track plays at a time. Load tracks with `load` and start playback with `play`. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.1/music/MusicLibrary/load.mdx b/references/1.4.1/music/MusicLibrary/load.mdx deleted file mode 100644 index 9d2bba2..0000000 --- a/references/1.4.1/music/MusicLibrary/load.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "load" -icon: "function" -description: "Register a music track under a unique key." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# load - -## Summary - -Register a music track under a unique key. -## Signature - -```typescript -load(music: string, file: string): void; -``` - -## Parameters - -### music -**Type**:`string` - -Unique key used to reference this track (e.g. "theme"). - -### file -**Type**:`string` - -URL or path to the audio file. - -## Returns - -**Type**:`void` - -Register a music track under a unique key. - -## Remarks - - Creates an `HTMLAudioElement` from the provided URL. The track respects the current muted state at load time. \ No newline at end of file diff --git a/references/1.4.1/music/MusicLibrary/mute.mdx b/references/1.4.1/music/MusicLibrary/mute.mdx deleted file mode 100644 index 982880b..0000000 --- a/references/1.4.1/music/MusicLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded music tracks." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded music tracks. -## Signature - -```typescript -mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded music tracks. \ No newline at end of file diff --git a/references/1.4.1/music/MusicLibrary/play.mdx b/references/1.4.1/music/MusicLibrary/play.mdx deleted file mode 100644 index 441f600..0000000 --- a/references/1.4.1/music/MusicLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Stop the currently playing track and start the requested one." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Stop the currently playing track and start the requested one. -## Signature - -```typescript -play(music: string): void; -``` - -## Parameters - -### music -**Type**:`string` - -Key that identifies the track (as passed to load). - -## Returns - -**Type**:`void` - -Stop the currently playing track and start the requested one. \ No newline at end of file diff --git a/references/1.4.1/network-client/0-index.mdx b/references/1.4.1/network-client/0-index.mdx deleted file mode 100644 index 3b234ab..0000000 --- a/references/1.4.1/network-client/0-index.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "Network Client" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/network-client` is a network lib with tcp and udp support for client-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/network-client -yarn add @nanoforge-dev/network-client -pnpm add @nanoforge-dev/network-client -bun add @nanoforge-dev/network-client -``` - -## Example usage - -Initilize the library in your main file. - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkClientLibrary } from "@nanoforge-dev/network-client"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const network = new NetworkClientLibrary(); - - app.useNetwork(network); - - await app.init(options); - - await app.run(); -} -``` - -Use to receive packets - -```ts -export function myReceiveSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - network.tcp.getReceivedPackets().forEach((packet) => { - const data = JSON.parse(new TextDecoder().decode(packet)); - // Do something with the data - }); -} -``` - -Use to send packets - -```ts -export function mySendSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - // Do something to get a data - const packet = new TextEncoder().encode(JSON.stringify(data)); - network.tcp.sendPacket(packet); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-client -[npm]: https://www.npmjs.com/package/@nanoforge-dev/network-client -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/network-client/NetworkClientLibrary.mdx b/references/1.4.1/network-client/NetworkClientLibrary.mdx deleted file mode 100644 index f37e2d1..0000000 --- a/references/1.4.1/network-client/NetworkClientLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "NetworkClientLibrary class" -icon: "box" -description: "Built-in network library for client-side applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NetworkClientLibrary - -## Summary - -Built-in network library for client-side applications. -## Signature - -```typescript -declare class NetworkClientLibrary extends BaseNetworkLibrary -``` - -## Properties - -### tcp -**Type**:`tcp: TCPClient;` - -Reliable, ordered WebSocket-based connection to the server. - -### udp -**Type**:`udp: UDPClient;` - -Unreliable, unordered WebRTC data-channel connection to the server. - -## Remarks - - Reads network configuration from the environment via `ClientConfigNetwork` and automatically connects to the server over TCP (WebSocket), UDP (WebRTC data channel), or both. Register with: Configuration (via environment variables): - `SERVER_ADDRESS` — hostname or IP of the server (required). - `SERVER_TCP_PORT` — WebSocket port for TCP (optional). - `SERVER_UDP_PORT` — signaling port for UDP/WebRTC (optional). - `MAGIC_VALUE` — packet framing delimiter (default: `"PACKET_END"`). - `WSS` — set to `"true"` to use `wss://` / `https://` (default: `false`). After `init`, access the connections via `tcp` and `udp`. \ No newline at end of file diff --git a/references/1.4.1/network-client/NetworkClientLibrary/tcp.mdx b/references/1.4.1/network-client/NetworkClientLibrary/tcp.mdx deleted file mode 100644 index b681439..0000000 --- a/references/1.4.1/network-client/NetworkClientLibrary/tcp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "tcp" -icon: "variable" -description: "Reliable, ordered WebSocket-based connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# tcp - -## Summary - -Reliable, ordered WebSocket-based connection to the server. - -## Remarks - - Only available when `SERVER_TCP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.1/network-client/NetworkClientLibrary/udp.mdx b/references/1.4.1/network-client/NetworkClientLibrary/udp.mdx deleted file mode 100644 index 234baaf..0000000 --- a/references/1.4.1/network-client/NetworkClientLibrary/udp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "udp" -icon: "variable" -description: "Unreliable, unordered WebRTC data-channel connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# udp - -## Summary - -Unreliable, unordered WebRTC data-channel connection to the server. - -## Remarks - - Only available when `SERVER_UDP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.1/network-client/TCPClient.mdx b/references/1.4.1/network-client/TCPClient.mdx deleted file mode 100644 index 15ab23e..0000000 --- a/references/1.4.1/network-client/TCPClient.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "TCPClient class" -icon: "box" -description: "Reliable, ordered WebSocket-based client connection to a NanoForge TCP server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TCPClient - -## Summary - -Reliable, ordered WebSocket-based client connection to a NanoForge TCP server. -## Signature - -```typescript -declare class TCPClient -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### connect - -Initiate a WebSocket connection to the server. - -### getReceivedPackets - -Parse and return all complete packets received since the last call. - -### isConnected - -Return when the underlying WebSocket is open. - -### sendData - -Send a payload to the server. - -## Remarks - - Packets are framed with a configurable magic delimiter so that partial WebSocket frames can be reassembled. The connection is established by calling `connect` and status can be queried with `isConnected`. Typical usage is through `NetworkClientLibrary` which instantiates and connects this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.1/network-client/TCPClient/connect.mdx b/references/1.4.1/network-client/TCPClient/connect.mdx deleted file mode 100644 index 895e5f5..0000000 --- a/references/1.4.1/network-client/TCPClient/connect.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "connect" -icon: "function" -description: "Initiate a WebSocket connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# connect - -## Summary - -Initiate a WebSocket connection to the server. -## Signature - -```typescript -connect(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Initiate a WebSocket connection to the server. - -## Remarks - - Connects to `ws[s]://:`. Resolves as soon as the connection attempt is dispatched (the socket may not be fully open yet — check `isConnected`). \ No newline at end of file diff --git a/references/1.4.1/network-client/TCPClient/constructor.mdx b/references/1.4.1/network-client/TCPClient/constructor.mdx deleted file mode 100644 index f12435d..0000000 --- a/references/1.4.1/network-client/TCPClient/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the TCPClient class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `TCPClient` class -## Signature - -```typescript -constructor(_port: number, _ip: string, magicValue: string, _wss: boolean); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _ip -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _wss -- **Type**:`boolean` \ No newline at end of file diff --git a/references/1.4.1/network-client/TCPClient/getReceivedPackets.mdx b/references/1.4.1/network-client/TCPClient/getReceivedPackets.mdx deleted file mode 100644 index 01155c8..0000000 --- a/references/1.4.1/network-client/TCPClient/getReceivedPackets.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return all complete packets received since the last call." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return all complete packets received since the last call. -## Signature - -```typescript -getReceivedPackets(): Uint8Array[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Uint8Array[]` - -Parse and return all complete packets received since the last call. - -## Remarks - - Partial packets are retained internally and combined with future chunks until they are complete. Call this method once per frame. \ No newline at end of file diff --git a/references/1.4.1/network-client/TCPClient/isConnected.mdx b/references/1.4.1/network-client/TCPClient/isConnected.mdx deleted file mode 100644 index 30d6bd7..0000000 --- a/references/1.4.1/network-client/TCPClient/isConnected.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isConnected" -icon: "function" -description: "Return true when the underlying WebSocket is open." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isConnected - -## Summary - -Return `true` when the underlying WebSocket is open. -## Signature - -```typescript -isConnected(): boolean; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`boolean` - -Return when the underlying WebSocket is open. \ No newline at end of file diff --git a/references/1.4.1/network-client/TCPClient/sendData.mdx b/references/1.4.1/network-client/TCPClient/sendData.mdx deleted file mode 100644 index da18065..0000000 --- a/references/1.4.1/network-client/TCPClient/sendData.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "sendData" -icon: "function" -description: "Send a payload to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendData - -## Summary - -Send a payload to the server. -## Signature - -```typescript -sendData(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to the server. - -## Remarks - - The payload is wrapped in a magic framing packet before being sent. \ No newline at end of file diff --git a/references/1.4.1/network-client/UDPClient.mdx b/references/1.4.1/network-client/UDPClient.mdx deleted file mode 100644 index 51f4853..0000000 --- a/references/1.4.1/network-client/UDPClient.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "UDPClient class" -icon: "box" -description: "Unreliable, unordered WebRTC data-channel client connection to a NanoForge UDP server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# UDPClient - -## Summary - -Unreliable, unordered WebRTC data-channel client connection to a NanoForge UDP server. -## Signature - -```typescript -declare class UDPClient -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### connect - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. - -### getReceivedPackets - -Parse and return all complete packets received since the last call. - -### isConnected - -Return when the RTCDataChannel is open. - -### sendData - -Send a payload on the data channel. - -## Remarks - - Uses a WebSocket signaling channel to perform the SDP/ICE handshake and then communicates over an RTCDataChannel with `ordered: false` and `maxRetransmits: 0` for minimal latency. Typical usage is through `NetworkClientLibrary` which instantiates and connects this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.1/network-client/UDPClient/connect.mdx b/references/1.4.1/network-client/UDPClient/connect.mdx deleted file mode 100644 index eada6f5..0000000 --- a/references/1.4.1/network-client/UDPClient/connect.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "connect" -icon: "function" -description: "Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# connect - -## Summary - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. -## Signature - -```typescript -connect(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. - -## Remarks - - Resolves once the offer has been dispatched. The data channel may become open shortly after — check `isConnected`. \ No newline at end of file diff --git a/references/1.4.1/network-client/UDPClient/constructor.mdx b/references/1.4.1/network-client/UDPClient/constructor.mdx deleted file mode 100644 index 8009fa3..0000000 --- a/references/1.4.1/network-client/UDPClient/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the UDPClient class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `UDPClient` class -## Signature - -```typescript -constructor(_port: number, _ip: string, magicValue: string, _wss: boolean); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _ip -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _wss -- **Type**:`boolean` \ No newline at end of file diff --git a/references/1.4.1/network-client/UDPClient/getReceivedPackets.mdx b/references/1.4.1/network-client/UDPClient/getReceivedPackets.mdx deleted file mode 100644 index 01155c8..0000000 --- a/references/1.4.1/network-client/UDPClient/getReceivedPackets.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return all complete packets received since the last call." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return all complete packets received since the last call. -## Signature - -```typescript -getReceivedPackets(): Uint8Array[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Uint8Array[]` - -Parse and return all complete packets received since the last call. - -## Remarks - - Partial packets are retained internally and combined with future chunks until they are complete. Call this method once per frame. \ No newline at end of file diff --git a/references/1.4.1/network-client/UDPClient/isConnected.mdx b/references/1.4.1/network-client/UDPClient/isConnected.mdx deleted file mode 100644 index 54dbdbb..0000000 --- a/references/1.4.1/network-client/UDPClient/isConnected.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isConnected" -icon: "function" -description: "Return true when the RTCDataChannel is open." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isConnected - -## Summary - -Return `true` when the RTCDataChannel is open. -## Signature - -```typescript -isConnected(): boolean; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`boolean` - -Return when the RTCDataChannel is open. \ No newline at end of file diff --git a/references/1.4.1/network-client/UDPClient/sendData.mdx b/references/1.4.1/network-client/UDPClient/sendData.mdx deleted file mode 100644 index fc35584..0000000 --- a/references/1.4.1/network-client/UDPClient/sendData.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "sendData" -icon: "function" -description: "Send a payload on the data channel." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendData - -## Summary - -Send a payload on the data channel. -## Signature - -```typescript -sendData(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload on the data channel. - -## Remarks - - The payload is wrapped in a magic framing packet before being sent. \ No newline at end of file diff --git a/references/1.4.1/network-server/0-index.mdx b/references/1.4.1/network-server/0-index.mdx deleted file mode 100644 index 613fff1..0000000 --- a/references/1.4.1/network-server/0-index.mdx +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "Network Server" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/network-server` is a network lib with tcp and udp support for server-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/network-server -yarn add @nanoforge-dev/network-server -pnpm add @nanoforge-dev/network-server -bun add @nanoforge-dev/network-server -``` - -## Example usage - -Initilize the library in your main file. - -```ts -import { type IRunServerOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkServerLibrary } from "@nanoforge-dev/network-server"; - -export async function main(options: IRunServerOptions) { - const app = NanoforgeFactory.createServer(); - - const network = new NetworkServerLibrary(); - - app.useNetwork(network); - - await app.init(options); - - await app.run(); -} -``` - -Use to receive packets - -```ts -export function myReceiveSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - network.tcp.getReceivedPackets().forEach((packets, client) => { - packets.forEach((packet) => { - const data = JSON.parse(new TextDecoder().decode(packet)); - // Do something with the data - }); - }); -} -``` - -Use to send packets to everyones - -```ts -export function mySendSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - // Do something to get a data - const packet = new TextEncoder().encode(JSON.stringify(data)); - network.tcp.sendToEverybody(packet); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-server -[npm]: https://www.npmjs.com/package/@nanoforge-dev/network-server -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/network-server/NetworkServerLibrary.mdx b/references/1.4.1/network-server/NetworkServerLibrary.mdx deleted file mode 100644 index 522057c..0000000 --- a/references/1.4.1/network-server/NetworkServerLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "NetworkServerLibrary class" -icon: "box" -description: "Built-in network library for server-side applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NetworkServerLibrary - -## Summary - -Built-in network library for server-side applications. -## Signature - -```typescript -declare class NetworkServerLibrary extends BaseNetworkLibrary -``` - -## Properties - -### tcp -**Type**:`tcp: TCPServer;` - -Reliable, ordered WebSocket-based server for connected clients. - -### udp -**Type**:`udp: UDPServer;` - -Unreliable, unordered WebRTC data-channel server for connected clients. - -## Remarks - - Reads network configuration from the environment via `ServerConfigNetwork` and starts TCP (WebSocket) and/or UDP (WebRTC) servers. Register with: Configuration (via environment variables): - `LISTENING_INTERFACE` — bind address (default: `"0.0.0.0"`). - `LISTENING_TCP_PORT` — WebSocket listen port for TCP (optional). - `LISTENING_UDP_PORT` — signaling listen port for UDP (optional). - `MAGIC_VALUE` — packet framing delimiter (default: `"PACKET_END"`). - `WSS_CERT` / `WSS_KEY` — paths to TLS certificate and key files for WSS (optional). After `init`, access the servers via `tcp` and `udp`. \ No newline at end of file diff --git a/references/1.4.1/network-server/NetworkServerLibrary/tcp.mdx b/references/1.4.1/network-server/NetworkServerLibrary/tcp.mdx deleted file mode 100644 index 7aa300b..0000000 --- a/references/1.4.1/network-server/NetworkServerLibrary/tcp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "tcp" -icon: "variable" -description: "Reliable, ordered WebSocket-based server for connected clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# tcp - -## Summary - -Reliable, ordered WebSocket-based server for connected clients. - -## Remarks - - Only available when `LISTENING_TCP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.1/network-server/NetworkServerLibrary/udp.mdx b/references/1.4.1/network-server/NetworkServerLibrary/udp.mdx deleted file mode 100644 index 686ddc8..0000000 --- a/references/1.4.1/network-server/NetworkServerLibrary/udp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "udp" -icon: "variable" -description: "Unreliable, unordered WebRTC data-channel server for connected clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# udp - -## Summary - -Unreliable, unordered WebRTC data-channel server for connected clients. - -## Remarks - - Only available when `LISTENING_UDP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.1/network-server/TCPServer.mdx b/references/1.4.1/network-server/TCPServer.mdx deleted file mode 100644 index 68f8595..0000000 --- a/references/1.4.1/network-server/TCPServer.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "TCPServer class" -icon: "box" -description: "Reliable, ordered WebSocket-based server that manages multiple TCP clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TCPServer - -## Summary - -Reliable, ordered WebSocket-based server that manages multiple TCP clients. -## Signature - -```typescript -declare class TCPServer -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getConnectedClients - -Return a snapshot array of numeric client IDs currently connected. - -### getReceivedPackets - -Parse and return complete packets received from each client. Each packet is a buffer. - -### listen - -Start the WebSocket server and begin accepting clients. - -### sendToClient - -Send a payload to the client identified by . - -### sendToEverybody - -Send a payload to every connected client. - -## Remarks - - Each client that connects is assigned a numeric ID. Use `getConnectedClients` to enumerate active clients, `sendToClient` / `sendToEverybody` to push data, and `getReceivedPackets` to consume incoming packets per frame. Typical usage is through `NetworkServerLibrary` which instantiates and starts this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.1/network-server/TCPServer/constructor.mdx b/references/1.4.1/network-server/TCPServer/constructor.mdx deleted file mode 100644 index 34a13cb..0000000 --- a/references/1.4.1/network-server/TCPServer/constructor.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the TCPServer class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `TCPServer` class -## Signature - -```typescript -constructor(_port: number, _host: string, magicValue: string, _cert?: string | undefined, _key?: string | undefined); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _host -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _cert -- **Type**:`string | undefined` -- **Optional**: Yes - - - -### _key -- **Type**:`string | undefined` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.4.1/network-server/TCPServer/getConnectedClients.mdx b/references/1.4.1/network-server/TCPServer/getConnectedClients.mdx deleted file mode 100644 index fa695c5..0000000 --- a/references/1.4.1/network-server/TCPServer/getConnectedClients.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getConnectedClients" -icon: "function" -description: "Return a snapshot array of numeric client IDs currently connected." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConnectedClients - -## Summary - -Return a snapshot array of numeric client IDs currently connected. -## Signature - -```typescript -getConnectedClients(): number[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`number[]` - -Return a snapshot array of numeric client IDs currently connected. \ No newline at end of file diff --git a/references/1.4.1/network-server/TCPServer/getReceivedPackets.mdx b/references/1.4.1/network-server/TCPServer/getReceivedPackets.mdx deleted file mode 100644 index 0a64e6a..0000000 --- a/references/1.4.1/network-server/TCPServer/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return complete packets received from each client. Each packet is a Uint8Array buffer." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return complete packets received from each client. Each packet is a `Uint8Array` buffer. -## Signature - -```typescript -getReceivedPackets(): Map; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Map` - -Parse and return complete packets received from each client. Each packet is a buffer. \ No newline at end of file diff --git a/references/1.4.1/network-server/TCPServer/listen.mdx b/references/1.4.1/network-server/TCPServer/listen.mdx deleted file mode 100644 index 0ed1244..0000000 --- a/references/1.4.1/network-server/TCPServer/listen.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "listen" -icon: "function" -description: "Start the WebSocket server and begin accepting clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# listen - -## Summary - -Start the WebSocket server and begin accepting clients. -## Signature - -```typescript -listen(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Start the WebSocket server and begin accepting clients. \ No newline at end of file diff --git a/references/1.4.1/network-server/TCPServer/sendToClient.mdx b/references/1.4.1/network-server/TCPServer/sendToClient.mdx deleted file mode 100644 index 7bef494..0000000 --- a/references/1.4.1/network-server/TCPServer/sendToClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "sendToClient" -icon: "function" -description: "Send a payload to the client identified by clientId." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToClient - -## Summary - -Send a payload to the client identified by `clientId`. -## Signature - -```typescript -sendToClient(clientId: number, data: Uint8Array): void; -``` - -## Parameters - -### clientId -**Type**:`number` - -number — numeric client identifier. - -### data -**Type**:`Uint8Array` - -Uint8Array — payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to the client identified by . \ No newline at end of file diff --git a/references/1.4.1/network-server/TCPServer/sendToEverybody.mdx b/references/1.4.1/network-server/TCPServer/sendToEverybody.mdx deleted file mode 100644 index f2b2d58..0000000 --- a/references/1.4.1/network-server/TCPServer/sendToEverybody.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendToEverybody" -icon: "function" -description: "Send a payload to every connected client." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToEverybody - -## Summary - -Send a payload to every connected client. -## Signature - -```typescript -sendToEverybody(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Uint8Array — raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to every connected client. \ No newline at end of file diff --git a/references/1.4.1/network-server/UDPServer.mdx b/references/1.4.1/network-server/UDPServer.mdx deleted file mode 100644 index 4b7de31..0000000 --- a/references/1.4.1/network-server/UDPServer.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "UDPServer class" -icon: "box" -description: "Unreliable, unordered WebRTC data-channel server that manages multiple UDP clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# UDPServer - -## Summary - -Unreliable, unordered WebRTC data-channel server that manages multiple UDP clients. -## Signature - -```typescript -declare class UDPServer -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getConnectedClients - -Return a snapshot array of client IDs with active data channels. - -### getReceivedPackets - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. - -### listen - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). - -### sendToClient - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. - -### sendToEverybody - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. - -## Remarks - - Uses a WebSocket signaling server to complete SDP/ICE handshakes and then communicates over RTCDataChannels. Each connected client is assigned a numeric ID. Use `getConnectedClients` to enumerate active clients, `sendToClient` / `sendToEverybody` to push data, and `getReceivedPackets` to consume incoming packets per frame. Typical usage is through `NetworkServerLibrary` which instantiates and starts this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.1/network-server/UDPServer/constructor.mdx b/references/1.4.1/network-server/UDPServer/constructor.mdx deleted file mode 100644 index 8cb0274..0000000 --- a/references/1.4.1/network-server/UDPServer/constructor.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the UDPServer class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `UDPServer` class -## Signature - -```typescript -constructor(_port: number, _host: string, magicValue: string, _cert?: string | undefined, _key?: string | undefined); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _host -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _cert -- **Type**:`string | undefined` -- **Optional**: Yes - - - -### _key -- **Type**:`string | undefined` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.4.1/network-server/UDPServer/getConnectedClients.mdx b/references/1.4.1/network-server/UDPServer/getConnectedClients.mdx deleted file mode 100644 index 9d035cb..0000000 --- a/references/1.4.1/network-server/UDPServer/getConnectedClients.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getConnectedClients" -icon: "function" -description: "Return a snapshot array of client IDs with active data channels." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConnectedClients - -## Summary - -Return a snapshot array of client IDs with active data channels. -## Signature - -```typescript -getConnectedClients(): number[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`number[]` - -Return a snapshot array of client IDs with active data channels. \ No newline at end of file diff --git a/references/1.4.1/network-server/UDPServer/getReceivedPackets.mdx b/references/1.4.1/network-server/UDPServer/getReceivedPackets.mdx deleted file mode 100644 index e50aa0d..0000000 --- a/references/1.4.1/network-server/UDPServer/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Reassemble buffered chunks and return a map of clientId => complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. -## Signature - -```typescript -getReceivedPackets(): Map; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Map` - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. \ No newline at end of file diff --git a/references/1.4.1/network-server/UDPServer/listen.mdx b/references/1.4.1/network-server/UDPServer/listen.mdx deleted file mode 100644 index 539353a..0000000 --- a/references/1.4.1/network-server/UDPServer/listen.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "listen" -icon: "function" -description: "Start the signaling WebSocket and accept incoming client offers (SDP/ICE)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# listen - -## Summary - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). -## Signature - -```typescript -listen(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). \ No newline at end of file diff --git a/references/1.4.1/network-server/UDPServer/sendToClient.mdx b/references/1.4.1/network-server/UDPServer/sendToClient.mdx deleted file mode 100644 index 9e34361..0000000 --- a/references/1.4.1/network-server/UDPServer/sendToClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "sendToClient" -icon: "function" -description: "Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToClient - -## Summary - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. -## Signature - -```typescript -sendToClient(clientId: number, data: Uint8Array): void; -``` - -## Parameters - -### clientId -**Type**:`number` - -Numeric client identifier returned by listen() events - -### data -**Type**:`Uint8Array` - -Raw packet bytes (Uint8Array) to send - -## Returns - -**Type**:`void` - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. \ No newline at end of file diff --git a/references/1.4.1/network-server/UDPServer/sendToEverybody.mdx b/references/1.4.1/network-server/UDPServer/sendToEverybody.mdx deleted file mode 100644 index 7a0489c..0000000 --- a/references/1.4.1/network-server/UDPServer/sendToEverybody.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendToEverybody" -icon: "function" -description: "Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToEverybody - -## Summary - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. -## Signature - -```typescript -sendToEverybody(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw packet bytes (Uint8Array) to send to every client - -## Returns - -**Type**:`void` - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. \ No newline at end of file diff --git a/references/1.4.1/sound/0-index.mdx b/references/1.4.1/sound/0-index.mdx deleted file mode 100644 index 3372673..0000000 --- a/references/1.4.1/sound/0-index.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Sound" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/sound` is a sound manager for your game. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/sound -yarn add @nanoforge-dev/sound -pnpm add @nanoforge-dev/sound -bun add @nanoforge-dev/sound -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { SoundLibrary } from "@nanoforge-dev/sound"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const assetManager = new AssetManagerLibrary(); - const sound = new SoundLibrary(); - - app.useAssetManager(assetManager); - app.useSound(sound); - - await app.init(options); - - sound.load("sound", assetManager.getAssetPath("/path/to/sound.mp3").path); - - await app.run(); -} -``` - -Use to play sound - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - const sound = ctx.libs.getSound(); - - sound.play("sound"); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/sound -[npm]: https://www.npmjs.com/package/@nanoforge-dev/sound -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.1/sound/SoundLibrary.mdx b/references/1.4.1/sound/SoundLibrary.mdx deleted file mode 100644 index 7077d2a..0000000 --- a/references/1.4.1/sound/SoundLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "SoundLibrary class" -icon: "box" -description: "Built-in sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SoundLibrary - -## Summary - -Built-in sound-effect library. -## Signature - -```typescript -declare class SoundLibrary extends BaseSoundLibrary -``` - -## Methods - -### load - -Register a sound effect under a unique key. - -### mute - -Toggle the muted state of all loaded sound effects. - -### play - -Play a previously loaded sound effect. - -## Remarks - - Manages a collection of named `HTMLAudioElement` instances. Load sounds with `load` and trigger playback with `play`. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.1/sound/SoundLibrary/load.mdx b/references/1.4.1/sound/SoundLibrary/load.mdx deleted file mode 100644 index 7995630..0000000 --- a/references/1.4.1/sound/SoundLibrary/load.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "load" -icon: "function" -description: "Register a sound effect under a unique key." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# load - -## Summary - -Register a sound effect under a unique key. -## Signature - -```typescript -load(sound: string, file: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Unique key used to reference this sound (e.g. "explosion"). - -### file -**Type**:`string` - -URL or path to the audio file. - -## Returns - -**Type**:`void` - -Register a sound effect under a unique key. - -## Remarks - - Creates an `HTMLAudioElement` from the provided URL. The sound respects the current muted state at load time. \ No newline at end of file diff --git a/references/1.4.1/sound/SoundLibrary/mute.mdx b/references/1.4.1/sound/SoundLibrary/mute.mdx deleted file mode 100644 index aa6aae2..0000000 --- a/references/1.4.1/sound/SoundLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded sound effects." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded sound effects. -## Signature - -```typescript -mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded sound effects. \ No newline at end of file diff --git a/references/1.4.1/sound/SoundLibrary/play.mdx b/references/1.4.1/sound/SoundLibrary/play.mdx deleted file mode 100644 index f072fab..0000000 --- a/references/1.4.1/sound/SoundLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Play a previously loaded sound effect." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Play a previously loaded sound effect. -## Signature - -```typescript -play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the sound (as passed to load). - -## Returns - -**Type**:`void` - -Play a previously loaded sound effect. \ No newline at end of file diff --git a/references/1.4.2/.tsdocs/client/ValidRefs.js b/references/1.4.2/.tsdocs/client/ValidRefs.js deleted file mode 100644 index e1205f1..0000000 --- a/references/1.4.2/.tsdocs/client/ValidRefs.js +++ /dev/null @@ -1,29 +0,0 @@ -// @ts-nocheck -/** - * Valid API Reference IDs - * Auto-generated by mint-tsdocs during documentation build. - * Used by RefLink component for runtime validation. - * - * @generated - */ - -// Expose VALID_REFS on window for use by RefLink component -// This avoids ES6 module import issues with .jsx MIME types -if (typeof window !== 'undefined') { - window.VALID_REFS = new Set([ - "core-editor", - "core-editor.CoreEvents", - "core-editor.EditorEvents", - "core-editor.EventEmitter", - "core-editor.EventEmitter.constructor", - "core-editor.EventEmitter.emit", - "core-editor.EventEmitter.on", - "core-editor.EventEmitter.runEvents", - "core-editor.NanoforgeClient", - "core-editor.NanoforgeClient.useGraphics", - "core-editor.NanoforgeClient.useInput", - "core-editor.NanoforgeClient.useSound", - "core-editor.NanoforgeFactory", - "core-editor.NanoforgeServer" -]); -} diff --git a/references/1.4.2/.tsdocs/client/tsdocs-config.js b/references/1.4.2/.tsdocs/client/tsdocs-config.js deleted file mode 100644 index 178d17b..0000000 --- a/references/1.4.2/.tsdocs/client/tsdocs-config.js +++ /dev/null @@ -1,28 +0,0 @@ -/** - * TSDocs Runtime Configuration - * Auto-generated by mint-tsdocs during documentation build. - * Loaded globally as a custom script for all documentation pages. - * - * This provides runtime configuration to TSDocs components (RefLink, PageLink, etc.) - * without requiring imports between snippet files. - * - * @generated - */ -(function() { - 'use strict'; - - // Global TSDocs configuration accessible to all components - window.TSDOCS_CONFIG = { - basePath: "/core-editor", - packageName: "core-editor", - generatedAt: "2026-07-06T20:12:08.666Z" - }; - - // Helper function to generate absolute path for an API reference - window.getRefPath = function(refId) { - var segments = refId.split('.').filter(function(s) { return s.length > 0; }); - return segments.length > 0 - ? window.TSDOCS_CONFIG.basePath + '/' + segments.join('/') - : window.TSDOCS_CONFIG.basePath; - }; -})(); diff --git a/references/1.4.2/.tsdocs/client/tsdocs-styles.css b/references/1.4.2/.tsdocs/client/tsdocs-styles.css deleted file mode 100644 index 0541fd9..0000000 --- a/references/1.4.2/.tsdocs/client/tsdocs-styles.css +++ /dev/null @@ -1,65 +0,0 @@ -/** - * TSDocs Default Styles - * Auto-generated by mint-tsdocs during documentation generation - * - * To override any style, add more specific selectors in docs/style.css: - * - * Example: - * .prose .tsdocs-reflink.broken-link { - * border-bottom: 3px solid orange !important; - * } - */ - -/* ============================================================================ - * Broken Link Indicators - * ============================================================================ - * Used by RefLink and PageLink components to highlight invalid references - */ - -/* RefLink broken links */ -.prose .tsdocs-reflink.broken-link { - border-bottom: 2px dotted #ef4444 !important; - color: #ef4444 !important; - text-decoration: wavy underline !important; -} - -/* PageLink broken links */ -.prose .tsdocs-pagelink.broken-link { - border-bottom: 2px dotted #ef4444 !important; - color: #ef4444 !important; - text-decoration: wavy underline !important; -} - -/* Dark mode variants */ -.dark .prose .tsdocs-reflink.broken-link { - border-bottom-color: #f87171 !important; - color: #f87171 !important; -} - -.dark .prose .tsdocs-pagelink.broken-link { - border-bottom-color: #f87171 !important; - color: #f87171 !important; -} - -/* ============================================================================ - * TypeTree Component Styles - * ============================================================================ - * Currently uses Mintlify's native ResponseField and Expandable components - * Use this selector for custom TypeTree styling: - * [data-component="tsdocs-typetree"] { } - */ - -/* ============================================================================ - * Preview Component Styles - * ============================================================================ - * Wrapper for code examples and previews - * Use this selector for custom Preview styling: - * [data-component="tsdocs-preview"] { } - */ - -/* ============================================================================ - * Feature Component Styles - * ============================================================================ - * The Feature component now uses Tailwind CSS classes directly. - * No custom styles needed - matches Mintlify Card component styling. - */ diff --git a/references/1.4.2/.tsdocs/global.d.ts b/references/1.4.2/.tsdocs/global.d.ts deleted file mode 100644 index 7284151..0000000 --- a/references/1.4.2/.tsdocs/global.d.ts +++ /dev/null @@ -1,145 +0,0 @@ -/** - * Global type declarations for mint-tsdocs - * Auto-generated during documentation build. - * - * This file provides: - * - Mintlify component type declarations (ResponseField, Expandable) - * - Window object augmentations for runtime scripts - * - Type-safe ValidRefId and ValidPageId unions - * - * @generated - */ - -// ============================================================================ -// Mintlify Component Declarations -// ============================================================================ - -/** - * Global type declarations for Mintlify components. - * These components are provided by Mintlify at runtime. - */ -declare namespace JSX { - interface IntrinsicElements { - ResponseField: any; - Expandable: any; - } -} - -// Also declare as global React components -declare const ResponseField: React.FC; -declare const Expandable: React.FC; - -// ============================================================================ -// ValidRefs Types -// ============================================================================ - -/** - * Union type of all valid API reference IDs - * - * Generated from the API model structure during documentation build. - * Used by RefLink component for type-safe reference validation. - */ -export type ValidRefId = - | "core-editor" - | "core-editor.CoreEvents" - | "core-editor.EditorEvents" - | "core-editor.EventEmitter" - | "core-editor.EventEmitter.constructor" - | "core-editor.EventEmitter.emit" - | "core-editor.EventEmitter.on" - | "core-editor.EventEmitter.runEvents" - | "core-editor.NanoforgeClient" - | "core-editor.NanoforgeClient.useGraphics" - | "core-editor.NanoforgeClient.useInput" - | "core-editor.NanoforgeClient.useSound" - | "core-editor.NanoforgeFactory" - | "core-editor.NanoforgeServer"; - -/** - * Check if a RefId is valid - * - * @param refId - The reference ID to check - * @returns True if the refId is valid - */ -export function isValidRef(refId: string): refId is ValidRefId; - -// ============================================================================ -// ValidPages Types -// ============================================================================ - -/** - * Union type of all valid page IDs from docs.json - * - * Generated from docs.json navigation structure during documentation build. - * Used by PageLink component for type-safe page validation. - */ -export type ValidPageId = - never; - -/** - * Check if a PageId is valid - * - * @param pageId - The page ID to check - * @returns True if the pageId is valid - */ -export function isValidPage(pageId: string): pageId is ValidPageId; - -// ============================================================================ -// TsdocsConfig Types -// ============================================================================ - -/** - * Runtime configuration for TSDocs components - * - * Available via window.TSDOCS_CONFIG after tsdocs-config.js loads. - */ -export interface TsdocsConfig { - /** Base path for API reference pages (e.g., "/reference") */ - basePath: string; - - /** Package name */ - packageName: string; - - /** Generated timestamp (ISO 8601) */ - generatedAt: string; -} - -// ============================================================================ -// Window Object Augmentation -// ============================================================================ - -declare global { - interface Window { - /** - * Set of all valid RefIds in the documentation - * Populated by ValidRefs.js at runtime - */ - VALID_REFS?: Set; - - /** - * Set of all valid PageIds in the documentation - * Populated by ValidPages.js at runtime - */ - VALID_PAGES?: Set; - - /** - * Runtime configuration object - * Populated by tsdocs-config.js at runtime - */ - TSDOCS_CONFIG?: TsdocsConfig; - - /** - * Get absolute path for an API reference - * - * @param refId - The RefId (e.g., "mint-tsdocs.MarkdownDocumenter") - * @returns Absolute path (e.g., "/reference/mint-tsdocs/MarkdownDocumenter") - * - * @example - * getRefPath("mint-tsdocs.MarkdownDocumenter") - * // Returns: "/reference/mint-tsdocs/MarkdownDocumenter" - */ - getRefPath?: (refId: string) => string; - } -} - -export {}; diff --git a/references/1.4.2/asset-manager/0-index.mdx b/references/1.4.2/asset-manager/0-index.mdx deleted file mode 100644 index 0733d87..0000000 --- a/references/1.4.2/asset-manager/0-index.mdx +++ /dev/null @@ -1,89 +0,0 @@ ---- -title: "Asset Manager" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/asset-manager` is a manager for loading assets to uniform work with between client and server. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/asset-manager -yarn add @nanoforge-dev/asset-manager -pnpm add @nanoforge-dev/asset-manager -bun add @nanoforge-dev/asset-manager -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; - -export async function main(options: IRunOptions) { - const app = NanoforgeFactory.createClient(); // Or NanoforgeFactory.createServer() - - const assetManager = new AssetManagerLibrary(); - - app.useAssetManager(assetManager); - - await app.init(options); - - await app.run(); -} -``` - -Use to load assets - -```ts -export async function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - - const file = assetManager.getAsset("/path/to/file.txt"); - const text = await file.text(); - - // Do something with file or text -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/asset-manager -[npm]: https://www.npmjs.com/package/@nanoforge-dev/asset-manager -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/asset-manager/AssetManagerLibrary.mdx b/references/1.4.2/asset-manager/AssetManagerLibrary.mdx deleted file mode 100644 index 966b860..0000000 --- a/references/1.4.2/asset-manager/AssetManagerLibrary.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "AssetManagerLibrary class" -icon: "box" -description: "Built-in asset-manager library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# AssetManagerLibrary - -## Summary - -Built-in asset-manager library. -## Signature - -```typescript -declare class AssetManagerLibrary extends BaseAssetManagerLibrary -``` - -## Methods - -### getAsset - -Retrieve a registered file asset by its virtual path. - -### getAsset - - - -## Remarks - - Stores the file map injected by the NanoForge loader (`nf start`) and exposes assets via `getAsset`. Register it with the application before calling `init`: File paths are normalised on lookup: leading slashes are collapsed to a single `/`, duplicate slashes are removed, and trailing slashes are stripped. \ No newline at end of file diff --git a/references/1.4.2/asset-manager/AssetManagerLibrary/getAsset.mdx b/references/1.4.2/asset-manager/AssetManagerLibrary/getAsset.mdx deleted file mode 100644 index 192a448..0000000 --- a/references/1.4.2/asset-manager/AssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "Retrieve a registered file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a registered file asset by its virtual path. -## Signature - -```typescript -getAsset(path: string): NfFile; -``` - -## Parameters - -### path -**Type**:`string` - -Virtual path of the asset (e.g. "/textures/hero.png"). - -## Returns - -**Type**:`NfFile` - -Retrieve a registered file asset by its virtual path. - -## Remarks - - The path is normalised before lookup: leading and duplicate slashes are collapsed and trailing slashes are removed. \ No newline at end of file diff --git a/references/1.4.2/asset-manager/AssetManagerLibrary/getAsset_1.mdx b/references/1.4.2/asset-manager/AssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index b06123b..0000000 --- a/references/1.4.2/asset-manager/AssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset -## Signature - -```typescript -getAsset(path: "" | undefined): undefined; -``` - -## Parameters - -### path -**Type**:`"" | undefined` - - - -## Returns - -**Type**:`undefined` \ No newline at end of file diff --git a/references/1.4.2/common/0-index.mdx b/references/1.4.2/common/0-index.mdx deleted file mode 100644 index 0de4539..0000000 --- a/references/1.4.2/common/0-index.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: "Common" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/common` is library with common interfaces and utilities used by Nanoforge Engine. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/common -yarn add @nanoforge-dev/common -pnpm add @nanoforge-dev/common -bun add @nanoforge-dev/common -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/common -[npm]: https://www.npmjs.com/package/@nanoforge-dev/common -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/common/ASSET_MANAGER_LIBRARY.mdx b/references/1.4.2/common/ASSET_MANAGER_LIBRARY.mdx deleted file mode 100644 index 55eed46..0000000 --- a/references/1.4.2/common/ASSET_MANAGER_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ASSET_MANAGER_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the asset-manager library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ASSET_MANAGER_LIBRARY - -## Summary - -Registration symbol for the asset-manager library slot. -## Signature - -```typescript -ASSET_MANAGER_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.useAssetManager` or use it as a dependency in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.2/common/ApplicationContext.mdx b/references/1.4.2/common/ApplicationContext.mdx deleted file mode 100644 index 5c94d56..0000000 --- a/references/1.4.2/common/ApplicationContext.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "ApplicationContext class" -icon: "box" -description: "Holds runtime state that is shared across all libraries during the game loop." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ApplicationContext - -## Summary - -Holds runtime state that is shared across all libraries during the game loop. -## Signature - -```typescript -declare abstract class ApplicationContext -``` - -## Properties - -### delta -**Modifiers**: readonly -**Type**:`get delta(): number;` - -Elapsed time in milliseconds since the last frame. - -### isRunning -**Modifiers**: readonly -**Type**:`get isRunning(): boolean;` - -Whether the engine game loop is currently executing. - -## Remarks - - An instance of this class is available to every library via `BaseContext.application`. Libraries may read `isRunning` and `delta` to make frame-rate-independent decisions. \ No newline at end of file diff --git a/references/1.4.2/common/ApplicationContext/delta.mdx b/references/1.4.2/common/ApplicationContext/delta.mdx deleted file mode 100644 index 3e3d8cc..0000000 --- a/references/1.4.2/common/ApplicationContext/delta.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "delta" -icon: "variable" -description: "Elapsed time in milliseconds since the last frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# delta - -## Summary - -Elapsed time in milliseconds since the last frame. \ No newline at end of file diff --git a/references/1.4.2/common/ApplicationContext/isRunning.mdx b/references/1.4.2/common/ApplicationContext/isRunning.mdx deleted file mode 100644 index 631b6fd..0000000 --- a/references/1.4.2/common/ApplicationContext/isRunning.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "isRunning" -icon: "variable" -description: "Whether the engine game loop is currently executing." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isRunning - -## Summary - -Whether the engine game loop is currently executing. \ No newline at end of file diff --git a/references/1.4.2/common/BaseAssetManagerLibrary.mdx b/references/1.4.2/common/BaseAssetManagerLibrary.mdx deleted file mode 100644 index 3294405..0000000 --- a/references/1.4.2/common/BaseAssetManagerLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseAssetManagerLibrary class" -icon: "box" -description: "Abstract base class for asset-manager libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseAssetManagerLibrary - -## Summary - -Abstract base class for asset-manager libraries. -## Signature - -```typescript -declare abstract class BaseAssetManagerLibrary extends Library implements IAssetManagerLibrary -``` - -## Methods - -### getAsset -**Modifiers**: abstract - -Retrieve a file asset by its virtual path. - -### getAsset -**Modifiers**: abstract - - - -## Remarks - - Extend this class to implement a custom asset-manager and register it with `NanoforgeApplication.useAssetManager`. The built-in implementation is `AssetManagerLibrary`. \ No newline at end of file diff --git a/references/1.4.2/common/BaseAssetManagerLibrary/getAsset.mdx b/references/1.4.2/common/BaseAssetManagerLibrary/getAsset.mdx deleted file mode 100644 index f492d02..0000000 --- a/references/1.4.2/common/BaseAssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "Retrieve a file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a file asset by its virtual path. -## Signature - -```typescript -abstract getAsset(path: string): NfFile; -``` - -## Parameters - -### path -**Type**:`string` - -Virtual path as registered in the engine's file map (e.g. "/textures/hero.png"). - -## Returns - -**Type**:`NfFile` - -Retrieve a file asset by its virtual path. \ No newline at end of file diff --git a/references/1.4.2/common/BaseAssetManagerLibrary/getAsset_1.mdx b/references/1.4.2/common/BaseAssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index baa7fe8..0000000 --- a/references/1.4.2/common/BaseAssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "getAsset" -icon: "function" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset -## Signature - -```typescript -abstract getAsset(path: "" | undefined): undefined; -``` - -## Parameters - -### path -**Type**:`"" | undefined` - - - -## Returns - -**Type**:`undefined` \ No newline at end of file diff --git a/references/1.4.2/common/BaseComponentSystemLibrary.mdx b/references/1.4.2/common/BaseComponentSystemLibrary.mdx deleted file mode 100644 index 0104678..0000000 --- a/references/1.4.2/common/BaseComponentSystemLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseComponentSystemLibrary class" -icon: "box" -description: "Abstract base class for component-system (ECS) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseComponentSystemLibrary - -## Summary - -Abstract base class for component-system (ECS) libraries. -## Signature - -```typescript -declare abstract class BaseComponentSystemLibrary extends Library implements IComponentSystemLibrary -``` - -## Remarks - - Extend this class (or the higher-level `AbstractECSLibrary`) to implement a custom ECS back-end and register it with `NanoforgeApplication.useComponentSystem`. The built-in implementations are `ECSClientLibrary` and `ECSServerLibrary`. \ No newline at end of file diff --git a/references/1.4.2/common/BaseGraphicsLibrary.mdx b/references/1.4.2/common/BaseGraphicsLibrary.mdx deleted file mode 100644 index 91ff228..0000000 --- a/references/1.4.2/common/BaseGraphicsLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseGraphicsLibrary class" -icon: "box" -description: "Abstract base class for graphics libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseGraphicsLibrary - -## Summary - -Abstract base class for graphics libraries. -## Signature - -```typescript -declare abstract class BaseGraphicsLibrary extends Library implements IGraphicsLibrary -``` - -## Remarks - - Extend this class to implement a custom rendering backend and register it with `NanoforgeClient.useGraphics`. The built-in implementation is `Graphics2DLibrary`. \ No newline at end of file diff --git a/references/1.4.2/common/BaseInputLibrary.mdx b/references/1.4.2/common/BaseInputLibrary.mdx deleted file mode 100644 index 9d79933..0000000 --- a/references/1.4.2/common/BaseInputLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseInputLibrary class" -icon: "box" -description: "Abstract base class for input libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseInputLibrary - -## Summary - -Abstract base class for input libraries. -## Signature - -```typescript -declare abstract class BaseInputLibrary extends Library implements IInputLibrary -``` - -## Remarks - - Extend this class to implement a custom input back-end and register it with `NanoforgeClient.useInput`. The built-in implementation is `InputLibrary`. \ No newline at end of file diff --git a/references/1.4.2/common/BaseMusicLibrary.mdx b/references/1.4.2/common/BaseMusicLibrary.mdx deleted file mode 100644 index 355c2ed..0000000 --- a/references/1.4.2/common/BaseMusicLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseMusicLibrary class" -icon: "box" -description: "Abstract base class for music libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseMusicLibrary - -## Summary - -Abstract base class for music libraries. -## Signature - -```typescript -declare abstract class BaseMusicLibrary extends Library implements IMusicLibrary -``` - -## Methods - -### mute -**Modifiers**: abstract - -Toggle the muted state of all loaded music tracks. - -### play -**Modifiers**: abstract - -Stop the currently playing track (if any) and start playing the requested one. - -## Remarks - - Extend this class to implement a custom music library and register it with `NanoforgeApplication.use` using the `MUSIC_LIBRARY` symbol. The built-in implementation is `MusicLibrary`. \ No newline at end of file diff --git a/references/1.4.2/common/BaseMusicLibrary/mute.mdx b/references/1.4.2/common/BaseMusicLibrary/mute.mdx deleted file mode 100644 index 870e300..0000000 --- a/references/1.4.2/common/BaseMusicLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded music tracks." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded music tracks. -## Signature - -```typescript -abstract mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded music tracks. \ No newline at end of file diff --git a/references/1.4.2/common/BaseMusicLibrary/play.mdx b/references/1.4.2/common/BaseMusicLibrary/play.mdx deleted file mode 100644 index c01e955..0000000 --- a/references/1.4.2/common/BaseMusicLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Stop the currently playing track (if any) and start playing the requested one." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Stop the currently playing track (if any) and start playing the requested one. -## Signature - -```typescript -abstract play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the music track (as passed to load). - -## Returns - -**Type**:`void` - -Stop the currently playing track (if any) and start playing the requested one. \ No newline at end of file diff --git a/references/1.4.2/common/BaseNetworkLibrary.mdx b/references/1.4.2/common/BaseNetworkLibrary.mdx deleted file mode 100644 index b1ac7fa..0000000 --- a/references/1.4.2/common/BaseNetworkLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "BaseNetworkLibrary class" -icon: "box" -description: "Abstract base class for network libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseNetworkLibrary - -## Summary - -Abstract base class for network libraries. -## Signature - -```typescript -declare abstract class BaseNetworkLibrary extends Library implements INetworkLibrary -``` - -## Remarks - - Extend this class to implement a custom network library and register it with `NanoforgeApplication.useNetwork`. The built-in implementations are `NetworkClientLibrary` and `NetworkServerLibrary`. \ No newline at end of file diff --git a/references/1.4.2/common/BaseSoundLibrary.mdx b/references/1.4.2/common/BaseSoundLibrary.mdx deleted file mode 100644 index 7655039..0000000 --- a/references/1.4.2/common/BaseSoundLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "BaseSoundLibrary class" -icon: "box" -description: "Abstract base class for sound libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# BaseSoundLibrary - -## Summary - -Abstract base class for sound libraries. -## Signature - -```typescript -declare abstract class BaseSoundLibrary extends Library implements ISoundLibrary -``` - -## Methods - -### mute -**Modifiers**: abstract - -Toggle the muted state of all loaded sound effects. - -### play -**Modifiers**: abstract - -Play a previously loaded sound effect. - -## Remarks - - Extend this class to implement a custom sound library and register it with `NanoforgeClient.useSound`. The built-in implementation is `SoundLibrary`. \ No newline at end of file diff --git a/references/1.4.2/common/BaseSoundLibrary/mute.mdx b/references/1.4.2/common/BaseSoundLibrary/mute.mdx deleted file mode 100644 index 9fcd48e..0000000 --- a/references/1.4.2/common/BaseSoundLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded sound effects." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded sound effects. -## Signature - -```typescript -abstract mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded sound effects. \ No newline at end of file diff --git a/references/1.4.2/common/BaseSoundLibrary/play.mdx b/references/1.4.2/common/BaseSoundLibrary/play.mdx deleted file mode 100644 index c7040b6..0000000 --- a/references/1.4.2/common/BaseSoundLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Play a previously loaded sound effect." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Play a previously loaded sound effect. -## Signature - -```typescript -abstract play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the sound (as passed to load). - -## Returns - -**Type**:`void` - -Play a previously loaded sound effect. \ No newline at end of file diff --git a/references/1.4.2/common/COMPONENT_SYSTEM_LIBRARY.mdx b/references/1.4.2/common/COMPONENT_SYSTEM_LIBRARY.mdx deleted file mode 100644 index 484ad21..0000000 --- a/references/1.4.2/common/COMPONENT_SYSTEM_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "COMPONENT_SYSTEM_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the component-system (ECS) library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# COMPONENT_SYSTEM_LIBRARY - -## Summary - -Registration symbol for the component-system (ECS) library slot. -## Signature - -```typescript -COMPONENT_SYSTEM_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.use` when registering a custom component-system library, or use the shorthand `NanoforgeApplication.useComponentSystem`. \ No newline at end of file diff --git a/references/1.4.2/common/ClearContext.mdx b/references/1.4.2/common/ClearContext.mdx deleted file mode 100644 index b3a6704..0000000 --- a/references/1.4.2/common/ClearContext.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ClearContext class" -icon: "box" -description: "Context passed to a library's clear lifecycle hook during application shutdown." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ClearContext - -## Summary - -Context passed to a library's `__clear` lifecycle hook during application shutdown. -## Signature - -```typescript -declare class ClearContext extends BaseContext -``` - -## Remarks - - Use the inherited `application` and `libraries` accessors to access shared state and other libraries while tearing down resources. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager.mdx b/references/1.4.2/common/ClientLibraryManager.mdx deleted file mode 100644 index 75f7404..0000000 --- a/references/1.4.2/common/ClientLibraryManager.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: "ClientLibraryManager class" -icon: "box" -description: "Convenience wrapper around LibraryManager that unwraps LibraryHandle values and returns the library instance directly." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ClientLibraryManager - -## Summary - -Convenience wrapper around `LibraryManager` that unwraps `LibraryHandle` values and returns the library instance directly. -## Signature - -```typescript -declare class ClientLibraryManager -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### get - -Retrieve a library registered under a custom symbol. - -### getAssetManager - -Retrieve the registered asset-manager library instance. - -### getComponentSystem - -Retrieve the registered component-system (ECS) library instance. - -### getGraphics - -Retrieve the registered graphics library instance. - -### getInput - -Retrieve the registered input library instance. - -### getMusic - -Retrieve the registered music library instance. - -### getNetwork - -Retrieve the registered network library instance. - -### getSound - -Retrieve the registered sound library instance. - -## Remarks - - Typically accessed inside a library's lifecycle hooks through the execution context's `libraries` property after being constructed with a concrete `LibraryManager`. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/constructor.mdx b/references/1.4.2/common/ClientLibraryManager/constructor.mdx deleted file mode 100644 index e84b462..0000000 --- a/references/1.4.2/common/ClientLibraryManager/constructor.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ClientLibraryManager class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ClientLibraryManager` class -## Signature - -```typescript -constructor(libraryManager: LibraryManager); -``` - -## Parameters - -### libraryManager -- **Type**:`LibraryManager` - -The underlying manager to delegate lookups to. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/get.mdx b/references/1.4.2/common/ClientLibraryManager/get.mdx deleted file mode 100644 index 9b5edaf..0000000 --- a/references/1.4.2/common/ClientLibraryManager/get.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "get" -icon: "function" -description: "Retrieve a library registered under a custom symbol." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# get - -## Summary - -Retrieve a library registered under a custom symbol. -## Signature - -```typescript -get(sym: symbol): T; -``` - -## Parameters - -### sym -**Type**:`symbol` - -The symbol the library was registered with. - -## Returns - -**Type**:`T` - -Retrieve a library registered under a custom symbol. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/getAssetManager.mdx b/references/1.4.2/common/ClientLibraryManager/getAssetManager.mdx deleted file mode 100644 index 3f9dc8a..0000000 --- a/references/1.4.2/common/ClientLibraryManager/getAssetManager.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getAssetManager" -icon: "function" -description: "Retrieve the registered asset-manager library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAssetManager - -## Summary - -Retrieve the registered asset-manager library instance. -## Signature - -```typescript -getAssetManager(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered asset-manager library instance. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/getComponentSystem.mdx b/references/1.4.2/common/ClientLibraryManager/getComponentSystem.mdx deleted file mode 100644 index 0618c44..0000000 --- a/references/1.4.2/common/ClientLibraryManager/getComponentSystem.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getComponentSystem" -icon: "function" -description: "Retrieve the registered component-system (ECS) library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentSystem - -## Summary - -Retrieve the registered component-system (ECS) library instance. -## Signature - -```typescript -getComponentSystem(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered component-system (ECS) library instance. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/getGraphics.mdx b/references/1.4.2/common/ClientLibraryManager/getGraphics.mdx deleted file mode 100644 index 279e0e7..0000000 --- a/references/1.4.2/common/ClientLibraryManager/getGraphics.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getGraphics" -icon: "function" -description: "Retrieve the registered graphics library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getGraphics - -## Summary - -Retrieve the registered graphics library instance. -## Signature - -```typescript -getGraphics(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered graphics library instance. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/getInput.mdx b/references/1.4.2/common/ClientLibraryManager/getInput.mdx deleted file mode 100644 index ecb04fa..0000000 --- a/references/1.4.2/common/ClientLibraryManager/getInput.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getInput" -icon: "function" -description: "Retrieve the registered input library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getInput - -## Summary - -Retrieve the registered input library instance. -## Signature - -```typescript -getInput(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered input library instance. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/getMusic.mdx b/references/1.4.2/common/ClientLibraryManager/getMusic.mdx deleted file mode 100644 index ec91ce8..0000000 --- a/references/1.4.2/common/ClientLibraryManager/getMusic.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMusic" -icon: "function" -description: "Retrieve the registered music library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMusic - -## Summary - -Retrieve the registered music library instance. -## Signature - -```typescript -getMusic(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered music library instance. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/getNetwork.mdx b/references/1.4.2/common/ClientLibraryManager/getNetwork.mdx deleted file mode 100644 index 91f2bfd..0000000 --- a/references/1.4.2/common/ClientLibraryManager/getNetwork.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getNetwork" -icon: "function" -description: "Retrieve the registered network library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getNetwork - -## Summary - -Retrieve the registered network library instance. -## Signature - -```typescript -getNetwork(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered network library instance. \ No newline at end of file diff --git a/references/1.4.2/common/ClientLibraryManager/getSound.mdx b/references/1.4.2/common/ClientLibraryManager/getSound.mdx deleted file mode 100644 index fcfd477..0000000 --- a/references/1.4.2/common/ClientLibraryManager/getSound.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getSound" -icon: "function" -description: "Retrieve the registered sound library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getSound - -## Summary - -Retrieve the registered sound library instance. -## Signature - -```typescript -getSound(): T; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`T` - -Retrieve the registered sound library instance. \ No newline at end of file diff --git a/references/1.4.2/common/Context.mdx b/references/1.4.2/common/Context.mdx deleted file mode 100644 index 92d8ed5..0000000 --- a/references/1.4.2/common/Context.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Context class" -icon: "box" -description: "Context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Context -## Signature - -```typescript -declare class Context -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### app -**Modifiers**: readonly -**Type**:`get app(): ApplicationContext;` - - - -### libs -**Modifiers**: readonly -**Type**:`get libs(): ClientLibraryManager;` \ No newline at end of file diff --git a/references/1.4.2/common/Context/app.mdx b/references/1.4.2/common/Context/app.mdx deleted file mode 100644 index 0912bb7..0000000 --- a/references/1.4.2/common/Context/app.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "app" -icon: "variable" -description: "app API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# app \ No newline at end of file diff --git a/references/1.4.2/common/Context/constructor.mdx b/references/1.4.2/common/Context/constructor.mdx deleted file mode 100644 index 5688f33..0000000 --- a/references/1.4.2/common/Context/constructor.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the Context class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `Context` class -## Signature - -```typescript -constructor(applicationContext: ApplicationContext, libraryManager: ClientLibraryManager); -``` - -## Parameters - -### applicationContext -- **Type**:`ApplicationContext` - - - -### libraryManager -- **Type**:`ClientLibraryManager` \ No newline at end of file diff --git a/references/1.4.2/common/Context/libs.mdx b/references/1.4.2/common/Context/libs.mdx deleted file mode 100644 index eb4c68b..0000000 --- a/references/1.4.2/common/Context/libs.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "libs" -icon: "variable" -description: "libs API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# libs \ No newline at end of file diff --git a/references/1.4.2/common/DefaultLibrariesEnum.mdx b/references/1.4.2/common/DefaultLibrariesEnum.mdx deleted file mode 100644 index b82062a..0000000 --- a/references/1.4.2/common/DefaultLibrariesEnum.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "DefaultLibrariesEnum enum" -icon: "list" -description: "Numeric index keys for the built-in library slots." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# DefaultLibrariesEnum - -## Summary - -Numeric index keys for the built-in library slots. - -## Members -| Member | Description | -| ------ | ----------- | -| `ASSET_MANAGER` | | -| `COMPONENT_SYSTEM` | | -| `GRAPHICS` | | -| `INPUT` | | -| `MUSIC` | | -| `NETWORK` | | -| `SOUND` | | - -## Remarks - - Used internally by `LibraryManager` to keep O(1) access to the well-known library positions. Game code should not reference these values directly — use the typed accessor methods on `LibraryManager` instead. \ No newline at end of file diff --git a/references/1.4.2/common/ExecutionContext.mdx b/references/1.4.2/common/ExecutionContext.mdx deleted file mode 100644 index b6ef64b..0000000 --- a/references/1.4.2/common/ExecutionContext.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ExecutionContext class" -icon: "box" -description: "Context passed to a library's run hook on every game-loop tick." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ExecutionContext - -## Summary - -Context passed to a library's `__run` hook on every game-loop tick. -## Signature - -```typescript -declare class ExecutionContext extends BaseContext -``` - -## Remarks - - Use the inherited `application` and `libraries` accessors to read the current delta time and interact with other libraries during the frame update. \ No newline at end of file diff --git a/references/1.4.2/common/GRAPHICS_LIBRARY.mdx b/references/1.4.2/common/GRAPHICS_LIBRARY.mdx deleted file mode 100644 index 149ddc0..0000000 --- a/references/1.4.2/common/GRAPHICS_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "GRAPHICS_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the graphics library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# GRAPHICS_LIBRARY - -## Summary - -Registration symbol for the graphics library slot. -## Signature - -```typescript -GRAPHICS_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useGraphics` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.2/common/IAssetManagerLibrary.mdx b/references/1.4.2/common/IAssetManagerLibrary.mdx deleted file mode 100644 index 81e2913..0000000 --- a/references/1.4.2/common/IAssetManagerLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IAssetManagerLibrary interface" -icon: "plug" -description: "Interface for asset-manager libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IAssetManagerLibrary - -## Summary - -Interface for asset-manager libraries. -## Signature - -```typescript -interface IAssetManagerLibrary extends IExposedLibrary -``` - -## Remarks - - Implemented by `BaseAssetManagerLibrary` and its concrete subclass `AssetManagerLibrary`. Access an instance via `ctx.libraries.getAssetManager().library`. \ No newline at end of file diff --git a/references/1.4.2/common/IAssetManagerLibrary/getAsset.mdx b/references/1.4.2/common/IAssetManagerLibrary/getAsset.mdx deleted file mode 100644 index 89ba6b7..0000000 --- a/references/1.4.2/common/IAssetManagerLibrary/getAsset.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "getAsset" -icon: "file" -description: "Retrieve a registered file asset by its virtual path." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Summary - -Retrieve a registered file asset by its virtual path. - -## Description - -Retrieve a registered file asset by its virtual path. \ No newline at end of file diff --git a/references/1.4.2/common/IAssetManagerLibrary/getAsset_1.mdx b/references/1.4.2/common/IAssetManagerLibrary/getAsset_1.mdx deleted file mode 100644 index 9698eef..0000000 --- a/references/1.4.2/common/IAssetManagerLibrary/getAsset_1.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getAsset" -icon: "file" -description: "getAsset API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAsset - -## Description \ No newline at end of file diff --git a/references/1.4.2/common/IComponentSystemLibrary.mdx b/references/1.4.2/common/IComponentSystemLibrary.mdx deleted file mode 100644 index 4e173f3..0000000 --- a/references/1.4.2/common/IComponentSystemLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IComponentSystemLibrary interface" -icon: "plug" -description: "Interface for component-system (ECS) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IComponentSystemLibrary - -## Summary - -Interface for component-system (ECS) libraries. -## Signature - -```typescript -interface IComponentSystemLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseComponentSystemLibrary` and the higher-level `AbstractECSLibrary`, with concrete subclasses `ECSClientLibrary` and `ECSServerLibrary`. Access an instance via `ctx.libraries.getComponentSystem().library`. \ No newline at end of file diff --git a/references/1.4.2/common/IConfigRegistry.mdx b/references/1.4.2/common/IConfigRegistry.mdx deleted file mode 100644 index 7ef36a4..0000000 --- a/references/1.4.2/common/IConfigRegistry.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "IConfigRegistry interface" -icon: "plug" -description: "Resolves and validates typed configuration objects from the runtime environment." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IConfigRegistry - -## Summary - -Resolves and validates typed configuration objects from the runtime environment. -## Signature - -```typescript -interface IConfigRegistry -``` - -## Remarks - - An instance is available in `InitContext.config`. Configuration classes must be decorated with `class-transformer` (`@Expose`, `@Default`) and `class-validator` (`@IsPort`, `@IsIpOrURL`, etc.) decorators from `@nanoforge-dev/config`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/common/IConfigRegistry/registerConfig.mdx b/references/1.4.2/common/IConfigRegistry/registerConfig.mdx deleted file mode 100644 index d093467..0000000 --- a/references/1.4.2/common/IConfigRegistry/registerConfig.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "registerConfig" -icon: "file" -description: "Instantiate, populate from the runtime environment, transform, and validate a configuration class." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registerConfig - -## Summary - -Instantiate, populate from the runtime environment, transform, and validate a configuration class. - -## Description - -Instantiate, populate from the runtime environment, transform, and validate a configuration class. \ No newline at end of file diff --git a/references/1.4.2/common/IExposedLibrary.mdx b/references/1.4.2/common/IExposedLibrary.mdx deleted file mode 100644 index 488520d..0000000 --- a/references/1.4.2/common/IExposedLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IExposedLibrary interface" -icon: "plug" -description: "Marker interface for libraries that are directly accessible to game code via the ClientLibraryManager." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IExposedLibrary - -## Summary - -Marker interface for libraries that are directly accessible to game code via the `ClientLibraryManager`. -## Signature - -```typescript -interface IExposedLibrary extends ILibrary -``` - -## Remarks - - All built-in typed library interfaces (e.g. `IAssetManagerLibrary`, `ISoundLibrary`) extend this interface. \ No newline at end of file diff --git a/references/1.4.2/common/IGraphicsLibrary.mdx b/references/1.4.2/common/IGraphicsLibrary.mdx deleted file mode 100644 index 22daee8..0000000 --- a/references/1.4.2/common/IGraphicsLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IGraphicsLibrary interface" -icon: "plug" -description: "Interface for graphics libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IGraphicsLibrary - -## Summary - -Interface for graphics libraries. -## Signature - -```typescript -interface IGraphicsLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseGraphicsLibrary` and its concrete subclass `Graphics2DLibrary`. Access an instance via `ctx.libraries.getGraphics().library`. \ No newline at end of file diff --git a/references/1.4.2/common/IInputLibrary.mdx b/references/1.4.2/common/IInputLibrary.mdx deleted file mode 100644 index bff971f..0000000 --- a/references/1.4.2/common/IInputLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IInputLibrary interface" -icon: "plug" -description: "Interface for input libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IInputLibrary - -## Summary - -Interface for input libraries. -## Signature - -```typescript -interface IInputLibrary extends IExposedLibrary, IRunnerLibrary -``` - -## Remarks - - Implemented by `BaseInputLibrary` and its concrete subclass `InputLibrary`. Access an instance via `ctx.libraries.getInput().library`. \ No newline at end of file diff --git a/references/1.4.2/common/ILibrary.mdx b/references/1.4.2/common/ILibrary.mdx deleted file mode 100644 index cc0a1ea..0000000 --- a/references/1.4.2/common/ILibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ILibrary interface" -icon: "plug" -description: "Core interface that every NanoForge library must satisfy." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ILibrary - -## Summary - -Core interface that every NanoForge library must satisfy. -## Signature - -```typescript -interface ILibrary -``` - -## Remarks - - Implement this interface (or extend an abstract base such as `BaseAssetManagerLibrary`) to create a custom library and register it with the engine via `NanoforgeApplication.use`. \ No newline at end of file diff --git a/references/1.4.2/common/IMusicLibrary.mdx b/references/1.4.2/common/IMusicLibrary.mdx deleted file mode 100644 index 64ef5cb..0000000 --- a/references/1.4.2/common/IMusicLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IMusicLibrary interface" -icon: "plug" -description: "Interface for music libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IMusicLibrary - -## Summary - -Interface for music libraries. -## Signature - -```typescript -interface IMusicLibrary extends IExposedLibrary, IMutableLibrary -``` - -## Remarks - - Implemented by `BaseMusicLibrary` and its concrete subclass `MusicLibrary`. Access an instance via `ctx.libraries.getMusic().library`. \ No newline at end of file diff --git a/references/1.4.2/common/IMutableLibrary.mdx b/references/1.4.2/common/IMutableLibrary.mdx deleted file mode 100644 index 9300072..0000000 --- a/references/1.4.2/common/IMutableLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IMutableLibrary interface" -icon: "plug" -description: "Interface for libraries that support muting/unmuting audio playback." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IMutableLibrary - -## Summary - -Interface for libraries that support muting/unmuting audio playback. -## Signature - -```typescript -interface IMutableLibrary extends ILibrary -``` - -## Remarks - - Implemented by `ISoundLibrary` and `IMusicLibrary`. \ No newline at end of file diff --git a/references/1.4.2/common/IMutableLibrary/mute.mdx b/references/1.4.2/common/IMutableLibrary/mute.mdx deleted file mode 100644 index 74a6415..0000000 --- a/references/1.4.2/common/IMutableLibrary/mute.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "mute" -icon: "file" -description: "Toggle the muted state. Mutes when currently unmuted, and vice versa." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state. Mutes when currently unmuted, and vice versa. - -## Description - -Toggle the muted state. Mutes when currently unmuted, and vice versa. \ No newline at end of file diff --git a/references/1.4.2/common/INPUT_LIBRARY.mdx b/references/1.4.2/common/INPUT_LIBRARY.mdx deleted file mode 100644 index 52d6c76..0000000 --- a/references/1.4.2/common/INPUT_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "INPUT_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the input library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# INPUT_LIBRARY - -## Summary - -Registration symbol for the input library slot. -## Signature - -```typescript -INPUT_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useInput` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.2/common/INetworkLibrary.mdx b/references/1.4.2/common/INetworkLibrary.mdx deleted file mode 100644 index 9f1d44a..0000000 --- a/references/1.4.2/common/INetworkLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "INetworkLibrary interface" -icon: "plug" -description: "Interface for network libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# INetworkLibrary - -## Summary - -Interface for network libraries. -## Signature - -```typescript -interface INetworkLibrary extends IExposedLibrary -``` - -## Remarks - - Implemented by `BaseNetworkLibrary` and its concrete subclasses `NetworkClientLibrary` and `NetworkServerLibrary`. Access an instance via `ctx.libraries.getNetwork().library`. \ No newline at end of file diff --git a/references/1.4.2/common/IRunClientOptions.mdx b/references/1.4.2/common/IRunClientOptions.mdx deleted file mode 100644 index d9362af..0000000 --- a/references/1.4.2/common/IRunClientOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunClientOptions interface" -icon: "plug" -description: "Run options for a client-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunClientOptions - -## Summary - -Run options for a client-side NanoForge application. -## Signature - -```typescript -interface IRunClientOptions -``` - -## Remarks - - Pass an instance to `NanoforgeApplication.init` when running in the browser. The engine bundler (`nf build`) automatically generates and injects `files` and `env` at build time. \ No newline at end of file diff --git a/references/1.4.2/common/IRunClientOptions/container.mdx b/references/1.4.2/common/IRunClientOptions/container.mdx deleted file mode 100644 index 80e02b6..0000000 --- a/references/1.4.2/common/IRunClientOptions/container.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "container" -icon: "file" -description: "DOM element that will host the game canvas." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# container - -## Summary - -DOM element that will host the game canvas. - -## Description - -DOM element that will host the game canvas. - -## Remarks - - The element's current `offsetWidth` and `offsetHeight` are used to set the initial canvas dimensions. \ No newline at end of file diff --git a/references/1.4.2/common/IRunClientOptions/env.mdx b/references/1.4.2/common/IRunClientOptions/env.mdx deleted file mode 100644 index d416585..0000000 --- a/references/1.4.2/common/IRunClientOptions/env.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "env" -icon: "file" -description: "Runtime environment variables available to all libraries via InitContext.env." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Runtime environment variables available to all libraries via `InitContext.env`. - -## Description - -Runtime environment variables available to all libraries via . \ No newline at end of file diff --git a/references/1.4.2/common/IRunClientOptions/files.mdx b/references/1.4.2/common/IRunClientOptions/files.mdx deleted file mode 100644 index 2697027..0000000 --- a/references/1.4.2/common/IRunClientOptions/files.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "files" -icon: "file" -description: "Map of virtual file paths to their resolved URL strings." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their resolved URL strings. - -## Description - -Map of virtual file paths to their resolved URL strings. - -## Remarks - - Populated automatically by the NanoForge bundler. Keys are normalised paths such as `"/textures/hero.png"`. \ No newline at end of file diff --git a/references/1.4.2/common/IRunOptions.mdx b/references/1.4.2/common/IRunOptions.mdx deleted file mode 100644 index 725c3e0..0000000 --- a/references/1.4.2/common/IRunOptions.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "IRunOptions type" -icon: "file-code" -description: "Union of client and server run options accepted by NanoforgeApplication.init." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunOptions - -## Summary - -Union of client and server run options accepted by `NanoforgeApplication.init`. -## Signature - -```typescript -type IRunOptions = IRunClientOptions | IRunServerOptions; -``` \ No newline at end of file diff --git a/references/1.4.2/common/IRunServerOptions.mdx b/references/1.4.2/common/IRunServerOptions.mdx deleted file mode 100644 index 2c28702..0000000 --- a/references/1.4.2/common/IRunServerOptions.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunServerOptions interface" -icon: "plug" -description: "Run options for a server-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunServerOptions - -## Summary - -Run options for a server-side NanoForge application. -## Signature - -```typescript -interface IRunServerOptions -``` - -## Remarks - - Pass an instance to `NanoforgeApplication.init` when running in a Node.js server process. \ No newline at end of file diff --git a/references/1.4.2/common/IRunServerOptions/env.mdx b/references/1.4.2/common/IRunServerOptions/env.mdx deleted file mode 100644 index d416585..0000000 --- a/references/1.4.2/common/IRunServerOptions/env.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "env" -icon: "file" -description: "Runtime environment variables available to all libraries via InitContext.env." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Runtime environment variables available to all libraries via `InitContext.env`. - -## Description - -Runtime environment variables available to all libraries via . \ No newline at end of file diff --git a/references/1.4.2/common/IRunServerOptions/files.mdx b/references/1.4.2/common/IRunServerOptions/files.mdx deleted file mode 100644 index 35be311..0000000 --- a/references/1.4.2/common/IRunServerOptions/files.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "files" -icon: "file" -description: "Map of virtual file paths to their resolved URL strings." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their resolved URL strings. - -## Description - -Map of virtual file paths to their resolved URL strings. - -## Remarks - - Populated automatically by the NanoForge bundler. Keys are normalised paths such as `"/data/config.json"`. \ No newline at end of file diff --git a/references/1.4.2/common/IRunnerLibrary.mdx b/references/1.4.2/common/IRunnerLibrary.mdx deleted file mode 100644 index ca7ec08..0000000 --- a/references/1.4.2/common/IRunnerLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "IRunnerLibrary interface" -icon: "plug" -description: "Interface for libraries that participate in the per-frame game loop." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IRunnerLibrary - -## Summary - -Interface for libraries that participate in the per-frame game loop. -## Signature - -```typescript -interface IRunnerLibrary extends ILibrary -``` - -## Remarks - - The engine calls `__run` on every tick for all registered runner libraries in the order determined by their `ILibraryOptions.runBefore` / `ILibraryOptions.runAfter` relationships. \ No newline at end of file diff --git a/references/1.4.2/common/ISoundLibrary.mdx b/references/1.4.2/common/ISoundLibrary.mdx deleted file mode 100644 index f653be2..0000000 --- a/references/1.4.2/common/ISoundLibrary.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "ISoundLibrary interface" -icon: "plug" -description: "Interface for sound-effect libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ISoundLibrary - -## Summary - -Interface for sound-effect libraries. -## Signature - -```typescript -interface ISoundLibrary extends IExposedLibrary, IMutableLibrary -``` - -## Remarks - - Implemented by `BaseSoundLibrary` and its concrete subclass `SoundLibrary`. Access an instance via `ctx.libraries.getSound().library`. \ No newline at end of file diff --git a/references/1.4.2/common/InitContext.mdx b/references/1.4.2/common/InitContext.mdx deleted file mode 100644 index 2cb673a..0000000 --- a/references/1.4.2/common/InitContext.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: "InitContext class" -icon: "box" -description: "Context object passed to every library's init lifecycle hook." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InitContext - -## Summary - -Context object passed to every library's `__init` lifecycle hook. -## Signature - -```typescript -declare class InitContext extends BaseContext -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### config -**Modifiers**: readonly -**Type**:`get config(): IConfigRegistry;` - -Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment. - -### container -**Modifiers**: readonly -**Type**:`get container(): IRunClientOptions["container"] | undefined;` - -The that should host the game canvas. - -### env -**Modifiers**: readonly -**Type**:`get env(): Record;` - -Key/value map of environment variables made available at runtime. - -### files -**Modifiers**: readonly -**Type**:`get files(): IRunOptions["files"];` - -Map of virtual file paths to their URL strings, pre-loaded by the engine bundler. - -## Remarks - - Provides libraries with all the information they need during start-up: the canvas container, pre-loaded asset files, environment variables, and a config registry for loading structured configuration classes. Access it in a library's `__init` override: \ No newline at end of file diff --git a/references/1.4.2/common/InitContext/config.mdx b/references/1.4.2/common/InitContext/config.mdx deleted file mode 100644 index 862c74c..0000000 --- a/references/1.4.2/common/InitContext/config.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "config" -icon: "variable" -description: "Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# config - -## Summary - -Registry that resolves class-validator/class-transformer decorated configuration classes from the runtime environment. - -## Remarks - - Call `ctx.config.registerConfig(MyConfigClass)` to get a validated and transformed instance populated from `ctx.env`. \ No newline at end of file diff --git a/references/1.4.2/common/InitContext/constructor.mdx b/references/1.4.2/common/InitContext/constructor.mdx deleted file mode 100644 index 9966e29..0000000 --- a/references/1.4.2/common/InitContext/constructor.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the InitContext class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `InitContext` class -## Signature - -```typescript -constructor(context: ApplicationContext, libraryManager: LibraryManager, configRegistry: IConfigRegistry, options: IRunOptions); -``` - -## Parameters - -### context -- **Type**:`ApplicationContext` - -Shared application-level runtime state. - -### libraryManager -- **Type**:`LibraryManager` - -Manager giving access to other registered libraries. - -### configRegistry -- **Type**:`IConfigRegistry` - -Registry used to resolve typed configuration objects. - -### options -- **Type**:`IRunOptions` - -Run options forwarded from NanoforgeApplication.init. \ No newline at end of file diff --git a/references/1.4.2/common/InitContext/container.mdx b/references/1.4.2/common/InitContext/container.mdx deleted file mode 100644 index 93f8c55..0000000 --- a/references/1.4.2/common/InitContext/container.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "container" -icon: "variable" -description: "The HTMLDivElement that should host the game canvas." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# container - -## Summary - -The `HTMLDivElement` that should host the game canvas. - -## Remarks - - Only available in client contexts; `undefined` on the server. \ No newline at end of file diff --git a/references/1.4.2/common/InitContext/env.mdx b/references/1.4.2/common/InitContext/env.mdx deleted file mode 100644 index 3e29538..0000000 --- a/references/1.4.2/common/InitContext/env.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "env" -icon: "variable" -description: "Key/value map of environment variables made available at runtime." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# env - -## Summary - -Key/value map of environment variables made available at runtime. \ No newline at end of file diff --git a/references/1.4.2/common/InitContext/files.mdx b/references/1.4.2/common/InitContext/files.mdx deleted file mode 100644 index cfebe1f..0000000 --- a/references/1.4.2/common/InitContext/files.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "files" -icon: "variable" -description: "Map of virtual file paths to their URL strings, pre-loaded by the engine bundler." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# files - -## Summary - -Map of virtual file paths to their URL strings, pre-loaded by the engine bundler. \ No newline at end of file diff --git a/references/1.4.2/common/Library.mdx b/references/1.4.2/common/Library.mdx deleted file mode 100644 index 71d845c..0000000 --- a/references/1.4.2/common/Library.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "Library class" -icon: "box" -description: "Base class for all NanoForge libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Library - -## Summary - -Base class for all NanoForge libraries. -## Signature - -```typescript -declare abstract class Library implements ILibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### _relationship -**Modifiers**: protected -**Type**:`protected _relationship: RelationshipHandler;` - - - -## Remarks - - Extend this class (or one of its typed subclasses such as `BaseAssetManagerLibrary`, `BaseSoundLibrary`, etc.) to create a custom library. At minimum you must implement the `ILibrary.__name` getter and register the library with the engine before calling `NanoforgeApplication.init`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/common/Library/_relationship.mdx b/references/1.4.2/common/Library/_relationship.mdx deleted file mode 100644 index b5f1747..0000000 --- a/references/1.4.2/common/Library/_relationship.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "_relationship" -icon: "variable" -description: "_relationship API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _relationship \ No newline at end of file diff --git a/references/1.4.2/common/Library/constructor.mdx b/references/1.4.2/common/Library/constructor.mdx deleted file mode 100644 index f891ea6..0000000 --- a/references/1.4.2/common/Library/constructor.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the Library class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `Library` class -## Signature - -```typescript -constructor(rawOptions?: Partial); -``` - -## Parameters - -### rawOptions -- **Type**:`Partial` -- **Optional**: Yes - -Optional dependency and execution-order overrides. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryContext.mdx b/references/1.4.2/common/LibraryContext.mdx deleted file mode 100644 index 4697fb9..0000000 --- a/references/1.4.2/common/LibraryContext.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "LibraryContext class" -icon: "box" -description: "Tracks the current lifecycle state of a single library registration." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryContext - -## Summary - -Tracks the current lifecycle state of a single library registration. -## Signature - -```typescript -declare class LibraryContext -``` - -## Properties - -### status -**Modifiers**: readonly -**Type**:`get status(): LibraryStatusEnum;` - -Current lifecycle state of the associated library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryContext/status.mdx b/references/1.4.2/common/LibraryContext/status.mdx deleted file mode 100644 index 6f801c7..0000000 --- a/references/1.4.2/common/LibraryContext/status.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "status" -icon: "variable" -description: "Current lifecycle state of the associated library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# status - -## Summary - -Current lifecycle state of the associated library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryHandle.mdx b/references/1.4.2/common/LibraryHandle.mdx deleted file mode 100644 index 4aa0753..0000000 --- a/references/1.4.2/common/LibraryHandle.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "LibraryHandle class" -icon: "box" -description: "An opaque handle returned by LibraryManager accessors." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryHandle - -## Summary - -An opaque handle returned by `LibraryManager` accessors. -## Signature - -```typescript -declare class LibraryHandle -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### context -**Modifiers**: readonly -**Type**:`get context(): LibraryContext;` - -Current lifecycle context tracking the library's status. - -### library -**Modifiers**: readonly -**Type**:`get library(): T;` - -The underlying library instance. - -### symbol -**Modifiers**: readonly -**Type**:`get symbol(): symbol;` - -The registration symbol used to look up this library. - -## Remarks - - Bundles the library instance together with its registration symbol and lifecycle context. Prefer using the strongly-typed accessor methods on `LibraryManager` or `ClientLibraryManager` rather than constructing handles directly. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryHandle/constructor.mdx b/references/1.4.2/common/LibraryHandle/constructor.mdx deleted file mode 100644 index d2367b0..0000000 --- a/references/1.4.2/common/LibraryHandle/constructor.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the LibraryHandle class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `LibraryHandle` class -## Signature - -```typescript -constructor(sym: symbol, library: T, defaultContext: LibraryContext); -``` - -## Parameters - -### sym -- **Type**:`symbol` - -Registration symbol for this library. - -### library -- **Type**:`T` - -The library instance. - -### defaultContext -- **Type**:`LibraryContext` - -Initial lifecycle context. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryHandle/context.mdx b/references/1.4.2/common/LibraryHandle/context.mdx deleted file mode 100644 index 28d7907..0000000 --- a/references/1.4.2/common/LibraryHandle/context.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "context" -icon: "variable" -description: "Current lifecycle context tracking the library's status." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# context - -## Summary - -Current lifecycle context tracking the library's status. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryHandle/library.mdx b/references/1.4.2/common/LibraryHandle/library.mdx deleted file mode 100644 index c0f9812..0000000 --- a/references/1.4.2/common/LibraryHandle/library.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "library" -icon: "variable" -description: "The underlying library instance." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# library - -## Summary - -The underlying library instance. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryHandle/symbol.mdx b/references/1.4.2/common/LibraryHandle/symbol.mdx deleted file mode 100644 index b47145d..0000000 --- a/references/1.4.2/common/LibraryHandle/symbol.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "symbol" -icon: "variable" -description: "The registration symbol used to look up this library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# symbol - -## Summary - -The registration symbol used to look up this library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager.mdx b/references/1.4.2/common/LibraryManager.mdx deleted file mode 100644 index 011fdfd..0000000 --- a/references/1.4.2/common/LibraryManager.mdx +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "LibraryManager class" -icon: "box" -description: "Central registry for all libraries registered with a NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryManager - -## Summary - -Central registry for all libraries registered with a NanoForge application. -## Signature - -```typescript -declare class LibraryManager extends BaseLibraryManager -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getAssetManager - -Retrieve the registered asset-manager library. - -### getComponentSystem - -Retrieve the registered component-system (ECS) library. - -### getGraphics - -Retrieve the registered graphics library. - -### getInput - -Retrieve the registered input library. - -### getMusic - -Retrieve the registered music library. - -### getNetwork - -Retrieve the registered network library. - -### getSound - -Retrieve the registered sound library. - -## Remarks - - An instance is available inside every lifecycle context via `BaseContext.libraries`. Use the typed accessor methods to retrieve any built-in library, or call `BaseLibraryManager.get` with a custom symbol for user-defined libraries. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager/constructor.mdx b/references/1.4.2/common/LibraryManager/constructor.mdx deleted file mode 100644 index f4a0c93..0000000 --- a/references/1.4.2/common/LibraryManager/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the LibraryManager class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `LibraryManager` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager/getAssetManager.mdx b/references/1.4.2/common/LibraryManager/getAssetManager.mdx deleted file mode 100644 index 7f2ea14..0000000 --- a/references/1.4.2/common/LibraryManager/getAssetManager.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getAssetManager" -icon: "function" -description: "Retrieve the registered asset-manager library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getAssetManager - -## Summary - -Retrieve the registered asset-manager library. -## Signature - -```typescript -getAssetManager(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered asset-manager library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager/getComponentSystem.mdx b/references/1.4.2/common/LibraryManager/getComponentSystem.mdx deleted file mode 100644 index 45020f1..0000000 --- a/references/1.4.2/common/LibraryManager/getComponentSystem.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getComponentSystem" -icon: "function" -description: "Retrieve the registered component-system (ECS) library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentSystem - -## Summary - -Retrieve the registered component-system (ECS) library. -## Signature - -```typescript -getComponentSystem(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered component-system (ECS) library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager/getGraphics.mdx b/references/1.4.2/common/LibraryManager/getGraphics.mdx deleted file mode 100644 index fa2c568..0000000 --- a/references/1.4.2/common/LibraryManager/getGraphics.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getGraphics" -icon: "function" -description: "Retrieve the registered graphics library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getGraphics - -## Summary - -Retrieve the registered graphics library. -## Signature - -```typescript -getGraphics(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered graphics library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager/getInput.mdx b/references/1.4.2/common/LibraryManager/getInput.mdx deleted file mode 100644 index 238f50f..0000000 --- a/references/1.4.2/common/LibraryManager/getInput.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getInput" -icon: "function" -description: "Retrieve the registered input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getInput - -## Summary - -Retrieve the registered input library. -## Signature - -```typescript -getInput(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered input library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager/getMusic.mdx b/references/1.4.2/common/LibraryManager/getMusic.mdx deleted file mode 100644 index e8fc5f8..0000000 --- a/references/1.4.2/common/LibraryManager/getMusic.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMusic" -icon: "function" -description: "Retrieve the registered music library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMusic - -## Summary - -Retrieve the registered music library. -## Signature - -```typescript -getMusic(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered music library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager/getNetwork.mdx b/references/1.4.2/common/LibraryManager/getNetwork.mdx deleted file mode 100644 index b5df49a..0000000 --- a/references/1.4.2/common/LibraryManager/getNetwork.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getNetwork" -icon: "function" -description: "Retrieve the registered network library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getNetwork - -## Summary - -Retrieve the registered network library. -## Signature - -```typescript -getNetwork(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered network library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryManager/getSound.mdx b/references/1.4.2/common/LibraryManager/getSound.mdx deleted file mode 100644 index 3e4c97a..0000000 --- a/references/1.4.2/common/LibraryManager/getSound.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getSound" -icon: "function" -description: "Retrieve the registered sound library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getSound - -## Summary - -Retrieve the registered sound library. -## Signature - -```typescript -getSound(): LibraryHandle; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`LibraryHandle` - -Retrieve the registered sound library. \ No newline at end of file diff --git a/references/1.4.2/common/LibraryStatusEnum.mdx b/references/1.4.2/common/LibraryStatusEnum.mdx deleted file mode 100644 index 747ba33..0000000 --- a/references/1.4.2/common/LibraryStatusEnum.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "LibraryStatusEnum enum" -icon: "list" -description: "Lifecycle states a library can be in." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LibraryStatusEnum - -## Summary - -Lifecycle states a library can be in. - -## Members -| Member | Description | -| ------ | ----------- | -| `CLEAR` | The library has been cleared and its resources released. | -| `LOADED` | The library has been successfully initialised and is ready to use. | -| `UNLOADED` | The library has not been initialised yet. | \ No newline at end of file diff --git a/references/1.4.2/common/MUSIC_LIBRARY.mdx b/references/1.4.2/common/MUSIC_LIBRARY.mdx deleted file mode 100644 index 1ed1240..0000000 --- a/references/1.4.2/common/MUSIC_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "MUSIC_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the music library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# MUSIC_LIBRARY - -## Summary - -Registration symbol for the music library slot. -## Signature - -```typescript -MUSIC_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.use` with a custom music library or use it as a dependency symbol in `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.2/common/NETWORK_LIBRARY.mdx b/references/1.4.2/common/NETWORK_LIBRARY.mdx deleted file mode 100644 index eedcf69..0000000 --- a/references/1.4.2/common/NETWORK_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "NETWORK_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the network library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NETWORK_LIBRARY - -## Summary - -Registration symbol for the network library slot. -## Signature - -```typescript -NETWORK_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeApplication.useNetwork` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.2/common/NfConfigException.mdx b/references/1.4.2/common/NfConfigException.mdx deleted file mode 100644 index 1777a60..0000000 --- a/references/1.4.2/common/NfConfigException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfConfigException class" -icon: "box" -description: "Thrown when a library configuration is invalid or incomplete." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfConfigException - -## Summary - -Thrown when a library configuration is invalid or incomplete. -## Signature - -```typescript -declare class NfConfigException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Remarks - - Typically raised during `__init` when required environment variables are missing or fail validation. For example, `NetworkClientLibrary` throws this when neither `SERVER_TCP_PORT` nor `SERVER_UDP_PORT` is provided. \ No newline at end of file diff --git a/references/1.4.2/common/NfConfigException/code.mdx b/references/1.4.2/common/NfConfigException/code.mdx deleted file mode 100644 index 3401684..0000000 --- a/references/1.4.2/common/NfConfigException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 400." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `400`. \ No newline at end of file diff --git a/references/1.4.2/common/NfConfigException/constructor.mdx b/references/1.4.2/common/NfConfigException/constructor.mdx deleted file mode 100644 index 27d50ba..0000000 --- a/references/1.4.2/common/NfConfigException/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfConfigException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfConfigException` class -## Signature - -```typescript -constructor(message: string, library?: string); -``` - -## Parameters - -### message -- **Type**:`string` - -Description of the configuration error. - -### library -- **Type**:`string` -- **Optional**: Yes - -Optional library name that detected the error. \ No newline at end of file diff --git a/references/1.4.2/common/NfFetchException.mdx b/references/1.4.2/common/NfFetchException.mdx deleted file mode 100644 index 91501a8..0000000 --- a/references/1.4.2/common/NfFetchException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfFetchException class" -icon: "box" -description: "Thrown when an HTTP fetch performed internally by the engine fails." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfFetchException - -## Summary - -Thrown when an HTTP fetch performed internally by the engine fails. -## Signature - -```typescript -declare class NfFetchException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -The HTTP status code returned by the failed request (e.g. , ). - -## Remarks - - Raised by `NfFile` methods (e.g. `arrayBuffer`, `text`) when the underlying `fetch` call returns a non-OK HTTP response. \ No newline at end of file diff --git a/references/1.4.2/common/NfFetchException/code.mdx b/references/1.4.2/common/NfFetchException/code.mdx deleted file mode 100644 index f832308..0000000 --- a/references/1.4.2/common/NfFetchException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "The HTTP status code returned by the failed request (e.g. 404, 500)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -The HTTP status code returned by the failed request (e.g. `404`, `500`). \ No newline at end of file diff --git a/references/1.4.2/common/NfFetchException/constructor.mdx b/references/1.4.2/common/NfFetchException/constructor.mdx deleted file mode 100644 index 2fb11ee..0000000 --- a/references/1.4.2/common/NfFetchException/constructor.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfFetchException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfFetchException` class -## Signature - -```typescript -constructor(code: number, text: string); -``` - -## Parameters - -### code -- **Type**:`number` - -HTTP status code of the failed response. - -### text -- **Type**:`string` - -Status text of the failed response. \ No newline at end of file diff --git a/references/1.4.2/common/NfFile.mdx b/references/1.4.2/common/NfFile.mdx deleted file mode 100644 index 80bfa2e..0000000 --- a/references/1.4.2/common/NfFile.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "NfFile class" -icon: "box" -description: "Represents a file asset that has been registered with the engine." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfFile - -## Summary - -Represents a file asset that has been registered with the engine. -## Signature - -```typescript -declare class NfFile -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### path -**Modifiers**: readonly -**Type**:`get path(): string;` - -Internal URL path used to fetch the file. - -## Methods - -### arrayBuffer - -Fetch the file and return its content as an . - -### blob - -Fetch the file and return its content as a . - -### bytes - -Fetch the file and return its content as a . - -### formData - -Fetch the file and return its content as . - -### json - -Fetch the file, parse it as JSON, and return the result. - -### text - -Fetch the file and return its content as a UTF-8 string. - -## Remarks - - Instances are returned by `AssetManagerLibrary.getAsset`. Each method lazily fetches the file from the engine's virtual file system and returns the content in the requested format. All read methods throw `NfFetchException` when the underlying `fetch` returns a non-OK response. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/common/NfFile/arrayBuffer.mdx b/references/1.4.2/common/NfFile/arrayBuffer.mdx deleted file mode 100644 index 0a94d62..0000000 --- a/references/1.4.2/common/NfFile/arrayBuffer.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "arrayBuffer" -icon: "function" -description: "Fetch the file and return its content as an ArrayBuffer." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# arrayBuffer - -## Summary - -Fetch the file and return its content as an `ArrayBuffer`. -## Signature - -```typescript -arrayBuffer(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as an . \ No newline at end of file diff --git a/references/1.4.2/common/NfFile/blob.mdx b/references/1.4.2/common/NfFile/blob.mdx deleted file mode 100644 index f5a1fd4..0000000 --- a/references/1.4.2/common/NfFile/blob.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "blob" -icon: "function" -description: "Fetch the file and return its content as a Blob." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# blob - -## Summary - -Fetch the file and return its content as a `Blob`. -## Signature - -```typescript -blob(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as a . \ No newline at end of file diff --git a/references/1.4.2/common/NfFile/bytes.mdx b/references/1.4.2/common/NfFile/bytes.mdx deleted file mode 100644 index c43ba59..0000000 --- a/references/1.4.2/common/NfFile/bytes.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "bytes" -icon: "function" -description: "Fetch the file and return its content as a Uint8Array." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# bytes - -## Summary - -Fetch the file and return its content as a `Uint8Array`. -## Signature - -```typescript -bytes(): Promise>; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise>` - -Fetch the file and return its content as a . \ No newline at end of file diff --git a/references/1.4.2/common/NfFile/constructor.mdx b/references/1.4.2/common/NfFile/constructor.mdx deleted file mode 100644 index 3e80d1f..0000000 --- a/references/1.4.2/common/NfFile/constructor.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfFile class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfFile` class -## Signature - -```typescript -constructor(path: string); -``` - -## Parameters - -### path -- **Type**:`string` - -Internal URL path used to fetch the file. \ No newline at end of file diff --git a/references/1.4.2/common/NfFile/formData.mdx b/references/1.4.2/common/NfFile/formData.mdx deleted file mode 100644 index 93ab538..0000000 --- a/references/1.4.2/common/NfFile/formData.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "formData" -icon: "function" -description: "Fetch the file and return its content as FormData." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# formData - -## Summary - -Fetch the file and return its content as `FormData`. -## Signature - -```typescript -formData(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as . \ No newline at end of file diff --git a/references/1.4.2/common/NfFile/json.mdx b/references/1.4.2/common/NfFile/json.mdx deleted file mode 100644 index 350501a..0000000 --- a/references/1.4.2/common/NfFile/json.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "json" -icon: "function" -description: "Fetch the file, parse it as JSON, and return the result." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# json - -## Summary - -Fetch the file, parse it as JSON, and return the result. -## Signature - -```typescript -json(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file, parse it as JSON, and return the result. \ No newline at end of file diff --git a/references/1.4.2/common/NfFile/path.mdx b/references/1.4.2/common/NfFile/path.mdx deleted file mode 100644 index 4653fc5..0000000 --- a/references/1.4.2/common/NfFile/path.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "path" -icon: "variable" -description: "Internal URL path used to fetch the file." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# path - -## Summary - -Internal URL path used to fetch the file. \ No newline at end of file diff --git a/references/1.4.2/common/NfFile/text.mdx b/references/1.4.2/common/NfFile/text.mdx deleted file mode 100644 index 87ed647..0000000 --- a/references/1.4.2/common/NfFile/text.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "text" -icon: "function" -description: "Fetch the file and return its content as a UTF-8 string." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# text - -## Summary - -Fetch the file and return its content as a UTF-8 string. -## Signature - -```typescript -text(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Fetch the file and return its content as a UTF-8 string. \ No newline at end of file diff --git a/references/1.4.2/common/NfNotFound.mdx b/references/1.4.2/common/NfNotFound.mdx deleted file mode 100644 index 656e89d..0000000 --- a/references/1.4.2/common/NfNotFound.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "NfNotFound class" -icon: "box" -description: "Thrown when a requested resource (asset, sound, music track, etc.) cannot be found in the engine's registry." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfNotFound - -## Summary - -Thrown when a requested resource (asset, sound, music track, etc.) cannot be found in the engine's registry. -## Signature - -```typescript -declare class NfNotFound extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/common/NfNotFound/code.mdx b/references/1.4.2/common/NfNotFound/code.mdx deleted file mode 100644 index 8bd0665..0000000 --- a/references/1.4.2/common/NfNotFound/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 404." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `404`. \ No newline at end of file diff --git a/references/1.4.2/common/NfNotFound/constructor.mdx b/references/1.4.2/common/NfNotFound/constructor.mdx deleted file mode 100644 index 8165021..0000000 --- a/references/1.4.2/common/NfNotFound/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfNotFound class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfNotFound` class -## Signature - -```typescript -constructor(item: string, type?: string); -``` - -## Parameters - -### item -- **Type**:`string` - -Name or path of the missing resource. - -### type -- **Type**:`string` -- **Optional**: Yes - -Optional category label (e.g. "Asset", "Sound"). \ No newline at end of file diff --git a/references/1.4.2/common/NfNotInitializedException.mdx b/references/1.4.2/common/NfNotInitializedException.mdx deleted file mode 100644 index a6bfda6..0000000 --- a/references/1.4.2/common/NfNotInitializedException.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NfNotInitializedException class" -icon: "box" -description: "Thrown when a method is called on a library or engine component before it has been initialised via init." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NfNotInitializedException - -## Summary - -Thrown when a method is called on a library or engine component before it has been initialised via `__init`. -## Signature - -```typescript -declare class NfNotInitializedException extends NfException -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Properties - -### code -**Modifiers**: readonly -**Type**:`get code(): number;` - -Always . - -## Remarks - - This exception is raised automatically by the helper method `Library.throwNotInitializedError()`. Ensure that `NanoforgeApplication.init` has resolved before interacting with any library. \ No newline at end of file diff --git a/references/1.4.2/common/NfNotInitializedException/code.mdx b/references/1.4.2/common/NfNotInitializedException/code.mdx deleted file mode 100644 index 8bd0665..0000000 --- a/references/1.4.2/common/NfNotInitializedException/code.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "code" -icon: "variable" -description: "Always 404." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# code - -## Summary - -Always `404`. \ No newline at end of file diff --git a/references/1.4.2/common/NfNotInitializedException/constructor.mdx b/references/1.4.2/common/NfNotInitializedException/constructor.mdx deleted file mode 100644 index f26a60c..0000000 --- a/references/1.4.2/common/NfNotInitializedException/constructor.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the NfNotInitializedException class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `NfNotInitializedException` class -## Signature - -```typescript -constructor(item: string, type?: string); -``` - -## Parameters - -### item -- **Type**:`string` - -Name of the uninitialised component (e.g. the library's __name). - -### type -- **Type**:`string` -- **Optional**: Yes - -Optional category label (e.g. "Library"). \ No newline at end of file diff --git a/references/1.4.2/common/SOUND_LIBRARY.mdx b/references/1.4.2/common/SOUND_LIBRARY.mdx deleted file mode 100644 index 3f53355..0000000 --- a/references/1.4.2/common/SOUND_LIBRARY.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "SOUND_LIBRARY variable" -icon: "variable" -description: "Registration symbol for the sound library slot." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SOUND_LIBRARY - -## Summary - -Registration symbol for the sound library slot. -## Signature - -```typescript -SOUND_LIBRARY: unique symbol -``` - -## Remarks - - Pass this symbol to `NanoforgeClient.useSound` or use it as a dependency symbol in a custom library's `ILibraryOptions.dependencies`. \ No newline at end of file diff --git a/references/1.4.2/config/0-index.mdx b/references/1.4.2/config/0-index.mdx deleted file mode 100644 index 40c1d35..0000000 --- a/references/1.4.2/config/0-index.mdx +++ /dev/null @@ -1,159 +0,0 @@ ---- -title: "Config" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/config` is a wrapper of [class-validator][class-validator] and [class-transformer][class-transformer] to imports validation and transformation decorators. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/config -yarn add @nanoforge-dev/config -pnpm add @nanoforge-dev/config -bun add @nanoforge-dev/config -``` - -## Warning - -This library is of exclusive usage for other libraries. To put variables in the environment to allow libraries to use it through this config library, you must put it in `.env` file at the root of your project (or in your environment) : - -```dotenv -NANOFORGE_CLIENT_SERVER_TCP_PORT=4445 -NANOFORGE_CLIENT_SERVER_UDP_PORT=4444 -NANOFORGE_CLIENT_SERVER_ADDRESS=127.0.0.1 -``` - -You must prefix your variables according to this table : - -| Prefix | Availability | -| :------------------ | :----------------------- | -| `NANOFORGE_CLIENT_` | Available in client only | -| `NANOFORGE_SERVER_` | Available in server only | -| `NANOFORGE_` | Available in both apps | - -⚠️ Prefixs are removed in libs - -You can also put it in init options (every value must be string or undefined) : - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkLibrary } from "@nanoforge-dev/network"; - -export async function main(options: IRunOptions) { - const app = NanoforgeFactory.createClient(); - - const network = new NetworkLibrary(); - - app.useNetwork(network); - - await app.init({ - ...options, - env: { - ...options.env, - SERVER_TCP_PORT: "4445", - SERVER_UDP_PORT: "4444", - SERVER_ADDRESS: "127.0.0.1", - }, - }); - - await app.run(); -} -``` - -## Example usage - -Initialize the library in your main file. - -```ts -export class NetworkClientLibrary extends BaseNetworkLibrary { - get __name(): string { - return "NetworkClientLibrary"; - } - - public override async __init(context: InitContext): Promise { - const config = await context.config.registerConfig(ClientConfigNetwork); - - // Do something with config - } -} -``` - -Using this config - -```ts -import { - Default, - Expose, - IsByteLength, - IsIpOrURL, - IsOptional, - IsPort, -} from "@nanoforge-dev/config"; - -export class ClientConfigNetwork { - // This var must be a string port (ex: "4444") but can be undefined - @Expose() - @IsOptional() - @IsPort() - SERVER_TCP_PORT?: string; - - @Expose() - @IsOptional() - @IsPort() - SERVER_UDP_PORT?: string; - - // This var must be ip address or fqdn (it cannot be undefined) - @Expose() - @IsIpOrURL() - SERVER_ADDRESS?: string; - - // This var must be a byte length between 2 and 64. It can be undefined as it as a default value. - @Expose() - @Default("PACKET_END") - @IsByteLength(2, 64) - MAGIC_VALUE!: string; -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/config -[npm]: https://www.npmjs.com/package/@nanoforge-dev/config -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md -[class-validator]: https://github.com/typestack/class-validator -[class-transformer]: https://github.com/typestack/class-transformer diff --git a/references/1.4.2/config/Default.mdx b/references/1.4.2/config/Default.mdx deleted file mode 100644 index aeb1dc4..0000000 --- a/references/1.4.2/config/Default.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Default function" -icon: "function" -description: "Property decorator that supplies a fallback value when the environment variable is undefined or null." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Default - -## Summary - -Property decorator that supplies a fallback value when the environment variable is `undefined` or `null`. -## Signature - -```typescript -declare function Default(defaultValue: unknown): PropertyDecorator; -``` - -## Parameters - -### defaultValue -**Type**:`unknown` - -The value to use when the property is absent. - -## Returns - -**Type**:`PropertyDecorator` - -Property decorator that supplies a fallback value when the environment variable is or . - -## Remarks - - Pairs with `class-transformer`'s `@Expose` and `class-validator` decorators. The default is deep-cloned via `JSON.parse(JSON.stringify(…))` so objects are not shared between instances. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/config/IsIpOrURL.mdx b/references/1.4.2/config/IsIpOrURL.mdx deleted file mode 100644 index 50970b0..0000000 --- a/references/1.4.2/config/IsIpOrURL.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "IsIpOrURL function" -icon: "function" -description: "Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (URL)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# IsIpOrURL - -## Summary - -Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (URL). -## Signature - -```typescript -IsIpOrURL: (validationOptions?: ValidationOptions, isIPOptions?: Parameters[1], isURLOptions?: Parameters[1]) => (object: object, propertyName: string) => void -``` - -## Parameters - -### validationOptions -**Type**:`ValidationOptions` -**Optional**: Yes - -Optional class-validator validation options. - -### isIPOptions -**Type**:`Parameters[1]` -**Optional**: Yes - -Optional options for validation. - -### isURLOptions -**Type**:`Parameters[1]` -**Optional**: Yes - -Optional options for validation. - -## Returns - -**Type**:`(object: object, propertyName: string) => void` - -Property decorator that validates whether the value is a valid IPv4/IPv6 address or a fully qualified domain name (URL). - -## Remarks - - Built on top of `class-validator`'s `isIP` and `isURL` helpers. Use on config properties that represent server hostnames or addresses. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/config/TransformToBoolean.mdx b/references/1.4.2/config/TransformToBoolean.mdx deleted file mode 100644 index 4efdf4e..0000000 --- a/references/1.4.2/config/TransformToBoolean.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "TransformToBoolean function" -icon: "function" -description: "Property decorator that transforms the string environment variable value \"true\" or \"false\" into a native boolean." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TransformToBoolean - -## Summary - -Property decorator that transforms the string environment variable value `"true"` or `"false"` into a native `boolean`. -## Signature - -```typescript -TransformToBoolean: () => PropertyDecorator -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`PropertyDecorator` - -Property decorator that transforms the string environment variable value or into a native . - -## Remarks - - Returns `undefined` for any value that is neither `"true"` nor `"false"`. Pair with `@IsBoolean()` and `@Default(false)` for a fully validated and defaulted boolean config property. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/core-editor/0-index.mdx b/references/1.4.2/core-editor/0-index.mdx deleted file mode 100644 index 339d811..0000000 --- a/references/1.4.2/core-editor/0-index.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "Core Editor" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/core-editor` is a package made to allow the editor to make change to a game even if it's already compiled and running. - -If you want a core to run your game use the `@nanoforge-dev/core`. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/core-editor -yarn add @nanoforge-dev/core-editor -pnpm add @nanoforge-dev/core-editor -bun add @nanoforge-dev/core-editor -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/core-editor -[npm]: https://www.npmjs.com/package/@nanoforge-dev/core-editor -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/core-editor/CoreEvents.mdx b/references/1.4.2/core-editor/CoreEvents.mdx deleted file mode 100644 index 1fc259b..0000000 --- a/references/1.4.2/core-editor/CoreEvents.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "CoreEvents enum" -icon: "list" -description: "Events that the NanoForge editor can emit to the running engine." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# CoreEvents - -## Summary - -Events that the NanoForge editor can emit to the running engine. - -## Members -| Member | Description | -| ------ | ----------- | -| `HARD_RELOAD` | Reload all entities component params | -| `HOT_RELOAD` | Reload only changed entity components params (live-patch) | -| `PAUSE_GAME` | Don't execute the run function until UNPAUSE_GAME | -| `STOP_GAME` | End main loop and clear | -| `UNPAUSE_GAME` | resume executing the run function | \ No newline at end of file diff --git a/references/1.4.2/core-editor/EditorEvents.mdx b/references/1.4.2/core-editor/EditorEvents.mdx deleted file mode 100644 index d62aa05..0000000 --- a/references/1.4.2/core-editor/EditorEvents.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "EditorEvents enum" -icon: "list" -description: "EditorEvents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorEvents - -## Members -| Member | Description | -| ------ | ----------- | -| `MOVE_COMPONENT` | | \ No newline at end of file diff --git a/references/1.4.2/core-editor/EventEmitter.mdx b/references/1.4.2/core-editor/EventEmitter.mdx deleted file mode 100644 index 12dd7b2..0000000 --- a/references/1.4.2/core-editor/EventEmitter.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "EventEmitter class" -icon: "box" -description: "EventEmitter API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EventEmitter -## Signature - -```typescript -declare class EventEmitter -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### emit - - - -### on - - - -### runEvents \ No newline at end of file diff --git a/references/1.4.2/core-editor/EventEmitter/constructor.mdx b/references/1.4.2/core-editor/EventEmitter/constructor.mdx deleted file mode 100644 index 1a46ef1..0000000 --- a/references/1.4.2/core-editor/EventEmitter/constructor.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the EventEmitter class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `EventEmitter` class -## Signature - -```typescript -constructor(opts: IRunOptions["editor"]); -``` - -## Parameters - -### opts -- **Type**:`IRunOptions["editor"]` \ No newline at end of file diff --git a/references/1.4.2/core-editor/EventEmitter/emit.mdx b/references/1.4.2/core-editor/EventEmitter/emit.mdx deleted file mode 100644 index c3eedbd..0000000 --- a/references/1.4.2/core-editor/EventEmitter/emit.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "emit" -icon: "function" -description: "emit API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# emit -## Signature - -```typescript -emit(event: K, ...args: EditorEventsMap[K]): void; -``` - -## Parameters - -### event -**Type**:`K` - - - -### args -**Type**:`EditorEventsMap[K]` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.2/core-editor/EventEmitter/on.mdx b/references/1.4.2/core-editor/EventEmitter/on.mdx deleted file mode 100644 index 21e7823..0000000 --- a/references/1.4.2/core-editor/EventEmitter/on.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "on" -icon: "function" -description: "on API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# on -## Signature - -```typescript -on(event: K, listener: ListenerType): void; -``` - -## Parameters - -### event -**Type**:`K` - - - -### listener -**Type**:`ListenerType` - - - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.2/core-editor/EventEmitter/runEvents.mdx b/references/1.4.2/core-editor/EventEmitter/runEvents.mdx deleted file mode 100644 index 15658b2..0000000 --- a/references/1.4.2/core-editor/EventEmitter/runEvents.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "runEvents" -icon: "function" -description: "runEvents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# runEvents -## Signature - -```typescript -runEvents(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` \ No newline at end of file diff --git a/references/1.4.2/core-editor/NanoforgeClient.mdx b/references/1.4.2/core-editor/NanoforgeClient.mdx deleted file mode 100644 index 7efda75..0000000 --- a/references/1.4.2/core-editor/NanoforgeClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "NanoforgeClient class" -icon: "box" -description: "Client-side NanoForge application for editor mode." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeClient - -## Summary - -Client-side NanoForge application for editor mode. -## Signature - -```typescript -declare class NanoforgeClient extends NanoforgeApplication -``` - -## Methods - -### useGraphics - -Register the graphics library. - -### useInput - -Register the input library. - -### useSound - -Register the sound-effect library. - -## Remarks - - Extends `NanoforgeApplication` with graphics, input, and sound library slots. Create via the `core-editor` `NanoforgeFactory`. \ No newline at end of file diff --git a/references/1.4.2/core-editor/NanoforgeClient/useGraphics.mdx b/references/1.4.2/core-editor/NanoforgeClient/useGraphics.mdx deleted file mode 100644 index 27045ab..0000000 --- a/references/1.4.2/core-editor/NanoforgeClient/useGraphics.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useGraphics" -icon: "function" -description: "Register the graphics library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useGraphics - -## Summary - -Register the graphics library. -## Signature - -```typescript -useGraphics(library: IGraphicsLibrary): void; -``` - -## Parameters - -### library -**Type**:`IGraphicsLibrary` - -Graphics library instance (e.g. Graphics2DLibrary). - -## Returns - -**Type**:`void` - -Register the graphics library. \ No newline at end of file diff --git a/references/1.4.2/core-editor/NanoforgeClient/useInput.mdx b/references/1.4.2/core-editor/NanoforgeClient/useInput.mdx deleted file mode 100644 index 799cad5..0000000 --- a/references/1.4.2/core-editor/NanoforgeClient/useInput.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useInput" -icon: "function" -description: "Register the input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useInput - -## Summary - -Register the input library. -## Signature - -```typescript -useInput(library: IInputLibrary): void; -``` - -## Parameters - -### library -**Type**:`IInputLibrary` - -Input library instance (e.g. InputLibrary). - -## Returns - -**Type**:`void` - -Register the input library. \ No newline at end of file diff --git a/references/1.4.2/core-editor/NanoforgeClient/useSound.mdx b/references/1.4.2/core-editor/NanoforgeClient/useSound.mdx deleted file mode 100644 index 30f6b34..0000000 --- a/references/1.4.2/core-editor/NanoforgeClient/useSound.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useSound" -icon: "function" -description: "Register the sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useSound - -## Summary - -Register the sound-effect library. -## Signature - -```typescript -useSound(library: ISoundLibrary): void; -``` - -## Parameters - -### library -**Type**:`ISoundLibrary` - -Sound library instance (e.g. SoundLibrary). - -## Returns - -**Type**:`void` - -Register the sound-effect library. \ No newline at end of file diff --git a/references/1.4.2/core-editor/NanoforgeFactory.mdx b/references/1.4.2/core-editor/NanoforgeFactory.mdx deleted file mode 100644 index 88d924e..0000000 --- a/references/1.4.2/core-editor/NanoforgeFactory.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeFactory variable" -icon: "variable" -description: "Singleton factory for creating editor-mode NanoForge client and server applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeFactory - -## Summary - -Singleton factory for creating editor-mode NanoForge client and server applications. -## Signature - -```typescript -NanoforgeFactory: NanoforgeFactoryStatic -``` - -## Remarks - - Use `NanoforgeFactory.createClient` or `NanoforgeFactory.createServer` to obtain an application instance that accepts `IEditorRunOptions` on `init`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/core-editor/NanoforgeServer.mdx b/references/1.4.2/core-editor/NanoforgeServer.mdx deleted file mode 100644 index 81c27e0..0000000 --- a/references/1.4.2/core-editor/NanoforgeServer.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "NanoforgeServer class" -icon: "box" -description: "Server-side NanoForge application for editor mode." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeServer - -## Summary - -Server-side NanoForge application for editor mode. -## Signature - -```typescript -declare class NanoforgeServer extends NanoforgeApplication -``` - -## Remarks - - Extends `NanoforgeApplication` for use in server processes during editor sessions. Create via the `core-editor` `NanoforgeFactory`. \ No newline at end of file diff --git a/references/1.4.2/core/0-index.mdx b/references/1.4.2/core/0-index.mdx deleted file mode 100644 index 4f7f4ac..0000000 --- a/references/1.4.2/core/0-index.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "Core" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/core` is a core package that contains game main loop. It is used to initialize the game and run it. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/core -yarn add @nanoforge-dev/core -pnpm add @nanoforge-dev/core -bun add @nanoforge-dev/core -``` - -## Example usage - -Initialize the game in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - await app.init(options); - - await app.run(); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/core -[npm]: https://www.npmjs.com/package/@nanoforge-dev/core -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/core/NanoforgeClient.mdx b/references/1.4.2/core/NanoforgeClient.mdx deleted file mode 100644 index eab01be..0000000 --- a/references/1.4.2/core/NanoforgeClient.mdx +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: "NanoforgeClient class" -icon: "box" -description: "Client-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeClient - -## Summary - -Client-side NanoForge application. -## Signature - -```typescript -declare class NanoforgeClient extends NanoforgeApplication -``` - -## Methods - -### useGraphics - -Register the graphics library used to render the game. - -### useInput - -Register the input library used to read keyboard and mouse state. - -### useSound - -Register the sound-effect library. - -## Remarks - - Extends `NanoforgeApplication` with client-specific library slots for graphics, input, and sound. Create an instance via `NanoforgeFactory.createClient`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/core/NanoforgeClient/useGraphics.mdx b/references/1.4.2/core/NanoforgeClient/useGraphics.mdx deleted file mode 100644 index ce92bfb..0000000 --- a/references/1.4.2/core/NanoforgeClient/useGraphics.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useGraphics" -icon: "function" -description: "Register the graphics library used to render the game." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useGraphics - -## Summary - -Register the graphics library used to render the game. -## Signature - -```typescript -useGraphics(library: IGraphicsLibrary): void; -``` - -## Parameters - -### library -**Type**:`IGraphicsLibrary` - -Graphics library instance (e.g. Graphics2DLibrary). - -## Returns - -**Type**:`void` - -Register the graphics library used to render the game. \ No newline at end of file diff --git a/references/1.4.2/core/NanoforgeClient/useInput.mdx b/references/1.4.2/core/NanoforgeClient/useInput.mdx deleted file mode 100644 index 2e014a7..0000000 --- a/references/1.4.2/core/NanoforgeClient/useInput.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useInput" -icon: "function" -description: "Register the input library used to read keyboard and mouse state." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useInput - -## Summary - -Register the input library used to read keyboard and mouse state. -## Signature - -```typescript -useInput(library: IInputLibrary): void; -``` - -## Parameters - -### library -**Type**:`IInputLibrary` - -Input library instance (e.g. InputLibrary). - -## Returns - -**Type**:`void` - -Register the input library used to read keyboard and mouse state. \ No newline at end of file diff --git a/references/1.4.2/core/NanoforgeClient/useSound.mdx b/references/1.4.2/core/NanoforgeClient/useSound.mdx deleted file mode 100644 index 30f6b34..0000000 --- a/references/1.4.2/core/NanoforgeClient/useSound.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "useSound" -icon: "function" -description: "Register the sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# useSound - -## Summary - -Register the sound-effect library. -## Signature - -```typescript -useSound(library: ISoundLibrary): void; -``` - -## Parameters - -### library -**Type**:`ISoundLibrary` - -Sound library instance (e.g. SoundLibrary). - -## Returns - -**Type**:`void` - -Register the sound-effect library. \ No newline at end of file diff --git a/references/1.4.2/core/NanoforgeFactory.mdx b/references/1.4.2/core/NanoforgeFactory.mdx deleted file mode 100644 index a383a67..0000000 --- a/references/1.4.2/core/NanoforgeFactory.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeFactory variable" -icon: "variable" -description: "Singleton factory for creating NanoForge client and server applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeFactory - -## Summary - -Singleton factory for creating NanoForge client and server applications. -## Signature - -```typescript -NanoforgeFactory: NanoforgeFactoryStatic -``` - -## Remarks - - Use `NanoforgeFactory.createClient` or `NanoforgeFactory.createServer` to obtain a new application instance, then attach libraries and call `init` / `run`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/core/NanoforgeServer.mdx b/references/1.4.2/core/NanoforgeServer.mdx deleted file mode 100644 index 5430293..0000000 --- a/references/1.4.2/core/NanoforgeServer.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "NanoforgeServer class" -icon: "box" -description: "Server-side NanoForge application." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NanoforgeServer - -## Summary - -Server-side NanoForge application. -## Signature - -```typescript -declare class NanoforgeServer extends NanoforgeApplication -``` - -## Remarks - - Extends `NanoforgeApplication` for use in Node.js server processes. Create an instance via `NanoforgeFactory.createServer`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-client/0-index.mdx b/references/1.4.2/ecs-client/0-index.mdx deleted file mode 100644 index fb79025..0000000 --- a/references/1.4.2/ecs-client/0-index.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Ecs Client" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-client` is a wrapper of `@nanoforge-dev/ecs-lib` for client-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-client -yarn add @nanoforge-dev/ecs-client -pnpm add @nanoforge-dev/ecs-client -bun add @nanoforge-dev/ecs-client -``` - -## Example usage - -Initialize the library in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSClientLibrary } from "@nanoforge-dev/ecs-client"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const ecs = new ECSClientLibrary(); - - app.useComponentSystem(ecs); - - await app.init(options); - - const registry = ecs.registry; - - const entity = registry.spawnEntity(); - registry.addComponent(entity, new ExampleComponent("foo", 42)); - - registry.addSystem(exampleSystem); - - await app.run(); -} -``` - -With component - -```ts -export class ExampleComponent { - name = this.constructor.name; - - constructor( - public paramA: string, - public paramB: number, - public paramC: boolean = false, - ) {} - - get foo() { - return "bar"; - } - - get paramAOrDefault() { - return this.paramC ? this.paramA : "default"; - } - - addOne() { - this.paramB += 1; - } -} -``` - -And system - -```ts -export const exampleSystem = (registry: Registry, ctx: Context) => { - const entities = registry.getZipper([ExampleComponent]); - - entities.forEach((entity) => { - if (entity.ExampleComponent.paramA === "end") { - ctx.app.setIsRunning(false); - return; - } - - if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end"; - - if (entity.ExampleComponent.paramB >= 0) - entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1; - }); -}; -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-client -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-client -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/ecs-client/ECSClientLibrary.mdx b/references/1.4.2/ecs-client/ECSClientLibrary.mdx deleted file mode 100644 index d87f98e..0000000 --- a/references/1.4.2/ecs-client/ECSClientLibrary.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ECSClientLibrary class" -icon: "box" -description: "Client-side ECS library backed by the compiled WASM module." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ECSClientLibrary - -## Summary - -Client-side ECS library backed by the compiled WASM module. -## Signature - -```typescript -declare class ECSClientLibrary extends AbstractECSLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Remarks - - Loads `libecs.wasm` from the asset manager and initialises the entity registry. Register with the application: Access the registry in game code: \ No newline at end of file diff --git a/references/1.4.2/ecs-client/ECSClientLibrary/constructor.mdx b/references/1.4.2/ecs-client/ECSClientLibrary/constructor.mdx deleted file mode 100644 index 259968e..0000000 --- a/references/1.4.2/ecs-client/ECSClientLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ECSClientLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ECSClientLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/0-index.mdx b/references/1.4.2/ecs-lib/0-index.mdx deleted file mode 100644 index 54a7543..0000000 --- a/references/1.4.2/ecs-lib/0-index.mdx +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: "Ecs Lib" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-lib` is a powerful data structure for managing game entities. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-lib -yarn add @nanoforge-dev/ecs-lib -pnpm add @nanoforge-dev/ecs-lib -bun add @nanoforge-dev/ecs-lib -``` - -## Warning - -This library is not usable on its own. You must use either the [ECS Client][ecs-client] or [ECS Server][ecs-server]. - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-lib -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-lib -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md -[ecs-client]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-client -[ecs-server]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-server diff --git a/references/1.4.2/ecs-lib/AbstractECSLibrary.mdx b/references/1.4.2/ecs-lib/AbstractECSLibrary.mdx deleted file mode 100644 index 73fd0d9..0000000 --- a/references/1.4.2/ecs-lib/AbstractECSLibrary.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "AbstractECSLibrary class" -icon: "box" -description: "Abstract base class for WASM-backed ECS (Entity Component System) libraries." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# AbstractECSLibrary - -## Summary - -Abstract base class for WASM-backed ECS (Entity Component System) libraries. -## Signature - -```typescript -declare abstract class AbstractECSLibrary extends BaseComponentSystemLibrary -``` - -## Constructors - -### constructor -**Modifiers**: protected - -Constructs a new instance of the class - -## Properties - -### _registry -**Modifiers**: protected -**Type**:`protected _registry?: Registry;` -**Optional**: Yes - - - -### module -**Modifiers**: protected -**Type**:`protected module?: MainModule;` -**Optional**: Yes - - - -### path -**Modifiers**: protected -**Type**:`protected path: string;` - - - -### registry -**Modifiers**: readonly -**Type**:`get registry(): Registry;` - -The WASM-backed entity/component registry. - -## Remarks - - Loads a compiled `libecs.wasm` binary via the asset manager and initialises a `Registry` from the resulting module. Concrete subclasses only need to set `this.path` (the asset path to the `.wasm` file) and call `super()` — see `ECSClientLibrary` and `ECSServerLibrary`. Requires the `ASSET_MANAGER_LIBRARY` dependency and runs after `GRAPHICS_LIBRARY`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/AbstractECSLibrary/_registry.mdx b/references/1.4.2/ecs-lib/AbstractECSLibrary/_registry.mdx deleted file mode 100644 index 342b7fc..0000000 --- a/references/1.4.2/ecs-lib/AbstractECSLibrary/_registry.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "_registry" -icon: "variable" -description: "_registry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# _registry \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/AbstractECSLibrary/constructor.mdx b/references/1.4.2/ecs-lib/AbstractECSLibrary/constructor.mdx deleted file mode 100644 index 8b8f644..0000000 --- a/references/1.4.2/ecs-lib/AbstractECSLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the AbstractECSLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `AbstractECSLibrary` class -## Signature - -```typescript -protected constructor(); -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/AbstractECSLibrary/module.mdx b/references/1.4.2/ecs-lib/AbstractECSLibrary/module.mdx deleted file mode 100644 index ec9dbeb..0000000 --- a/references/1.4.2/ecs-lib/AbstractECSLibrary/module.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "module" -icon: "variable" -description: "module API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# module \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/AbstractECSLibrary/path.mdx b/references/1.4.2/ecs-lib/AbstractECSLibrary/path.mdx deleted file mode 100644 index 914b96c..0000000 --- a/references/1.4.2/ecs-lib/AbstractECSLibrary/path.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "path" -icon: "variable" -description: "path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# path \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/AbstractECSLibrary/registry.mdx b/references/1.4.2/ecs-lib/AbstractECSLibrary/registry.mdx deleted file mode 100644 index 9926955..0000000 --- a/references/1.4.2/ecs-lib/AbstractECSLibrary/registry.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "registry" -icon: "variable" -description: "The WASM-backed entity/component registry." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registry - -## Summary - -The WASM-backed entity/component registry. - -## Remarks - - Use this to spawn entities, register components, add systems, and query component data. \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Component.mdx b/references/1.4.2/ecs-lib/Component.mdx deleted file mode 100644 index d75478d..0000000 --- a/references/1.4.2/ecs-lib/Component.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Component type" -icon: "file-code" -description: "Component API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Component -## Signature - -```typescript -type Component = { - name: string; - [key: string]: any; -}; -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/EditorComponentManifest.mdx b/references/1.4.2/ecs-lib/EditorComponentManifest.mdx deleted file mode 100644 index 34e71a1..0000000 --- a/references/1.4.2/ecs-lib/EditorComponentManifest.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "EditorComponentManifest type" -icon: "file-code" -description: "Manifest for a component to be used in the NanoForge Editor" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorComponentManifest - -## Summary - -Manifest for a component to be used in the NanoForge Editor -## Signature - -```typescript -type EditorComponentManifest = { - name: string; - description?: string; - params: ECSElement[]; -}; -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/EditorSystemManifest.mdx b/references/1.4.2/ecs-lib/EditorSystemManifest.mdx deleted file mode 100644 index b8631d9..0000000 --- a/references/1.4.2/ecs-lib/EditorSystemManifest.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "EditorSystemManifest type" -icon: "file-code" -description: "Manifest for a system to be used in the NanoForge Editor" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EditorSystemManifest - -## Summary - -Manifest for a system to be used in the NanoForge Editor -## Signature - -```typescript -type EditorSystemManifest = { - name: string; - description?: string; - dependencies: string[]; -}; -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Entity.mdx b/references/1.4.2/ecs-lib/Entity.mdx deleted file mode 100644 index b30bd3a..0000000 --- a/references/1.4.2/ecs-lib/Entity.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Entity interface" -icon: "plug" -description: "Entity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Entity -## Signature - -```typescript -interface Entity extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Entity/getId.mdx b/references/1.4.2/ecs-lib/Entity/getId.mdx deleted file mode 100644 index b363787..0000000 --- a/references/1.4.2/ecs-lib/Entity/getId.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getId" -icon: "file" -description: "getId API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getId - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry.mdx b/references/1.4.2/ecs-lib/Registry.mdx deleted file mode 100644 index b505c2e..0000000 --- a/references/1.4.2/ecs-lib/Registry.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Registry interface" -icon: "plug" -description: "Registry API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Registry -## Signature - -```typescript -interface Registry extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/addComponent.mdx b/references/1.4.2/ecs-lib/Registry/addComponent.mdx deleted file mode 100644 index 938d691..0000000 --- a/references/1.4.2/ecs-lib/Registry/addComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "addComponent" -icon: "file" -description: "addComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# addComponent - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/addSystem.mdx b/references/1.4.2/ecs-lib/Registry/addSystem.mdx deleted file mode 100644 index 72af2a6..0000000 --- a/references/1.4.2/ecs-lib/Registry/addSystem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "addSystem" -icon: "file" -description: "addSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# addSystem - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/clearEntities.mdx b/references/1.4.2/ecs-lib/Registry/clearEntities.mdx deleted file mode 100644 index 9b5c9d6..0000000 --- a/references/1.4.2/ecs-lib/Registry/clearEntities.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clearEntities" -icon: "file" -description: "clearEntities API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clearEntities - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/clearSystems.mdx b/references/1.4.2/ecs-lib/Registry/clearSystems.mdx deleted file mode 100644 index 8e0053d..0000000 --- a/references/1.4.2/ecs-lib/Registry/clearSystems.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clearSystems" -icon: "file" -description: "clearSystems API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clearSystems - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/entityFromIndex.mdx b/references/1.4.2/ecs-lib/Registry/entityFromIndex.mdx deleted file mode 100644 index 5746a8c..0000000 --- a/references/1.4.2/ecs-lib/Registry/entityFromIndex.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "entityFromIndex" -icon: "file" -description: "entityFromIndex API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# entityFromIndex - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/getComponents.mdx b/references/1.4.2/ecs-lib/Registry/getComponents.mdx deleted file mode 100644 index 7e2eb0c..0000000 --- a/references/1.4.2/ecs-lib/Registry/getComponents.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getComponents" -icon: "file" -description: "getComponents API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponents - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/getComponentsConst.mdx b/references/1.4.2/ecs-lib/Registry/getComponentsConst.mdx deleted file mode 100644 index c0c5e75..0000000 --- a/references/1.4.2/ecs-lib/Registry/getComponentsConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getComponentsConst" -icon: "file" -description: "getComponentsConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getComponentsConst - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/getEntityComponent.mdx b/references/1.4.2/ecs-lib/Registry/getEntityComponent.mdx deleted file mode 100644 index 65648c3..0000000 --- a/references/1.4.2/ecs-lib/Registry/getEntityComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getEntityComponent" -icon: "file" -description: "getEntityComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getEntityComponent - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/getEntityComponentConst.mdx b/references/1.4.2/ecs-lib/Registry/getEntityComponentConst.mdx deleted file mode 100644 index de8259d..0000000 --- a/references/1.4.2/ecs-lib/Registry/getEntityComponentConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getEntityComponentConst" -icon: "file" -description: "getEntityComponentConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getEntityComponentConst - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/getIndexedZipper.mdx b/references/1.4.2/ecs-lib/Registry/getIndexedZipper.mdx deleted file mode 100644 index 8232fdb..0000000 --- a/references/1.4.2/ecs-lib/Registry/getIndexedZipper.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getIndexedZipper" -icon: "file" -description: "getIndexedZipper API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getIndexedZipper - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/getZipper.mdx b/references/1.4.2/ecs-lib/Registry/getZipper.mdx deleted file mode 100644 index f7a918c..0000000 --- a/references/1.4.2/ecs-lib/Registry/getZipper.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getZipper" -icon: "file" -description: "getZipper API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getZipper - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/killEntity.mdx b/references/1.4.2/ecs-lib/Registry/killEntity.mdx deleted file mode 100644 index 4979d97..0000000 --- a/references/1.4.2/ecs-lib/Registry/killEntity.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "killEntity" -icon: "file" -description: "killEntity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# killEntity - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/maxEntities.mdx b/references/1.4.2/ecs-lib/Registry/maxEntities.mdx deleted file mode 100644 index f1eb150..0000000 --- a/references/1.4.2/ecs-lib/Registry/maxEntities.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "maxEntities" -icon: "file" -description: "maxEntities API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# maxEntities - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/registerComponent.mdx b/references/1.4.2/ecs-lib/Registry/registerComponent.mdx deleted file mode 100644 index b0540e5..0000000 --- a/references/1.4.2/ecs-lib/Registry/registerComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "registerComponent" -icon: "file" -description: "registerComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# registerComponent - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/removeComponent.mdx b/references/1.4.2/ecs-lib/Registry/removeComponent.mdx deleted file mode 100644 index 0efa117..0000000 --- a/references/1.4.2/ecs-lib/Registry/removeComponent.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "removeComponent" -icon: "file" -description: "removeComponent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# removeComponent - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/removeSystem.mdx b/references/1.4.2/ecs-lib/Registry/removeSystem.mdx deleted file mode 100644 index fea7019..0000000 --- a/references/1.4.2/ecs-lib/Registry/removeSystem.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "removeSystem" -icon: "file" -description: "removeSystem API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# removeSystem - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/runSystems.mdx b/references/1.4.2/ecs-lib/Registry/runSystems.mdx deleted file mode 100644 index 4a391a1..0000000 --- a/references/1.4.2/ecs-lib/Registry/runSystems.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "runSystems" -icon: "file" -description: "runSystems API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# runSystems - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/Registry/spawnEntity.mdx b/references/1.4.2/ecs-lib/Registry/spawnEntity.mdx deleted file mode 100644 index 183b6f5..0000000 --- a/references/1.4.2/ecs-lib/Registry/spawnEntity.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "spawnEntity" -icon: "file" -description: "spawnEntity API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# spawnEntity - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray.mdx b/references/1.4.2/ecs-lib/SparseArray.mdx deleted file mode 100644 index 48d747f..0000000 --- a/references/1.4.2/ecs-lib/SparseArray.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "SparseArray interface" -icon: "plug" -description: "SparseArray API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SparseArray -## Signature - -```typescript -interface SparseArray extends ClassHandle -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/clear.mdx b/references/1.4.2/ecs-lib/SparseArray/clear.mdx deleted file mode 100644 index 782f12a..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/clear.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "clear" -icon: "file" -description: "clear API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# clear - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/empty.mdx b/references/1.4.2/ecs-lib/SparseArray/empty.mdx deleted file mode 100644 index 860f54e..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/empty.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "empty" -icon: "file" -description: "empty API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# empty - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/erase.mdx b/references/1.4.2/ecs-lib/SparseArray/erase.mdx deleted file mode 100644 index 289e964..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/erase.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "erase" -icon: "file" -description: "erase API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# erase - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/get.mdx b/references/1.4.2/ecs-lib/SparseArray/get.mdx deleted file mode 100644 index 18a25bc..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/get.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "get" -icon: "file" -description: "get API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# get - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/getConst.mdx b/references/1.4.2/ecs-lib/SparseArray/getConst.mdx deleted file mode 100644 index 3314654..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/getConst.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getConst" -icon: "file" -description: "getConst API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConst - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/getIndex.mdx b/references/1.4.2/ecs-lib/SparseArray/getIndex.mdx deleted file mode 100644 index e6a39d6..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/getIndex.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "getIndex" -icon: "file" -description: "getIndex API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getIndex - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/insertAt.mdx b/references/1.4.2/ecs-lib/SparseArray/insertAt.mdx deleted file mode 100644 index 9a5e08b..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/insertAt.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "insertAt" -icon: "file" -description: "insertAt API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# insertAt - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/insertAt_1.mdx b/references/1.4.2/ecs-lib/SparseArray/insertAt_1.mdx deleted file mode 100644 index 9a5e08b..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/insertAt_1.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "insertAt" -icon: "file" -description: "insertAt API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# insertAt - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/resize.mdx b/references/1.4.2/ecs-lib/SparseArray/resize.mdx deleted file mode 100644 index 6e14c19..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/resize.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "resize" -icon: "file" -description: "resize API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# resize - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/set.mdx b/references/1.4.2/ecs-lib/SparseArray/set.mdx deleted file mode 100644 index 008ca6e..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/set.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "set" -icon: "file" -description: "set API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# set - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/setByCopy.mdx b/references/1.4.2/ecs-lib/SparseArray/setByCopy.mdx deleted file mode 100644 index 0da1576..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/setByCopy.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "setByCopy" -icon: "file" -description: "setByCopy API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setByCopy - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/setByMove.mdx b/references/1.4.2/ecs-lib/SparseArray/setByMove.mdx deleted file mode 100644 index d6bb457..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/setByMove.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "setByMove" -icon: "file" -description: "setByMove API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# setByMove - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/SparseArray/size.mdx b/references/1.4.2/ecs-lib/SparseArray/size.mdx deleted file mode 100644 index c4186f7..0000000 --- a/references/1.4.2/ecs-lib/SparseArray/size.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "size" -icon: "file" -description: "size API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# size - -## Description \ No newline at end of file diff --git a/references/1.4.2/ecs-lib/System.mdx b/references/1.4.2/ecs-lib/System.mdx deleted file mode 100644 index b171106..0000000 --- a/references/1.4.2/ecs-lib/System.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "System type" -icon: "file-code" -description: "System API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# System -## Signature - -```typescript -type System = (registry: Registry, ctx: Context) => void; -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-server/0-index.mdx b/references/1.4.2/ecs-server/0-index.mdx deleted file mode 100644 index 7c57a23..0000000 --- a/references/1.4.2/ecs-server/0-index.mdx +++ /dev/null @@ -1,129 +0,0 @@ ---- -title: "Ecs Server" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/ecs-server` is a wrapper of `@nanoforge-dev/ecs-lib` for server-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/ecs-server -yarn add @nanoforge-dev/ecs-server -pnpm add @nanoforge-dev/ecs-server -bun add @nanoforge-dev/ecs-server -``` - -## Example usage - -Initialize the library in your main file. - -```ts -import { type IRunOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSServerLibrary } from "@nanoforge-dev/ecs-server"; - -export async function main(options: IRunServerOptions) { - const app = NanoforgeFactory.createServer(); - - const ecs = new ECSServerLibrary(); - - app.useComponentSystem(ecs); - - await app.init(options); - - const registry = ecs.registry; - - const entity = registry.spawnEntity(); - registry.addComponent(entity, new ExampleComponent("foo", 42)); - - registry.addSystem(exampleSystem); - - await app.run(); -} -``` - -With component - -```ts -export class ExampleComponent { - name = this.constructor.name; - - constructor( - public paramA: string, - public paramB: number, - public paramC: boolean = false, - ) {} - - get foo() { - return "bar"; - } - - get paramAOrDefault() { - return this.paramC ? this.paramA : "default"; - } - - addOne() { - this.paramB += 1; - } -} -``` - -And system - -```ts -export const exampleSystem = (registry: Registry, ctx: Context) => { - const entities = registry.getZipper([ExampleComponent]); - - entities.forEach((entity) => { - if (entity.ExampleComponent.paramA === "end") { - ctx.app.setIsRunning(false); - return; - } - - if (entity.ExampleComponent.paramB === 0) entity.ExampleComponent.paramA = "end"; - - if (entity.ExampleComponent.paramB >= 0) - entity.ExampleComponent.paramB = entity.ExampleComponent.paramB - 1; - }); -}; -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/ecs-server -[npm]: https://www.npmjs.com/package/@nanoforge-dev/ecs-server -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/ecs-server/ECSServerLibrary.mdx b/references/1.4.2/ecs-server/ECSServerLibrary.mdx deleted file mode 100644 index ae983c6..0000000 --- a/references/1.4.2/ecs-server/ECSServerLibrary.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "ECSServerLibrary class" -icon: "box" -description: "Server-side ECS library backed by the compiled WASM module." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ECSServerLibrary - -## Summary - -Server-side ECS library backed by the compiled WASM module. -## Signature - -```typescript -declare class ECSServerLibrary extends AbstractECSLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Remarks - - Loads `libecs.wasm` from the asset manager and initialises the entity registry. Register with the application: Access the registry in game code: \ No newline at end of file diff --git a/references/1.4.2/ecs-server/ECSServerLibrary/constructor.mdx b/references/1.4.2/ecs-server/ECSServerLibrary/constructor.mdx deleted file mode 100644 index ce0d21c..0000000 --- a/references/1.4.2/ecs-server/ECSServerLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the ECSServerLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `ECSServerLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.2/ecs-server/Module.mdx b/references/1.4.2/ecs-server/Module.mdx deleted file mode 100644 index ee8d98d..0000000 --- a/references/1.4.2/ecs-server/Module.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Module variable" -icon: "variable" -description: "Module API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Module -## Signature - -```typescript -Module: typeof MainModuleFactory -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/0-index.mdx b/references/1.4.2/graphics-2d/0-index.mdx deleted file mode 100644 index b0c8cd7..0000000 --- a/references/1.4.2/graphics-2d/0-index.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: "Graphics 2d" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/graphics-2d` is a base 2D graphics library. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/graphics-2d -yarn add @nanoforge-dev/graphics-2d -pnpm add @nanoforge-dev/graphics-2d -bun add @nanoforge-dev/graphics-2d -``` - -## Example usage - -Initialize the library in your main file with a red circle. - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { ECSClientLibrary } from "@nanoforge-dev/ecs-client"; -import { Circle, Graphics2DLibrary, Layer } from "@nanoforge-dev/graphics-2d"; - -import { CircleComponent } from "./components/CircleComponent"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const ecs = new ECSClientLibrary(); - const graphics = new Graphics2DLibrary(); - - app.useComponentSystem(ecs); - app.useGraphics(graphics); - - await app.init(options); - - const registry = ecs.registry; - - const layer = new Layer(); - graphics.stage.add(layer); - - const entity = registry.spawnEntity(); - registry.addComponent( - entity, - new CircleComponent( - new Circle({ - radius: 70, - fill: "red", - }), - layer, - ), - ); - - await app.run(); -} -``` - -With circle component defined. - -```ts -import { type Circle, type Layer } from "@nanoforge-dev/graphics-2d"; - -export class CircleComponent { - name = "CircleComponent"; - component: Circle; - - constructor(component: Circle, layer: Layer) { - this.component = component; - layer.add(this.component); - } -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/graphics-2d -[npm]: https://www.npmjs.com/package/@nanoforge-dev/graphics-2d -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/graphics-2d/Animation_2.mdx b/references/1.4.2/graphics-2d/Animation_2.mdx deleted file mode 100644 index ddfaad5..0000000 --- a/references/1.4.2/graphics-2d/Animation_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Animation_2 variable" -icon: "variable" -description: "Animation_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Animation_2 -## Signature - -```typescript -Animation: typeof import("konva/lib/Animation").Animation -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Arc.mdx b/references/1.4.2/graphics-2d/Arc.mdx deleted file mode 100644 index cddf460..0000000 --- a/references/1.4.2/graphics-2d/Arc.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Arc variable" -icon: "variable" -description: "Arc API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Arc -## Signature - -```typescript -Arc: typeof import("konva/lib/shapes/Arc").Arc -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/ArcConfig.mdx b/references/1.4.2/graphics-2d/ArcConfig.mdx deleted file mode 100644 index 54071ac..0000000 --- a/references/1.4.2/graphics-2d/ArcConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ArcConfig type" -icon: "file-code" -description: "ArcConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ArcConfig -## Signature - -```typescript -type ArcConfig = Konva.ArcConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Arrow.mdx b/references/1.4.2/graphics-2d/Arrow.mdx deleted file mode 100644 index 3dfb8ec..0000000 --- a/references/1.4.2/graphics-2d/Arrow.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Arrow variable" -icon: "variable" -description: "Arrow API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Arrow -## Signature - -```typescript -Arrow: typeof import("konva/lib/shapes/Arrow").Arrow -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/ArrowConfig.mdx b/references/1.4.2/graphics-2d/ArrowConfig.mdx deleted file mode 100644 index 140f1f8..0000000 --- a/references/1.4.2/graphics-2d/ArrowConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ArrowConfig type" -icon: "file-code" -description: "ArrowConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ArrowConfig -## Signature - -```typescript -type ArrowConfig = Konva.ArrowConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Canvas.mdx b/references/1.4.2/graphics-2d/Canvas.mdx deleted file mode 100644 index 592d424..0000000 --- a/references/1.4.2/graphics-2d/Canvas.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Canvas variable" -icon: "variable" -description: "Canvas API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Canvas -## Signature - -```typescript -Canvas: typeof import("konva/lib/Canvas").Canvas -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Circle.mdx b/references/1.4.2/graphics-2d/Circle.mdx deleted file mode 100644 index d3294b9..0000000 --- a/references/1.4.2/graphics-2d/Circle.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Circle variable" -icon: "variable" -description: "Circle API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Circle -## Signature - -```typescript -Circle: typeof import("konva/lib/shapes/Circle").Circle -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/CircleConfig.mdx b/references/1.4.2/graphics-2d/CircleConfig.mdx deleted file mode 100644 index 9167a16..0000000 --- a/references/1.4.2/graphics-2d/CircleConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "CircleConfig type" -icon: "file-code" -description: "CircleConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# CircleConfig -## Signature - -```typescript -type CircleConfig = Konva.CircleConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Container.mdx b/references/1.4.2/graphics-2d/Container.mdx deleted file mode 100644 index 2a95a85..0000000 --- a/references/1.4.2/graphics-2d/Container.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Container variable" -icon: "variable" -description: "Container API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Container -## Signature - -```typescript -Container: typeof import("konva/lib/Container").Container -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/ContainerConfig.mdx b/references/1.4.2/graphics-2d/ContainerConfig.mdx deleted file mode 100644 index a11d9c9..0000000 --- a/references/1.4.2/graphics-2d/ContainerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ContainerConfig type" -icon: "file-code" -description: "ContainerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ContainerConfig -## Signature - -```typescript -type ContainerConfig = Konva.ContainerConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Context.mdx b/references/1.4.2/graphics-2d/Context.mdx deleted file mode 100644 index cdb9dcd..0000000 --- a/references/1.4.2/graphics-2d/Context.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Context variable" -icon: "variable" -description: "Context API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Context -## Signature - -```typescript -Context: typeof import("konva/lib/Context").Context -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/DD.mdx b/references/1.4.2/graphics-2d/DD.mdx deleted file mode 100644 index 8983841..0000000 --- a/references/1.4.2/graphics-2d/DD.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "DD variable" -icon: "variable" -description: "DD API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# DD -## Signature - -```typescript -DD: { - readonly isDragging: boolean; - justDragged: boolean; - readonly node: import("konva/lib/Node").Node | undefined; - _dragElements: Map; - _drag(evt: any): void; - _endDragBefore(evt?: any): void; - _endDragAfter(evt: any): void; -} -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Easings.mdx b/references/1.4.2/graphics-2d/Easings.mdx deleted file mode 100644 index 5a6a492..0000000 --- a/references/1.4.2/graphics-2d/Easings.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "Easings variable" -icon: "variable" -description: "Easings API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Easings -## Signature - -```typescript -Easings: { - BackEaseIn(t: any, b: any, c: any, d: any): any; - BackEaseOut(t: any, b: any, c: any, d: any): any; - BackEaseInOut(t: any, b: any, c: any, d: any): any; - ElasticEaseIn(t: any, b: any, c: any, d: any, a: any, p: any): any; - ElasticEaseOut(t: any, b: any, c: any, d: any, a: any, p: any): any; - ElasticEaseInOut(t: any, b: any, c: any, d: any, a: any, p: any): any; - BounceEaseOut(t: any, b: any, c: any, d: any): any; - BounceEaseIn(t: any, b: any, c: any, d: any): any; - BounceEaseInOut(t: any, b: any, c: any, d: any): any; - EaseIn(t: any, b: any, c: any, d: any): any; - EaseOut(t: any, b: any, c: any, d: any): any; - EaseInOut(t: any, b: any, c: any, d: any): any; - StrongEaseIn(t: any, b: any, c: any, d: any): any; - StrongEaseOut(t: any, b: any, c: any, d: any): any; - StrongEaseInOut(t: any, b: any, c: any, d: any): any; - Linear(t: any, b: any, c: any, d: any): any; -} -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Ellipse.mdx b/references/1.4.2/graphics-2d/Ellipse.mdx deleted file mode 100644 index 96fe50c..0000000 --- a/references/1.4.2/graphics-2d/Ellipse.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Ellipse variable" -icon: "variable" -description: "Ellipse API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Ellipse -## Signature - -```typescript -Ellipse: typeof import("konva/lib/shapes/Ellipse").Ellipse -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/EllipseConfig.mdx b/references/1.4.2/graphics-2d/EllipseConfig.mdx deleted file mode 100644 index 3bf17e4..0000000 --- a/references/1.4.2/graphics-2d/EllipseConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "EllipseConfig type" -icon: "file-code" -description: "EllipseConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# EllipseConfig -## Signature - -```typescript -type EllipseConfig = Konva.EllipseConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/FastLayer.mdx b/references/1.4.2/graphics-2d/FastLayer.mdx deleted file mode 100644 index 58f0ee3..0000000 --- a/references/1.4.2/graphics-2d/FastLayer.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "FastLayer variable" -icon: "variable" -description: "FastLayer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# FastLayer -## Signature - -```typescript -FastLayer: typeof import("konva/lib/FastLayer").FastLayer -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Filters.mdx b/references/1.4.2/graphics-2d/Filters.mdx deleted file mode 100644 index 094d800..0000000 --- a/references/1.4.2/graphics-2d/Filters.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "Filters variable" -icon: "variable" -description: "Filters API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Filters -## Signature - -```typescript -Filters: { - Blur: import("konva/lib/Node").Filter; - Brightness: import("konva/lib/Node").Filter; - Brighten: import("konva/lib/Node").Filter; - Contrast: import("konva/lib/Node").Filter; - Emboss: import("konva/lib/Node").Filter; - Enhance: import("konva/lib/Node").Filter; - Grayscale: import("konva/lib/Node").Filter; - HSL: import("konva/lib/Node").Filter; - HSV: import("konva/lib/Node").Filter; - Invert: import("konva/lib/Node").Filter; - Kaleidoscope: import("konva/lib/Node").Filter; - Mask: import("konva/lib/Node").Filter; - Noise: import("konva/lib/Node").Filter; - Pixelate: import("konva/lib/Node").Filter; - Posterize: import("konva/lib/Node").Filter; - RGB: import("konva/lib/Node").Filter; - RGBA: import("konva/lib/Node").Filter; - Sepia: import("konva/lib/Node").Filter; - Solarize: import("konva/lib/Node").Filter; - Threshold: import("konva/lib/Node").Filter; -} -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Graphics2DLibrary.mdx b/references/1.4.2/graphics-2d/Graphics2DLibrary.mdx deleted file mode 100644 index 25ca61d..0000000 --- a/references/1.4.2/graphics-2d/Graphics2DLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "Graphics2DLibrary class" -icon: "box" -description: "Built-in 2D graphics library powered by \\Konva\\." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Graphics2DLibrary - -## Summary - -Built-in 2D graphics library powered by [Konva](https://konvajs.org/). -## Signature - -```typescript -declare class Graphics2DLibrary extends BaseGraphicsLibrary -``` - -## Properties - -### baseLayer -**Modifiers**: readonly -**Type**:`get baseLayer(): Layer;` - -The default Konva automatically added to the stage. - -### stage -**Modifiers**: readonly -**Type**:`get stage(): Stage;` - -The Konva that covers the container element. - -## Remarks - - Creates a full-window Konva `Stage` and a default `Layer` during initialisation. Game code interacts with the stage and layer directly to add shapes, images, and animations. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Graphics2DLibrary/baseLayer.mdx b/references/1.4.2/graphics-2d/Graphics2DLibrary/baseLayer.mdx deleted file mode 100644 index ee1d43e..0000000 --- a/references/1.4.2/graphics-2d/Graphics2DLibrary/baseLayer.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "baseLayer" -icon: "variable" -description: "The default Konva Layer automatically added to the stage." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# baseLayer - -## Summary - -The default Konva `Layer` automatically added to the stage. - -## Remarks - - Add shapes and nodes to this layer for them to appear on screen. \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Graphics2DLibrary/stage.mdx b/references/1.4.2/graphics-2d/Graphics2DLibrary/stage.mdx deleted file mode 100644 index 5459bea..0000000 --- a/references/1.4.2/graphics-2d/Graphics2DLibrary/stage.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "stage" -icon: "variable" -description: "The Konva Stage that covers the container element." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# stage - -## Summary - -The Konva `Stage` that covers the container element. - -## Remarks - - Initialised to the container's `offsetWidth` × `offsetHeight` dimensions. \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Group.mdx b/references/1.4.2/graphics-2d/Group.mdx deleted file mode 100644 index 94194fa..0000000 --- a/references/1.4.2/graphics-2d/Group.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Group variable" -icon: "variable" -description: "Group API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Group -## Signature - -```typescript -Group: typeof import("konva/lib/Group").Group -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/GroupConfig.mdx b/references/1.4.2/graphics-2d/GroupConfig.mdx deleted file mode 100644 index e92337a..0000000 --- a/references/1.4.2/graphics-2d/GroupConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "GroupConfig type" -icon: "file-code" -description: "GroupConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# GroupConfig -## Signature - -```typescript -type GroupConfig = Konva.GroupConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/ImageConfig.mdx b/references/1.4.2/graphics-2d/ImageConfig.mdx deleted file mode 100644 index 74c67ae..0000000 --- a/references/1.4.2/graphics-2d/ImageConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ImageConfig type" -icon: "file-code" -description: "ImageConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ImageConfig -## Signature - -```typescript -type ImageConfig = Konva.ImageConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Image_2.mdx b/references/1.4.2/graphics-2d/Image_2.mdx deleted file mode 100644 index bf8a296..0000000 --- a/references/1.4.2/graphics-2d/Image_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Image_2 variable" -icon: "variable" -description: "Image_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Image_2 -## Signature - -```typescript -Image: typeof import("konva/lib/shapes/Image").Image -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/KonvaEventListener.mdx b/references/1.4.2/graphics-2d/KonvaEventListener.mdx deleted file mode 100644 index f83cdd1..0000000 --- a/references/1.4.2/graphics-2d/KonvaEventListener.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaEventListener type" -icon: "file-code" -description: "KonvaEventListener API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaEventListener -## Signature - -```typescript -type KonvaEventListener = Konva.KonvaEventListener; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/KonvaEventObject.mdx b/references/1.4.2/graphics-2d/KonvaEventObject.mdx deleted file mode 100644 index 24c346c..0000000 --- a/references/1.4.2/graphics-2d/KonvaEventObject.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaEventObject type" -icon: "file-code" -description: "KonvaEventObject API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaEventObject -## Signature - -```typescript -type KonvaEventObject = Konva.KonvaEventObject; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/KonvaPointerEvent.mdx b/references/1.4.2/graphics-2d/KonvaPointerEvent.mdx deleted file mode 100644 index d52579e..0000000 --- a/references/1.4.2/graphics-2d/KonvaPointerEvent.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "KonvaPointerEvent type" -icon: "file-code" -description: "KonvaPointerEvent API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# KonvaPointerEvent -## Signature - -```typescript -type KonvaPointerEvent = Konva.KonvaPointerEvent; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Label.mdx b/references/1.4.2/graphics-2d/Label.mdx deleted file mode 100644 index b91d661..0000000 --- a/references/1.4.2/graphics-2d/Label.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Label variable" -icon: "variable" -description: "Label API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Label -## Signature - -```typescript -Label: typeof import("konva/lib/shapes/Label").Label -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/LabelConfig.mdx b/references/1.4.2/graphics-2d/LabelConfig.mdx deleted file mode 100644 index a5d1db5..0000000 --- a/references/1.4.2/graphics-2d/LabelConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LabelConfig type" -icon: "file-code" -description: "LabelConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LabelConfig -## Signature - -```typescript -type LabelConfig = Konva.LabelConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Layer.mdx b/references/1.4.2/graphics-2d/Layer.mdx deleted file mode 100644 index f0cbecc..0000000 --- a/references/1.4.2/graphics-2d/Layer.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Layer variable" -icon: "variable" -description: "Layer API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Layer -## Signature - -```typescript -Layer: typeof import("konva/lib/Layer").Layer -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/LayerConfig.mdx b/references/1.4.2/graphics-2d/LayerConfig.mdx deleted file mode 100644 index b6a810a..0000000 --- a/references/1.4.2/graphics-2d/LayerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LayerConfig type" -icon: "file-code" -description: "LayerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LayerConfig -## Signature - -```typescript -type LayerConfig = Konva.LayerConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Line.mdx b/references/1.4.2/graphics-2d/Line.mdx deleted file mode 100644 index 76b62aa..0000000 --- a/references/1.4.2/graphics-2d/Line.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Line variable" -icon: "variable" -description: "Line API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Line -## Signature - -```typescript -Line: typeof import("konva/lib/shapes/Line").Line -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/LineConfig.mdx b/references/1.4.2/graphics-2d/LineConfig.mdx deleted file mode 100644 index a475417..0000000 --- a/references/1.4.2/graphics-2d/LineConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "LineConfig type" -icon: "file-code" -description: "LineConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# LineConfig -## Signature - -```typescript -type LineConfig = Konva.LineConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/NodeConfig.mdx b/references/1.4.2/graphics-2d/NodeConfig.mdx deleted file mode 100644 index 164684e..0000000 --- a/references/1.4.2/graphics-2d/NodeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "NodeConfig type" -icon: "file-code" -description: "NodeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NodeConfig -## Signature - -```typescript -type NodeConfig = Konva.NodeConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Node_2.mdx b/references/1.4.2/graphics-2d/Node_2.mdx deleted file mode 100644 index cc2dab3..0000000 --- a/references/1.4.2/graphics-2d/Node_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Node_2 variable" -icon: "variable" -description: "Node_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Node_2 -## Signature - -```typescript -Node: typeof import("konva/lib/Node").Node -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Path.mdx b/references/1.4.2/graphics-2d/Path.mdx deleted file mode 100644 index 70ac7a1..0000000 --- a/references/1.4.2/graphics-2d/Path.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Path variable" -icon: "variable" -description: "Path API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Path -## Signature - -```typescript -Path: typeof import("konva/lib/shapes/Path").Path -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/PathConfig.mdx b/references/1.4.2/graphics-2d/PathConfig.mdx deleted file mode 100644 index 3f882ea..0000000 --- a/references/1.4.2/graphics-2d/PathConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "PathConfig type" -icon: "file-code" -description: "PathConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# PathConfig -## Signature - -```typescript -type PathConfig = Konva.PathConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Rect.mdx b/references/1.4.2/graphics-2d/Rect.mdx deleted file mode 100644 index e35794b..0000000 --- a/references/1.4.2/graphics-2d/Rect.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Rect variable" -icon: "variable" -description: "Rect API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Rect -## Signature - -```typescript -Rect: typeof import("konva/lib/shapes/Rect").Rect -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/RectConfig.mdx b/references/1.4.2/graphics-2d/RectConfig.mdx deleted file mode 100644 index d4c77fe..0000000 --- a/references/1.4.2/graphics-2d/RectConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RectConfig type" -icon: "file-code" -description: "RectConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RectConfig -## Signature - -```typescript -type RectConfig = Konva.RectConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/RegularPolygon.mdx b/references/1.4.2/graphics-2d/RegularPolygon.mdx deleted file mode 100644 index 9e94364..0000000 --- a/references/1.4.2/graphics-2d/RegularPolygon.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RegularPolygon variable" -icon: "variable" -description: "RegularPolygon API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RegularPolygon -## Signature - -```typescript -RegularPolygon: typeof import("konva/lib/shapes/RegularPolygon").RegularPolygon -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/RegularPolygonConfig.mdx b/references/1.4.2/graphics-2d/RegularPolygonConfig.mdx deleted file mode 100644 index 7eb0178..0000000 --- a/references/1.4.2/graphics-2d/RegularPolygonConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RegularPolygonConfig type" -icon: "file-code" -description: "RegularPolygonConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RegularPolygonConfig -## Signature - -```typescript -type RegularPolygonConfig = Konva.RegularPolygonConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Ring.mdx b/references/1.4.2/graphics-2d/Ring.mdx deleted file mode 100644 index 9b1d5e7..0000000 --- a/references/1.4.2/graphics-2d/Ring.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Ring variable" -icon: "variable" -description: "Ring API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Ring -## Signature - -```typescript -Ring: typeof import("konva/lib/shapes/Ring").Ring -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/RingConfig.mdx b/references/1.4.2/graphics-2d/RingConfig.mdx deleted file mode 100644 index c2d879c..0000000 --- a/references/1.4.2/graphics-2d/RingConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "RingConfig type" -icon: "file-code" -description: "RingConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# RingConfig -## Signature - -```typescript -type RingConfig = Konva.RingConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Shape.mdx b/references/1.4.2/graphics-2d/Shape.mdx deleted file mode 100644 index 327ffa8..0000000 --- a/references/1.4.2/graphics-2d/Shape.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Shape variable" -icon: "variable" -description: "Shape API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Shape -## Signature - -```typescript -Shape: typeof import("konva/lib/Shape").Shape -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/ShapeConfig.mdx b/references/1.4.2/graphics-2d/ShapeConfig.mdx deleted file mode 100644 index 0dbffd4..0000000 --- a/references/1.4.2/graphics-2d/ShapeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "ShapeConfig type" -icon: "file-code" -description: "ShapeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# ShapeConfig -## Signature - -```typescript -type ShapeConfig = Konva.ShapeConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Sprite.mdx b/references/1.4.2/graphics-2d/Sprite.mdx deleted file mode 100644 index b18d1db..0000000 --- a/references/1.4.2/graphics-2d/Sprite.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Sprite variable" -icon: "variable" -description: "Sprite API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Sprite -## Signature - -```typescript -Sprite: typeof import("konva/lib/shapes/Sprite").Sprite -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/SpriteConfig.mdx b/references/1.4.2/graphics-2d/SpriteConfig.mdx deleted file mode 100644 index 5897d55..0000000 --- a/references/1.4.2/graphics-2d/SpriteConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "SpriteConfig type" -icon: "file-code" -description: "SpriteConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SpriteConfig -## Signature - -```typescript -type SpriteConfig = Konva.SpriteConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Stage.mdx b/references/1.4.2/graphics-2d/Stage.mdx deleted file mode 100644 index cd1c1df..0000000 --- a/references/1.4.2/graphics-2d/Stage.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Stage variable" -icon: "variable" -description: "Stage API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Stage -## Signature - -```typescript -Stage: typeof import("konva/lib/Stage").Stage -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/StageConfig.mdx b/references/1.4.2/graphics-2d/StageConfig.mdx deleted file mode 100644 index c2105e1..0000000 --- a/references/1.4.2/graphics-2d/StageConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "StageConfig type" -icon: "file-code" -description: "StageConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# StageConfig -## Signature - -```typescript -type StageConfig = Konva.StageConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Star.mdx b/references/1.4.2/graphics-2d/Star.mdx deleted file mode 100644 index 411028f..0000000 --- a/references/1.4.2/graphics-2d/Star.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Star variable" -icon: "variable" -description: "Star API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Star -## Signature - -```typescript -Star: typeof import("konva/lib/shapes/Star").Star -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/StarConfig.mdx b/references/1.4.2/graphics-2d/StarConfig.mdx deleted file mode 100644 index 8d2636b..0000000 --- a/references/1.4.2/graphics-2d/StarConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "StarConfig type" -icon: "file-code" -description: "StarConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# StarConfig -## Signature - -```typescript -type StarConfig = Konva.StarConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Tag.mdx b/references/1.4.2/graphics-2d/Tag.mdx deleted file mode 100644 index 24c03f4..0000000 --- a/references/1.4.2/graphics-2d/Tag.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Tag variable" -icon: "variable" -description: "Tag API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Tag -## Signature - -```typescript -Tag: typeof import("konva/lib/shapes/Label").Tag -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/TagConfig.mdx b/references/1.4.2/graphics-2d/TagConfig.mdx deleted file mode 100644 index 21aba79..0000000 --- a/references/1.4.2/graphics-2d/TagConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TagConfig type" -icon: "file-code" -description: "TagConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TagConfig -## Signature - -```typescript -type TagConfig = Konva.TagConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/TextConfig.mdx b/references/1.4.2/graphics-2d/TextConfig.mdx deleted file mode 100644 index 83d8699..0000000 --- a/references/1.4.2/graphics-2d/TextConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextConfig type" -icon: "file-code" -description: "TextConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextConfig -## Signature - -```typescript -type TextConfig = Konva.TextConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/TextPath.mdx b/references/1.4.2/graphics-2d/TextPath.mdx deleted file mode 100644 index 6864b49..0000000 --- a/references/1.4.2/graphics-2d/TextPath.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextPath variable" -icon: "variable" -description: "TextPath API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextPath -## Signature - -```typescript -TextPath: typeof import("konva/lib/shapes/TextPath").TextPath -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/TextPathConfig.mdx b/references/1.4.2/graphics-2d/TextPathConfig.mdx deleted file mode 100644 index 8fd12d5..0000000 --- a/references/1.4.2/graphics-2d/TextPathConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TextPathConfig type" -icon: "file-code" -description: "TextPathConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TextPathConfig -## Signature - -```typescript -type TextPathConfig = Konva.TextPathConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Text_2.mdx b/references/1.4.2/graphics-2d/Text_2.mdx deleted file mode 100644 index 6d6f2ce..0000000 --- a/references/1.4.2/graphics-2d/Text_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Text_2 variable" -icon: "variable" -description: "Text_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Text_2 -## Signature - -```typescript -Text: typeof import("konva/lib/shapes/Text").Text -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Transform.mdx b/references/1.4.2/graphics-2d/Transform.mdx deleted file mode 100644 index 3986d65..0000000 --- a/references/1.4.2/graphics-2d/Transform.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Transform variable" -icon: "variable" -description: "Transform API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Transform -## Signature - -```typescript -Transform: typeof import("konva/lib/Util").Transform -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/TransformerConfig.mdx b/references/1.4.2/graphics-2d/TransformerConfig.mdx deleted file mode 100644 index 2b3334a..0000000 --- a/references/1.4.2/graphics-2d/TransformerConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TransformerConfig type" -icon: "file-code" -description: "TransformerConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TransformerConfig -## Signature - -```typescript -type TransformerConfig = Konva.TransformerConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Transformer_2.mdx b/references/1.4.2/graphics-2d/Transformer_2.mdx deleted file mode 100644 index a676e31..0000000 --- a/references/1.4.2/graphics-2d/Transformer_2.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Transformer_2 variable" -icon: "variable" -description: "Transformer_2 API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Transformer_2 -## Signature - -```typescript -Transformer: typeof import("konva/lib/shapes/Transformer").Transformer -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Tween.mdx b/references/1.4.2/graphics-2d/Tween.mdx deleted file mode 100644 index 25c1ada..0000000 --- a/references/1.4.2/graphics-2d/Tween.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Tween variable" -icon: "variable" -description: "Tween API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Tween -## Signature - -```typescript -Tween: typeof import("konva/lib/Tween").Tween -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/TweenConfig.mdx b/references/1.4.2/graphics-2d/TweenConfig.mdx deleted file mode 100644 index ed4ae96..0000000 --- a/references/1.4.2/graphics-2d/TweenConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "TweenConfig type" -icon: "file-code" -description: "TweenConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TweenConfig -## Signature - -```typescript -type TweenConfig = Konva.TweenConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Util.mdx b/references/1.4.2/graphics-2d/Util.mdx deleted file mode 100644 index 4d6d059..0000000 --- a/references/1.4.2/graphics-2d/Util.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Util variable" -icon: "variable" -description: "Util API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Util -## Signature - -```typescript -Util: { - _isElement(obj: any): obj is Element; - _isFunction(obj: any): boolean; - _isPlainObject(obj: any): boolean; - _isArray(obj: any): obj is Array; - _isNumber(obj: any): obj is number; - _isString(obj: any): obj is string; - _isBoolean(obj: any): obj is boolean; - isObject(val: any): val is object; - isValidSelector(selector: any): boolean; - _sign(number: number): 1 | -1; - requestAnimFrame(callback: Function): void; - createCanvasElement(): HTMLCanvasElement; - createImageElement(): HTMLImageElement; - _isInDocument(el: any): boolean; - _urlToImage(url: string, callback: Function): void; - _rgbToHex(r: number, g: number, b: number): string; - _hexToRgb(hex: string): import("konva/lib/types").RGB; - getRandomColor(): string; - isCanvasFarblingActive(): boolean; - getHitColor(): string; - getHitColorKey(r: number, g: number, b: number): string; - getSnappedHexColor(hex: string): string; - getRGB(color: string): import("konva/lib/types").RGB; - colorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _namedColorToRBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | null; - _rgbColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _rgbaColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex8ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex6ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex4ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hex3ColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - _hslColorToRGBA(str: string): { - r: number; - g: number; - b: number; - a: number; - } | undefined; - haveIntersection(r1: import("konva/lib/types").IRect, r2: import("konva/lib/types").IRect): boolean; - cloneObject(obj: Any): Any; - cloneArray(arr: Array): any[]; - degToRad(deg: number): number; - radToDeg(rad: number): number; - _degToRad(deg: number): number; - _radToDeg(rad: number): number; - _getRotation(radians: number): number; - _capitalize(str: string): string; - throw(str: string): never; - error(str: string): void; - warn(str: string): void; - each(obj: object, func: Function): void; - _inRange(val: number, left: number, right: number): boolean; - _getProjectionToSegment(x1: any, y1: any, x2: any, y2: any, x3: any, y3: any): any[]; - _getProjectionToLine(pt: import("konva/lib/types").Vector2d, line: Array, isClosed: boolean): import("konva/lib/types").Vector2d; - _prepareArrayForTween(startArray: any, endArray: any, isClosed: any): number[]; - _prepareToStringify(obj: any): T | null; - _assign(target: T, source: U): T & U; - _getFirstPointerId(evt: any): any; - releaseCanvas(...canvases: HTMLCanvasElement[]): void; - drawRoundedRectPath(context: import("konva/lib/Context").Context, width: number, height: number, cornerRadius: number | number[]): void; - drawRoundedPolygonPath(context: import("konva/lib/Context").Context, points: import("konva/lib/types").Vector2d[], sides: number, radius: number, cornerRadius: number | number[]): void; -} -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Vector2d.mdx b/references/1.4.2/graphics-2d/Vector2d.mdx deleted file mode 100644 index 4e2e07d..0000000 --- a/references/1.4.2/graphics-2d/Vector2d.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Vector2d type" -icon: "file-code" -description: "Vector2d API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Vector2d -## Signature - -```typescript -type Vector2d = Konva.Vector2d; -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/Wedge.mdx b/references/1.4.2/graphics-2d/Wedge.mdx deleted file mode 100644 index 6083fc3..0000000 --- a/references/1.4.2/graphics-2d/Wedge.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "Wedge variable" -icon: "variable" -description: "Wedge API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# Wedge -## Signature - -```typescript -Wedge: typeof import("konva/lib/shapes/Wedge").Wedge -``` \ No newline at end of file diff --git a/references/1.4.2/graphics-2d/WedgeConfig.mdx b/references/1.4.2/graphics-2d/WedgeConfig.mdx deleted file mode 100644 index 8d8e8b9..0000000 --- a/references/1.4.2/graphics-2d/WedgeConfig.mdx +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: "WedgeConfig type" -icon: "file-code" -description: "WedgeConfig API documentation" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# WedgeConfig -## Signature - -```typescript -type WedgeConfig = Konva.WedgeConfig; -``` \ No newline at end of file diff --git a/references/1.4.2/input/0-index.mdx b/references/1.4.2/input/0-index.mdx deleted file mode 100644 index 78e9f6d..0000000 --- a/references/1.4.2/input/0-index.mdx +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Input" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/input` is an input manager for handling keyboard and mouse events. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/input -yarn add @nanoforge-dev/input -pnpm add @nanoforge-dev/input -bun add @nanoforge-dev/input -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { InputLibrary } from "@nanoforge-dev/input"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const input = new InputLibrary(); - - app.useInput(input); - - await app.init(options); - - await app.run(); -} -``` - -Use to check for key presses - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const input = ctx.libs.getInput(); - - const isArrowUpPressed = input.isKeyPressed(InputEnum.ArrowUp); - - // Do something with the input -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/input -[npm]: https://www.npmjs.com/package/@nanoforge-dev/input -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/input/InputEnum.mdx b/references/1.4.2/input/InputEnum.mdx deleted file mode 100644 index 3f4cba1..0000000 --- a/references/1.4.2/input/InputEnum.mdx +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: "InputEnum enum" -icon: "list" -description: "Enumeration of keyboard keys and mouse buttons supported by InputLibrary." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InputEnum - -## Summary - -Enumeration of keyboard keys and mouse buttons supported by `InputLibrary`. - -## Members -| Member | Description | -| ------ | ----------- | -| `AltLeft` | | -| `AltRight` | | -| `ArrowDown` | | -| `ArrowLeft` | | -| `ArrowRight` | | -| `ArrowUp` | | -| `AudioVolumeMute` | | -| `Back` | | -| `Backquote` | | -| `Backslash` | | -| `Backspace` | | -| `BracketLeft` | | -| `BracketRight` | | -| `BrowserBack` | | -| `BrowserFavorites` | | -| `BrowserForward` | | -| `BrowserHome` | | -| `BrowserRefresh` | | -| `BrowserSearch` | | -| `BrowserStop` | | -| `CapsLock` | | -| `Comma` | | -| `ContextMenu` | | -| `ControlLeft` | | -| `ControlRight` | | -| `Convert` | | -| `Delete` | | -| `Digit0` | | -| `Digit1` | | -| `Digit2` | | -| `Digit3` | | -| `Digit4` | | -| `Digit5` | | -| `Digit6` | | -| `Digit7` | | -| `Digit8` | | -| `Digit9` | | -| `End` | | -| `Enter` | | -| `Equal` | | -| `Escape` | | -| `F1` | | -| `F10` | | -| `F11` | | -| `F12` | | -| `F13` | | -| `F14` | | -| `F15` | | -| `F16` | | -| `F17` | | -| `F18` | | -| `F19` | | -| `F2` | | -| `F20` | | -| `F21` | | -| `F22` | | -| `F23` | | -| `F24` | | -| `F3` | | -| `F4` | | -| `F5` | | -| `F6` | | -| `F7` | | -| `F8` | | -| `F9` | | -| `Forward` | | -| `Home` | | -| `Insert` | | -| `IntlBackslash` | | -| `IntlRo` | | -| `IntlYen` | | -| `KanaMode` | | -| `KeyA` | | -| `KeyB` | | -| `KeyC` | | -| `KeyD` | | -| `KeyE` | | -| `KeyF` | | -| `KeyG` | | -| `KeyH` | | -| `KeyI` | | -| `KeyJ` | | -| `KeyK` | | -| `KeyL` | | -| `KeyM` | | -| `KeyN` | | -| `KeyO` | | -| `KeyP` | | -| `KeyQ` | | -| `KeyR` | | -| `KeyS` | | -| `KeyT` | | -| `KeyU` | | -| `KeyV` | | -| `KeyW` | | -| `KeyX` | | -| `KeyY` | | -| `KeyZ` | | -| `Lang1` | | -| `Lang2` | | -| `LaunchApp1` | | -| `LaunchApp2` | | -| `LaunchMail` | | -| `MediaPlayPause` | | -| `MediaStop` | | -| `MediaTrackNext` | | -| `MediaTrackPrevious` | | -| `MetaLeft` | | -| `MetaRight` | | -| `Minus` | | -| `MouseLeft` | | -| `MouseMiddle` | | -| `MouseRight` | | -| `NonConvert` | | -| `NumLock` | | -| `Numpad0` | | -| `Numpad1` | | -| `Numpad2` | | -| `Numpad3` | | -| `Numpad4` | | -| `Numpad5` | | -| `Numpad6` | | -| `Numpad7` | | -| `Numpad8` | | -| `Numpad9` | | -| `NumpadAdd` | | -| `NumpadComma` | | -| `NumpadDecimal` | | -| `NumpadDivide` | | -| `NumpadEnter` | | -| `NumpadEqual` | | -| `NumpadMultiply` | | -| `NumpadSubtract` | | -| `PageDown` | | -| `PageUp` | | -| `Pause` | | -| `Period` | | -| `Power` | | -| `PrintScreen` | | -| `Quote` | | -| `ScrollLock` | | -| `Semicolon` | | -| `ShiftLeft` | | -| `ShiftRight` | | -| `Slash` | | -| `Space` | | -| `Tab` | | - -## Remarks - - Values correspond to the `KeyboardEvent.code` string for keyboard keys and to synthetic button identifiers for mouse buttons. Use with `InputLibrary.isKeyPressed` and `InputLibrary.isDragging`. - -## Examples - -### Example 1 - -```typescript - -``` \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary.mdx b/references/1.4.2/input/InputLibrary.mdx deleted file mode 100644 index 5f59d81..0000000 --- a/references/1.4.2/input/InputLibrary.mdx +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: "InputLibrary class" -icon: "box" -description: "Built-in input library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# InputLibrary - -## Summary - -Built-in input library. -## Signature - -```typescript -declare class InputLibrary extends BaseInputLibrary -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getDragState - -Return the current drag state. - -### getMousePosition - -Return the current mouse cursor position. - -### getMouseState - -Return the full mouse state snapshot for the current frame. - -### getPressedKeys - -Return a list of all keys and mouse buttons that are currently pressed. - -### getWheelState - -Return the scroll-wheel state accumulated during the current frame. - -### isDragging - -Return whether a drag operation is in progress. - -### isKeyPressed - -Return whether a key or mouse button is currently held down. - -## Remarks - - Listens to browser `keydown`, `keyup`, `mousedown`, `mouseup`, `mousemove`, and `wheel` events and exposes a per-frame snapshot of the current input state. Must be registered after the graphics library because it uses `runAfter: [GRAPHICS_LIBRARY]`. Register with the application: Access in a system's `__run` hook: \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary/constructor.mdx b/references/1.4.2/input/InputLibrary/constructor.mdx deleted file mode 100644 index 5182682..0000000 --- a/references/1.4.2/input/InputLibrary/constructor.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the InputLibrary class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `InputLibrary` class -## Signature - -```typescript -constructor(); -``` \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary/getDragState.mdx b/references/1.4.2/input/InputLibrary/getDragState.mdx deleted file mode 100644 index 22815ac..0000000 --- a/references/1.4.2/input/InputLibrary/getDragState.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getDragState" -icon: "function" -description: "Return the current drag state." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getDragState - -## Summary - -Return the current drag state. -## Signature - -```typescript -getDragState(): DragState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`DragState` - -Return the current drag state. \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary/getMousePosition.mdx b/references/1.4.2/input/InputLibrary/getMousePosition.mdx deleted file mode 100644 index 11f70d7..0000000 --- a/references/1.4.2/input/InputLibrary/getMousePosition.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "getMousePosition" -icon: "function" -description: "Return the current mouse cursor position." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMousePosition - -## Summary - -Return the current mouse cursor position. -## Signature - -```typescript -getMousePosition(): { - x: number; - y: number; - }; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**: - -```typescript -{ - x: number; - y: number; - } -``` - - -Return the current mouse cursor position. \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary/getMouseState.mdx b/references/1.4.2/input/InputLibrary/getMouseState.mdx deleted file mode 100644 index 32127b9..0000000 --- a/references/1.4.2/input/InputLibrary/getMouseState.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getMouseState" -icon: "function" -description: "Return the full mouse state snapshot for the current frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getMouseState - -## Summary - -Return the full mouse state snapshot for the current frame. -## Signature - -```typescript -getMouseState(): MouseState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`MouseState` - -Return the full mouse state snapshot for the current frame. \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary/getPressedKeys.mdx b/references/1.4.2/input/InputLibrary/getPressedKeys.mdx deleted file mode 100644 index 4f3d1d6..0000000 --- a/references/1.4.2/input/InputLibrary/getPressedKeys.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getPressedKeys" -icon: "function" -description: "Return a list of all keys and mouse buttons that are currently pressed." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getPressedKeys - -## Summary - -Return a list of all keys and mouse buttons that are currently pressed. -## Signature - -```typescript -getPressedKeys(): InputEnum[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`InputEnum[]` - -Return a list of all keys and mouse buttons that are currently pressed. \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary/getWheelState.mdx b/references/1.4.2/input/InputLibrary/getWheelState.mdx deleted file mode 100644 index 6d68d7c..0000000 --- a/references/1.4.2/input/InputLibrary/getWheelState.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getWheelState" -icon: "function" -description: "Return the scroll-wheel state accumulated during the current frame." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getWheelState - -## Summary - -Return the scroll-wheel state accumulated during the current frame. -## Signature - -```typescript -getWheelState(): WheelState; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`WheelState` - -Return the scroll-wheel state accumulated during the current frame. - -## Remarks - - All deltas are reset to `0` at the start of the next frame. \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary/isDragging.mdx b/references/1.4.2/input/InputLibrary/isDragging.mdx deleted file mode 100644 index 7315313..0000000 --- a/references/1.4.2/input/InputLibrary/isDragging.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "isDragging" -icon: "function" -description: "Return whether a drag operation is in progress." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isDragging - -## Summary - -Return whether a drag operation is in progress. -## Signature - -```typescript -isDragging(button?: InputEnum): boolean; -``` - -## Parameters - -### button -**Type**:`InputEnum` -**Optional**: Yes - -If provided, only returns true when a drag was started with this specific button. - -## Returns - -**Type**:`boolean` - -Return whether a drag operation is in progress. \ No newline at end of file diff --git a/references/1.4.2/input/InputLibrary/isKeyPressed.mdx b/references/1.4.2/input/InputLibrary/isKeyPressed.mdx deleted file mode 100644 index 85eb226..0000000 --- a/references/1.4.2/input/InputLibrary/isKeyPressed.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "isKeyPressed" -icon: "function" -description: "Return whether a key or mouse button is currently held down." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isKeyPressed - -## Summary - -Return whether a key or mouse button is currently held down. -## Signature - -```typescript -isKeyPressed(key: InputEnum): boolean | undefined; -``` - -## Parameters - -### key -**Type**:`InputEnum` - -The key or button to query (see InputEnum). - -## Returns - -**Type**:`boolean | undefined` - -Return whether a key or mouse button is currently held down. \ No newline at end of file diff --git a/references/1.4.2/music/0-index.mdx b/references/1.4.2/music/0-index.mdx deleted file mode 100644 index c76aa73..0000000 --- a/references/1.4.2/music/0-index.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "Music" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/music` is a music player for your game. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/music -yarn add @nanoforge-dev/music -pnpm add @nanoforge-dev/music -bun add @nanoforge-dev/music -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { MusicLibrary } from "@nanoforge-dev/music"; - -export const MUSIC_SYM = Symbol("music"); - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const assetManager = new AssetManagerLibrary(); - const music = new MusicLibrary(); - - app.useAssetManager(assetManager); - app.use(MUSIC_SYM, music); - - await app.init(options); - - music.load("music", assetManager.getAsset("/path/to/music.mp3").path); - - await app.run(); -} -``` - -Use to play music - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - const music = ctx.libs.get(MUSIC_SYM); - - music.play("music"); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/music -[npm]: https://www.npmjs.com/package/@nanoforge-dev/music -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/music/MusicLibrary.mdx b/references/1.4.2/music/MusicLibrary.mdx deleted file mode 100644 index ee8ccc9..0000000 --- a/references/1.4.2/music/MusicLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "MusicLibrary class" -icon: "box" -description: "Built-in music library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# MusicLibrary - -## Summary - -Built-in music library. -## Signature - -```typescript -declare class MusicLibrary extends BaseMusicLibrary -``` - -## Methods - -### load - -Register a music track under a unique key. - -### mute - -Toggle the muted state of all loaded music tracks. - -### play - -Stop the currently playing track and start the requested one. - -## Remarks - - Manages a collection of named `HTMLAudioElement` instances and ensures only one track plays at a time. Load tracks with `load` and start playback with `play`. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.2/music/MusicLibrary/load.mdx b/references/1.4.2/music/MusicLibrary/load.mdx deleted file mode 100644 index 9d2bba2..0000000 --- a/references/1.4.2/music/MusicLibrary/load.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "load" -icon: "function" -description: "Register a music track under a unique key." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# load - -## Summary - -Register a music track under a unique key. -## Signature - -```typescript -load(music: string, file: string): void; -``` - -## Parameters - -### music -**Type**:`string` - -Unique key used to reference this track (e.g. "theme"). - -### file -**Type**:`string` - -URL or path to the audio file. - -## Returns - -**Type**:`void` - -Register a music track under a unique key. - -## Remarks - - Creates an `HTMLAudioElement` from the provided URL. The track respects the current muted state at load time. \ No newline at end of file diff --git a/references/1.4.2/music/MusicLibrary/mute.mdx b/references/1.4.2/music/MusicLibrary/mute.mdx deleted file mode 100644 index 982880b..0000000 --- a/references/1.4.2/music/MusicLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded music tracks." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded music tracks. -## Signature - -```typescript -mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded music tracks. \ No newline at end of file diff --git a/references/1.4.2/music/MusicLibrary/play.mdx b/references/1.4.2/music/MusicLibrary/play.mdx deleted file mode 100644 index 441f600..0000000 --- a/references/1.4.2/music/MusicLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Stop the currently playing track and start the requested one." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Stop the currently playing track and start the requested one. -## Signature - -```typescript -play(music: string): void; -``` - -## Parameters - -### music -**Type**:`string` - -Key that identifies the track (as passed to load). - -## Returns - -**Type**:`void` - -Stop the currently playing track and start the requested one. \ No newline at end of file diff --git a/references/1.4.2/network-client/0-index.mdx b/references/1.4.2/network-client/0-index.mdx deleted file mode 100644 index 3b234ab..0000000 --- a/references/1.4.2/network-client/0-index.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: "Network Client" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/network-client` is a network lib with tcp and udp support for client-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/network-client -yarn add @nanoforge-dev/network-client -pnpm add @nanoforge-dev/network-client -bun add @nanoforge-dev/network-client -``` - -## Example usage - -Initilize the library in your main file. - -```ts -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkClientLibrary } from "@nanoforge-dev/network-client"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const network = new NetworkClientLibrary(); - - app.useNetwork(network); - - await app.init(options); - - await app.run(); -} -``` - -Use to receive packets - -```ts -export function myReceiveSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - network.tcp.getReceivedPackets().forEach((packet) => { - const data = JSON.parse(new TextDecoder().decode(packet)); - // Do something with the data - }); -} -``` - -Use to send packets - -```ts -export function mySendSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - // Do something to get a data - const packet = new TextEncoder().encode(JSON.stringify(data)); - network.tcp.sendPacket(packet); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-client -[npm]: https://www.npmjs.com/package/@nanoforge-dev/network-client -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/network-client/NetworkClientLibrary.mdx b/references/1.4.2/network-client/NetworkClientLibrary.mdx deleted file mode 100644 index f37e2d1..0000000 --- a/references/1.4.2/network-client/NetworkClientLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "NetworkClientLibrary class" -icon: "box" -description: "Built-in network library for client-side applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NetworkClientLibrary - -## Summary - -Built-in network library for client-side applications. -## Signature - -```typescript -declare class NetworkClientLibrary extends BaseNetworkLibrary -``` - -## Properties - -### tcp -**Type**:`tcp: TCPClient;` - -Reliable, ordered WebSocket-based connection to the server. - -### udp -**Type**:`udp: UDPClient;` - -Unreliable, unordered WebRTC data-channel connection to the server. - -## Remarks - - Reads network configuration from the environment via `ClientConfigNetwork` and automatically connects to the server over TCP (WebSocket), UDP (WebRTC data channel), or both. Register with: Configuration (via environment variables): - `SERVER_ADDRESS` — hostname or IP of the server (required). - `SERVER_TCP_PORT` — WebSocket port for TCP (optional). - `SERVER_UDP_PORT` — signaling port for UDP/WebRTC (optional). - `MAGIC_VALUE` — packet framing delimiter (default: `"PACKET_END"`). - `WSS` — set to `"true"` to use `wss://` / `https://` (default: `false`). After `init`, access the connections via `tcp` and `udp`. \ No newline at end of file diff --git a/references/1.4.2/network-client/NetworkClientLibrary/tcp.mdx b/references/1.4.2/network-client/NetworkClientLibrary/tcp.mdx deleted file mode 100644 index b681439..0000000 --- a/references/1.4.2/network-client/NetworkClientLibrary/tcp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "tcp" -icon: "variable" -description: "Reliable, ordered WebSocket-based connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# tcp - -## Summary - -Reliable, ordered WebSocket-based connection to the server. - -## Remarks - - Only available when `SERVER_TCP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.2/network-client/NetworkClientLibrary/udp.mdx b/references/1.4.2/network-client/NetworkClientLibrary/udp.mdx deleted file mode 100644 index 234baaf..0000000 --- a/references/1.4.2/network-client/NetworkClientLibrary/udp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "udp" -icon: "variable" -description: "Unreliable, unordered WebRTC data-channel connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# udp - -## Summary - -Unreliable, unordered WebRTC data-channel connection to the server. - -## Remarks - - Only available when `SERVER_UDP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.2/network-client/TCPClient.mdx b/references/1.4.2/network-client/TCPClient.mdx deleted file mode 100644 index 15ab23e..0000000 --- a/references/1.4.2/network-client/TCPClient.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "TCPClient class" -icon: "box" -description: "Reliable, ordered WebSocket-based client connection to a NanoForge TCP server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TCPClient - -## Summary - -Reliable, ordered WebSocket-based client connection to a NanoForge TCP server. -## Signature - -```typescript -declare class TCPClient -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### connect - -Initiate a WebSocket connection to the server. - -### getReceivedPackets - -Parse and return all complete packets received since the last call. - -### isConnected - -Return when the underlying WebSocket is open. - -### sendData - -Send a payload to the server. - -## Remarks - - Packets are framed with a configurable magic delimiter so that partial WebSocket frames can be reassembled. The connection is established by calling `connect` and status can be queried with `isConnected`. Typical usage is through `NetworkClientLibrary` which instantiates and connects this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.2/network-client/TCPClient/connect.mdx b/references/1.4.2/network-client/TCPClient/connect.mdx deleted file mode 100644 index 895e5f5..0000000 --- a/references/1.4.2/network-client/TCPClient/connect.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "connect" -icon: "function" -description: "Initiate a WebSocket connection to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# connect - -## Summary - -Initiate a WebSocket connection to the server. -## Signature - -```typescript -connect(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Initiate a WebSocket connection to the server. - -## Remarks - - Connects to `ws[s]://:`. Resolves as soon as the connection attempt is dispatched (the socket may not be fully open yet — check `isConnected`). \ No newline at end of file diff --git a/references/1.4.2/network-client/TCPClient/constructor.mdx b/references/1.4.2/network-client/TCPClient/constructor.mdx deleted file mode 100644 index f12435d..0000000 --- a/references/1.4.2/network-client/TCPClient/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the TCPClient class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `TCPClient` class -## Signature - -```typescript -constructor(_port: number, _ip: string, magicValue: string, _wss: boolean); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _ip -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _wss -- **Type**:`boolean` \ No newline at end of file diff --git a/references/1.4.2/network-client/TCPClient/getReceivedPackets.mdx b/references/1.4.2/network-client/TCPClient/getReceivedPackets.mdx deleted file mode 100644 index 01155c8..0000000 --- a/references/1.4.2/network-client/TCPClient/getReceivedPackets.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return all complete packets received since the last call." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return all complete packets received since the last call. -## Signature - -```typescript -getReceivedPackets(): Uint8Array[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Uint8Array[]` - -Parse and return all complete packets received since the last call. - -## Remarks - - Partial packets are retained internally and combined with future chunks until they are complete. Call this method once per frame. \ No newline at end of file diff --git a/references/1.4.2/network-client/TCPClient/isConnected.mdx b/references/1.4.2/network-client/TCPClient/isConnected.mdx deleted file mode 100644 index 30d6bd7..0000000 --- a/references/1.4.2/network-client/TCPClient/isConnected.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isConnected" -icon: "function" -description: "Return true when the underlying WebSocket is open." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isConnected - -## Summary - -Return `true` when the underlying WebSocket is open. -## Signature - -```typescript -isConnected(): boolean; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`boolean` - -Return when the underlying WebSocket is open. \ No newline at end of file diff --git a/references/1.4.2/network-client/TCPClient/sendData.mdx b/references/1.4.2/network-client/TCPClient/sendData.mdx deleted file mode 100644 index da18065..0000000 --- a/references/1.4.2/network-client/TCPClient/sendData.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "sendData" -icon: "function" -description: "Send a payload to the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendData - -## Summary - -Send a payload to the server. -## Signature - -```typescript -sendData(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to the server. - -## Remarks - - The payload is wrapped in a magic framing packet before being sent. \ No newline at end of file diff --git a/references/1.4.2/network-client/UDPClient.mdx b/references/1.4.2/network-client/UDPClient.mdx deleted file mode 100644 index 51f4853..0000000 --- a/references/1.4.2/network-client/UDPClient.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "UDPClient class" -icon: "box" -description: "Unreliable, unordered WebRTC data-channel client connection to a NanoForge UDP server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# UDPClient - -## Summary - -Unreliable, unordered WebRTC data-channel client connection to a NanoForge UDP server. -## Signature - -```typescript -declare class UDPClient -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### connect - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. - -### getReceivedPackets - -Parse and return all complete packets received since the last call. - -### isConnected - -Return when the RTCDataChannel is open. - -### sendData - -Send a payload on the data channel. - -## Remarks - - Uses a WebSocket signaling channel to perform the SDP/ICE handshake and then communicates over an RTCDataChannel with `ordered: false` and `maxRetransmits: 0` for minimal latency. Typical usage is through `NetworkClientLibrary` which instantiates and connects this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.2/network-client/UDPClient/connect.mdx b/references/1.4.2/network-client/UDPClient/connect.mdx deleted file mode 100644 index eada6f5..0000000 --- a/references/1.4.2/network-client/UDPClient/connect.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "connect" -icon: "function" -description: "Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# connect - -## Summary - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. -## Signature - -```typescript -connect(): Promise; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Promise` - -Open the WebSocket signaling channel, create an RTCPeerConnection, and complete the SDP/ICE handshake with the server. - -## Remarks - - Resolves once the offer has been dispatched. The data channel may become open shortly after — check `isConnected`. \ No newline at end of file diff --git a/references/1.4.2/network-client/UDPClient/constructor.mdx b/references/1.4.2/network-client/UDPClient/constructor.mdx deleted file mode 100644 index 8009fa3..0000000 --- a/references/1.4.2/network-client/UDPClient/constructor.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the UDPClient class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `UDPClient` class -## Signature - -```typescript -constructor(_port: number, _ip: string, magicValue: string, _wss: boolean); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _ip -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _wss -- **Type**:`boolean` \ No newline at end of file diff --git a/references/1.4.2/network-client/UDPClient/getReceivedPackets.mdx b/references/1.4.2/network-client/UDPClient/getReceivedPackets.mdx deleted file mode 100644 index 01155c8..0000000 --- a/references/1.4.2/network-client/UDPClient/getReceivedPackets.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return all complete packets received since the last call." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return all complete packets received since the last call. -## Signature - -```typescript -getReceivedPackets(): Uint8Array[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Uint8Array[]` - -Parse and return all complete packets received since the last call. - -## Remarks - - Partial packets are retained internally and combined with future chunks until they are complete. Call this method once per frame. \ No newline at end of file diff --git a/references/1.4.2/network-client/UDPClient/isConnected.mdx b/references/1.4.2/network-client/UDPClient/isConnected.mdx deleted file mode 100644 index 54dbdbb..0000000 --- a/references/1.4.2/network-client/UDPClient/isConnected.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "isConnected" -icon: "function" -description: "Return true when the RTCDataChannel is open." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# isConnected - -## Summary - -Return `true` when the RTCDataChannel is open. -## Signature - -```typescript -isConnected(): boolean; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`boolean` - -Return when the RTCDataChannel is open. \ No newline at end of file diff --git a/references/1.4.2/network-client/UDPClient/sendData.mdx b/references/1.4.2/network-client/UDPClient/sendData.mdx deleted file mode 100644 index fc35584..0000000 --- a/references/1.4.2/network-client/UDPClient/sendData.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "sendData" -icon: "function" -description: "Send a payload on the data channel." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendData - -## Summary - -Send a payload on the data channel. -## Signature - -```typescript -sendData(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload on the data channel. - -## Remarks - - The payload is wrapped in a magic framing packet before being sent. \ No newline at end of file diff --git a/references/1.4.2/network-server/0-index.mdx b/references/1.4.2/network-server/0-index.mdx deleted file mode 100644 index 613fff1..0000000 --- a/references/1.4.2/network-server/0-index.mdx +++ /dev/null @@ -1,103 +0,0 @@ ---- -title: "Network Server" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/network-server` is a network lib with tcp and udp support for server-side usage. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/network-server -yarn add @nanoforge-dev/network-server -pnpm add @nanoforge-dev/network-server -bun add @nanoforge-dev/network-server -``` - -## Example usage - -Initilize the library in your main file. - -```ts -import { type IRunServerOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { NetworkServerLibrary } from "@nanoforge-dev/network-server"; - -export async function main(options: IRunServerOptions) { - const app = NanoforgeFactory.createServer(); - - const network = new NetworkServerLibrary(); - - app.useNetwork(network); - - await app.init(options); - - await app.run(); -} -``` - -Use to receive packets - -```ts -export function myReceiveSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - network.tcp.getReceivedPackets().forEach((packets, client) => { - packets.forEach((packet) => { - const data = JSON.parse(new TextDecoder().decode(packet)); - // Do something with the data - }); - }); -} -``` - -Use to send packets to everyones - -```ts -export function mySendSystem(registry: Registry, ctx: Context) { - const network = ctx.libs.getNetwork(); - - // Do something to get a data - const packet = new TextEncoder().encode(JSON.stringify(data)); - network.tcp.sendToEverybody(packet); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/network-server -[npm]: https://www.npmjs.com/package/@nanoforge-dev/network-server -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/network-server/NetworkServerLibrary.mdx b/references/1.4.2/network-server/NetworkServerLibrary.mdx deleted file mode 100644 index 522057c..0000000 --- a/references/1.4.2/network-server/NetworkServerLibrary.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "NetworkServerLibrary class" -icon: "box" -description: "Built-in network library for server-side applications." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# NetworkServerLibrary - -## Summary - -Built-in network library for server-side applications. -## Signature - -```typescript -declare class NetworkServerLibrary extends BaseNetworkLibrary -``` - -## Properties - -### tcp -**Type**:`tcp: TCPServer;` - -Reliable, ordered WebSocket-based server for connected clients. - -### udp -**Type**:`udp: UDPServer;` - -Unreliable, unordered WebRTC data-channel server for connected clients. - -## Remarks - - Reads network configuration from the environment via `ServerConfigNetwork` and starts TCP (WebSocket) and/or UDP (WebRTC) servers. Register with: Configuration (via environment variables): - `LISTENING_INTERFACE` — bind address (default: `"0.0.0.0"`). - `LISTENING_TCP_PORT` — WebSocket listen port for TCP (optional). - `LISTENING_UDP_PORT` — signaling listen port for UDP (optional). - `MAGIC_VALUE` — packet framing delimiter (default: `"PACKET_END"`). - `WSS_CERT` / `WSS_KEY` — paths to TLS certificate and key files for WSS (optional). After `init`, access the servers via `tcp` and `udp`. \ No newline at end of file diff --git a/references/1.4.2/network-server/NetworkServerLibrary/tcp.mdx b/references/1.4.2/network-server/NetworkServerLibrary/tcp.mdx deleted file mode 100644 index 7aa300b..0000000 --- a/references/1.4.2/network-server/NetworkServerLibrary/tcp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "tcp" -icon: "variable" -description: "Reliable, ordered WebSocket-based server for connected clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# tcp - -## Summary - -Reliable, ordered WebSocket-based server for connected clients. - -## Remarks - - Only available when `LISTENING_TCP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.2/network-server/NetworkServerLibrary/udp.mdx b/references/1.4.2/network-server/NetworkServerLibrary/udp.mdx deleted file mode 100644 index 686ddc8..0000000 --- a/references/1.4.2/network-server/NetworkServerLibrary/udp.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "udp" -icon: "variable" -description: "Unreliable, unordered WebRTC data-channel server for connected clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# udp - -## Summary - -Unreliable, unordered WebRTC data-channel server for connected clients. - -## Remarks - - Only available when `LISTENING_UDP_PORT` was specified in the environment. \ No newline at end of file diff --git a/references/1.4.2/network-server/TCPServer.mdx b/references/1.4.2/network-server/TCPServer.mdx deleted file mode 100644 index 68f8595..0000000 --- a/references/1.4.2/network-server/TCPServer.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "TCPServer class" -icon: "box" -description: "Reliable, ordered WebSocket-based server that manages multiple TCP clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# TCPServer - -## Summary - -Reliable, ordered WebSocket-based server that manages multiple TCP clients. -## Signature - -```typescript -declare class TCPServer -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getConnectedClients - -Return a snapshot array of numeric client IDs currently connected. - -### getReceivedPackets - -Parse and return complete packets received from each client. Each packet is a buffer. - -### listen - -Start the WebSocket server and begin accepting clients. - -### sendToClient - -Send a payload to the client identified by . - -### sendToEverybody - -Send a payload to every connected client. - -## Remarks - - Each client that connects is assigned a numeric ID. Use `getConnectedClients` to enumerate active clients, `sendToClient` / `sendToEverybody` to push data, and `getReceivedPackets` to consume incoming packets per frame. Typical usage is through `NetworkServerLibrary` which instantiates and starts this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.2/network-server/TCPServer/constructor.mdx b/references/1.4.2/network-server/TCPServer/constructor.mdx deleted file mode 100644 index 34a13cb..0000000 --- a/references/1.4.2/network-server/TCPServer/constructor.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the TCPServer class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `TCPServer` class -## Signature - -```typescript -constructor(_port: number, _host: string, magicValue: string, _cert?: string | undefined, _key?: string | undefined); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _host -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _cert -- **Type**:`string | undefined` -- **Optional**: Yes - - - -### _key -- **Type**:`string | undefined` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.4.2/network-server/TCPServer/getConnectedClients.mdx b/references/1.4.2/network-server/TCPServer/getConnectedClients.mdx deleted file mode 100644 index fa695c5..0000000 --- a/references/1.4.2/network-server/TCPServer/getConnectedClients.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getConnectedClients" -icon: "function" -description: "Return a snapshot array of numeric client IDs currently connected." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConnectedClients - -## Summary - -Return a snapshot array of numeric client IDs currently connected. -## Signature - -```typescript -getConnectedClients(): number[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`number[]` - -Return a snapshot array of numeric client IDs currently connected. \ No newline at end of file diff --git a/references/1.4.2/network-server/TCPServer/getReceivedPackets.mdx b/references/1.4.2/network-server/TCPServer/getReceivedPackets.mdx deleted file mode 100644 index 0a64e6a..0000000 --- a/references/1.4.2/network-server/TCPServer/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Parse and return complete packets received from each client. Each packet is a Uint8Array buffer." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Parse and return complete packets received from each client. Each packet is a `Uint8Array` buffer. -## Signature - -```typescript -getReceivedPackets(): Map; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Map` - -Parse and return complete packets received from each client. Each packet is a buffer. \ No newline at end of file diff --git a/references/1.4.2/network-server/TCPServer/listen.mdx b/references/1.4.2/network-server/TCPServer/listen.mdx deleted file mode 100644 index 0ed1244..0000000 --- a/references/1.4.2/network-server/TCPServer/listen.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "listen" -icon: "function" -description: "Start the WebSocket server and begin accepting clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# listen - -## Summary - -Start the WebSocket server and begin accepting clients. -## Signature - -```typescript -listen(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Start the WebSocket server and begin accepting clients. \ No newline at end of file diff --git a/references/1.4.2/network-server/TCPServer/sendToClient.mdx b/references/1.4.2/network-server/TCPServer/sendToClient.mdx deleted file mode 100644 index 7bef494..0000000 --- a/references/1.4.2/network-server/TCPServer/sendToClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "sendToClient" -icon: "function" -description: "Send a payload to the client identified by clientId." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToClient - -## Summary - -Send a payload to the client identified by `clientId`. -## Signature - -```typescript -sendToClient(clientId: number, data: Uint8Array): void; -``` - -## Parameters - -### clientId -**Type**:`number` - -number — numeric client identifier. - -### data -**Type**:`Uint8Array` - -Uint8Array — payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to the client identified by . \ No newline at end of file diff --git a/references/1.4.2/network-server/TCPServer/sendToEverybody.mdx b/references/1.4.2/network-server/TCPServer/sendToEverybody.mdx deleted file mode 100644 index f2b2d58..0000000 --- a/references/1.4.2/network-server/TCPServer/sendToEverybody.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendToEverybody" -icon: "function" -description: "Send a payload to every connected client." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToEverybody - -## Summary - -Send a payload to every connected client. -## Signature - -```typescript -sendToEverybody(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Uint8Array — raw payload bytes. - -## Returns - -**Type**:`void` - -Send a payload to every connected client. \ No newline at end of file diff --git a/references/1.4.2/network-server/UDPServer.mdx b/references/1.4.2/network-server/UDPServer.mdx deleted file mode 100644 index 4b7de31..0000000 --- a/references/1.4.2/network-server/UDPServer.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "UDPServer class" -icon: "box" -description: "Unreliable, unordered WebRTC data-channel server that manages multiple UDP clients." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# UDPServer - -## Summary - -Unreliable, unordered WebRTC data-channel server that manages multiple UDP clients. -## Signature - -```typescript -declare class UDPServer -``` - -## Constructors - -### constructor - -Constructs a new instance of the class - -## Methods - -### getConnectedClients - -Return a snapshot array of client IDs with active data channels. - -### getReceivedPackets - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. - -### listen - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). - -### sendToClient - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. - -### sendToEverybody - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. - -## Remarks - - Uses a WebSocket signaling server to complete SDP/ICE handshakes and then communicates over RTCDataChannels. Each connected client is assigned a numeric ID. Use `getConnectedClients` to enumerate active clients, `sendToClient` / `sendToEverybody` to push data, and `getReceivedPackets` to consume incoming packets per frame. Typical usage is through `NetworkServerLibrary` which instantiates and starts this class automatically during `__init`. \ No newline at end of file diff --git a/references/1.4.2/network-server/UDPServer/constructor.mdx b/references/1.4.2/network-server/UDPServer/constructor.mdx deleted file mode 100644 index 8cb0274..0000000 --- a/references/1.4.2/network-server/UDPServer/constructor.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: "constructor" -icon: "function" -description: "Constructs a new instance of the UDPServer class" ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# constructor - -## Summary - -Constructs a new instance of the `UDPServer` class -## Signature - -```typescript -constructor(_port: number, _host: string, magicValue: string, _cert?: string | undefined, _key?: string | undefined); -``` - -## Parameters - -### _port -- **Type**:`number` - - - -### _host -- **Type**:`string` - - - -### magicValue -- **Type**:`string` - - - -### _cert -- **Type**:`string | undefined` -- **Optional**: Yes - - - -### _key -- **Type**:`string | undefined` -- **Optional**: Yes \ No newline at end of file diff --git a/references/1.4.2/network-server/UDPServer/getConnectedClients.mdx b/references/1.4.2/network-server/UDPServer/getConnectedClients.mdx deleted file mode 100644 index 9d035cb..0000000 --- a/references/1.4.2/network-server/UDPServer/getConnectedClients.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getConnectedClients" -icon: "function" -description: "Return a snapshot array of client IDs with active data channels." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getConnectedClients - -## Summary - -Return a snapshot array of client IDs with active data channels. -## Signature - -```typescript -getConnectedClients(): number[]; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`number[]` - -Return a snapshot array of client IDs with active data channels. \ No newline at end of file diff --git a/references/1.4.2/network-server/UDPServer/getReceivedPackets.mdx b/references/1.4.2/network-server/UDPServer/getReceivedPackets.mdx deleted file mode 100644 index e50aa0d..0000000 --- a/references/1.4.2/network-server/UDPServer/getReceivedPackets.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "getReceivedPackets" -icon: "function" -description: "Reassemble buffered chunks and return a map of clientId => complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# getReceivedPackets - -## Summary - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. -## Signature - -```typescript -getReceivedPackets(): Map; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`Map` - -Reassemble buffered chunks and return a map of clientId = complete packets. Partial packets are retained internally for the next call so callers may repeatedly poll this method to consume newly arrived data. \ No newline at end of file diff --git a/references/1.4.2/network-server/UDPServer/listen.mdx b/references/1.4.2/network-server/UDPServer/listen.mdx deleted file mode 100644 index 539353a..0000000 --- a/references/1.4.2/network-server/UDPServer/listen.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "listen" -icon: "function" -description: "Start the signaling WebSocket and accept incoming client offers (SDP/ICE)." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# listen - -## Summary - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). -## Signature - -```typescript -listen(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Start the signaling WebSocket and accept incoming client offers (SDP/ICE). \ No newline at end of file diff --git a/references/1.4.2/network-server/UDPServer/sendToClient.mdx b/references/1.4.2/network-server/UDPServer/sendToClient.mdx deleted file mode 100644 index 9e34361..0000000 --- a/references/1.4.2/network-server/UDPServer/sendToClient.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "sendToClient" -icon: "function" -description: "Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToClient - -## Summary - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. -## Signature - -```typescript -sendToClient(clientId: number, data: Uint8Array): void; -``` - -## Parameters - -### clientId -**Type**:`number` - -Numeric client identifier returned by listen() events - -### data -**Type**:`Uint8Array` - -Raw packet bytes (Uint8Array) to send - -## Returns - -**Type**:`void` - -Send a packet to a single client via the unreliable data channel. The packet will be framed with the server's configured magic terminator bytes before being sent. \ No newline at end of file diff --git a/references/1.4.2/network-server/UDPServer/sendToEverybody.mdx b/references/1.4.2/network-server/UDPServer/sendToEverybody.mdx deleted file mode 100644 index 7a0489c..0000000 --- a/references/1.4.2/network-server/UDPServer/sendToEverybody.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "sendToEverybody" -icon: "function" -description: "Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# sendToEverybody - -## Summary - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. -## Signature - -```typescript -sendToEverybody(data: Uint8Array): void; -``` - -## Parameters - -### data -**Type**:`Uint8Array` - -Raw packet bytes (Uint8Array) to send to every client - -## Returns - -**Type**:`void` - -Broadcast a packet to all connected clients over the unreliable data channels. The server will frame the provided data with the configured magic terminator. \ No newline at end of file diff --git a/references/1.4.2/sound/0-index.mdx b/references/1.4.2/sound/0-index.mdx deleted file mode 100644 index 3372673..0000000 --- a/references/1.4.2/sound/0-index.mdx +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: "Sound" ---- - -
-
-

- NanoForge -

-
-

- npm version - npm downloads - Tests status - Last commit - Contributors -

-
- -## About - -`@nanoforge-dev/sound` is a sound manager for your game. - -## Installation - -**Node.js 25 or newer is required.** - -```sh -npm install @nanoforge-dev/sound -yarn add @nanoforge-dev/sound -pnpm add @nanoforge-dev/sound -bun add @nanoforge-dev/sound -``` - -## Example usage - -Initialize the library in your main file - -```ts -import { AssetManagerLibrary } from "@nanoforge-dev/asset-manager"; -import { type IRunClientOptions } from "@nanoforge-dev/common"; -import { NanoforgeFactory } from "@nanoforge-dev/core"; -import { SoundLibrary } from "@nanoforge-dev/sound"; - -export async function main(options: IRunClientOptions) { - const app = NanoforgeFactory.createClient(); - - const assetManager = new AssetManagerLibrary(); - const sound = new SoundLibrary(); - - app.useAssetManager(assetManager); - app.useSound(sound); - - await app.init(options); - - sound.load("sound", assetManager.getAssetPath("/path/to/sound.mp3").path); - - await app.run(); -} -``` - -Use to play sound - -```ts -export function mySystem(registry: Registry, ctx: Context) { - const assetManager = ctx.libs.getAssetManager(); - const sound = ctx.libs.getSound(); - - sound.play("sound"); -} -``` - -## Links - -- [GitHub][source] -- [npm][npm] - -## Contributing - -Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the -[documentation][documentation]. -See [the contribution guide][contributing] if you'd like to submit a PR. - -## Help - -If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to ask questions in [discussions][discussions]. - -[documentation]: https://github.com/NanoForge-dev/Engine -[discussions]: https://github.com/NanoForge-dev/Engine/discussions -[source]: https://github.com/NanoForge-dev/Engine/tree/main/packages/sound -[npm]: https://www.npmjs.com/package/@nanoforge-dev/sound -[contributing]: https://github.com/NanoForge-dev/Engine/blob/main/.github/CONTRIBUTING.md diff --git a/references/1.4.2/sound/SoundLibrary.mdx b/references/1.4.2/sound/SoundLibrary.mdx deleted file mode 100644 index 7077d2a..0000000 --- a/references/1.4.2/sound/SoundLibrary.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: "SoundLibrary class" -icon: "box" -description: "Built-in sound-effect library." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# SoundLibrary - -## Summary - -Built-in sound-effect library. -## Signature - -```typescript -declare class SoundLibrary extends BaseSoundLibrary -``` - -## Methods - -### load - -Register a sound effect under a unique key. - -### mute - -Toggle the muted state of all loaded sound effects. - -### play - -Play a previously loaded sound effect. - -## Remarks - - Manages a collection of named `HTMLAudioElement` instances. Load sounds with `load` and trigger playback with `play`. Register with the application: Access in game code: \ No newline at end of file diff --git a/references/1.4.2/sound/SoundLibrary/load.mdx b/references/1.4.2/sound/SoundLibrary/load.mdx deleted file mode 100644 index 7995630..0000000 --- a/references/1.4.2/sound/SoundLibrary/load.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "load" -icon: "function" -description: "Register a sound effect under a unique key." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# load - -## Summary - -Register a sound effect under a unique key. -## Signature - -```typescript -load(sound: string, file: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Unique key used to reference this sound (e.g. "explosion"). - -### file -**Type**:`string` - -URL or path to the audio file. - -## Returns - -**Type**:`void` - -Register a sound effect under a unique key. - -## Remarks - - Creates an `HTMLAudioElement` from the provided URL. The sound respects the current muted state at load time. \ No newline at end of file diff --git a/references/1.4.2/sound/SoundLibrary/mute.mdx b/references/1.4.2/sound/SoundLibrary/mute.mdx deleted file mode 100644 index aa6aae2..0000000 --- a/references/1.4.2/sound/SoundLibrary/mute.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "mute" -icon: "function" -description: "Toggle the muted state of all loaded sound effects." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# mute - -## Summary - -Toggle the muted state of all loaded sound effects. -## Signature - -```typescript -mute(): void; -``` - -## Parameters - -*No parameters.* - -## Returns - -**Type**:`void` - -Toggle the muted state of all loaded sound effects. \ No newline at end of file diff --git a/references/1.4.2/sound/SoundLibrary/play.mdx b/references/1.4.2/sound/SoundLibrary/play.mdx deleted file mode 100644 index f072fab..0000000 --- a/references/1.4.2/sound/SoundLibrary/play.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "play" -icon: "function" -description: "Play a previously loaded sound effect." ---- - -import { PageLink } from '/snippets/tsdocs/PageLink.jsx'; -import { RefLink } from '/snippets/tsdocs/RefLink.jsx'; - -# play - -## Summary - -Play a previously loaded sound effect. -## Signature - -```typescript -play(sound: string): void; -``` - -## Parameters - -### sound -**Type**:`string` - -Key that identifies the sound (as passed to load). - -## Returns - -**Type**:`void` - -Play a previously loaded sound effect. \ No newline at end of file diff --git a/references/engine/navigation.json b/references/engine/navigation.json new file mode 100644 index 0000000..3700af9 --- /dev/null +++ b/references/engine/navigation.json @@ -0,0 +1 @@ +[{ "version": "Upcoming", "default": true, "pages": ["references/engine/upcoming"] }] diff --git a/references/engine/upcoming.mdx b/references/engine/upcoming.mdx new file mode 100644 index 0000000..4d15a65 --- /dev/null +++ b/references/engine/upcoming.mdx @@ -0,0 +1,6 @@ +--- +title: "API reference" +description: "The engine API reference is published with the next engine release" +--- + +The API reference of the engine packages is generated from their TSDoc comments and published here by the next engine release. From 419d640720b4de6f6cc6c852a369406ab1007461 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 7 Nov 2026 00:40:37 +0100 Subject: [PATCH 02/11] chore(engine): deploy docs --- docs/engine/editor/protocol.mdx | 110 +++++++++ docs/engine/getting-started/documentation.mdx | 14 ++ docs/engine/getting-started/how-to-use.mdx | 17 ++ docs/engine/getting-started/index.mdx | 21 ++ docs/engine/graphics-3d/advanced.mdx | 102 +++++++++ docs/engine/graphics-3d/editor-proposal.mdx | 97 ++++++++ docs/engine/graphics-3d/index.mdx | 129 +++++++++++ docs/engine/graphics-3d/performance.mdx | 56 +++++ docs/engine/lib-graphic-3d/babylon-js.mdx | 68 ++++++ docs/engine/lib-graphic-3d/index.mdx | 189 ++++++++++++++++ docs/engine/lib-graphic-3d/luma-gl.mdx | 66 ++++++ docs/engine/lib-graphic-3d/playcanvas.mdx | 65 ++++++ docs/engine/lib-graphic-3d/poc.mdx | 70 ++++++ docs/engine/lib-graphic-3d/three-js.mdx | 67 ++++++ docs/engine/navigation.json | 60 +++++ docs/engine/network/index.mdx | 24 ++ docs/engine/network/network-client-api.mdx | 155 +++++++++++++ docs/engine/network/network-client.mdx | 89 ++++++++ docs/engine/network/network-peer.mdx | 134 +++++++++++ docs/engine/network/network-server-api.mdx | 209 ++++++++++++++++++ docs/engine/network/network-server.mdx | 107 +++++++++ docs/engine/network/packet-framing.mdx | 72 ++++++ docs/engine/registry/index.mdx | 21 ++ docs/engine/registry/writing-web-assembly.mdx | 21 ++ 24 files changed, 1963 insertions(+) create mode 100644 docs/engine/editor/protocol.mdx create mode 100644 docs/engine/getting-started/documentation.mdx create mode 100644 docs/engine/getting-started/how-to-use.mdx create mode 100644 docs/engine/getting-started/index.mdx create mode 100644 docs/engine/graphics-3d/advanced.mdx create mode 100644 docs/engine/graphics-3d/editor-proposal.mdx create mode 100644 docs/engine/graphics-3d/index.mdx create mode 100644 docs/engine/graphics-3d/performance.mdx create mode 100644 docs/engine/lib-graphic-3d/babylon-js.mdx create mode 100644 docs/engine/lib-graphic-3d/index.mdx create mode 100644 docs/engine/lib-graphic-3d/luma-gl.mdx create mode 100644 docs/engine/lib-graphic-3d/playcanvas.mdx create mode 100644 docs/engine/lib-graphic-3d/poc.mdx create mode 100644 docs/engine/lib-graphic-3d/three-js.mdx create mode 100644 docs/engine/navigation.json create mode 100644 docs/engine/network/index.mdx create mode 100644 docs/engine/network/network-client-api.mdx create mode 100644 docs/engine/network/network-client.mdx create mode 100644 docs/engine/network/network-peer.mdx create mode 100644 docs/engine/network/network-server-api.mdx create mode 100644 docs/engine/network/network-server.mdx create mode 100644 docs/engine/network/packet-framing.mdx create mode 100644 docs/engine/registry/index.mdx create mode 100644 docs/engine/registry/writing-web-assembly.mdx diff --git a/docs/engine/editor/protocol.mdx b/docs/engine/editor/protocol.mdx new file mode 100644 index 0000000..dfe9839 --- /dev/null +++ b/docs/engine/editor/protocol.mdx @@ -0,0 +1,110 @@ +--- +title: "Editor protocol" +icon: "book" +description: "How a running game and the NanoForge editor talk to each other" +--- + +# Editor protocol + +When the editor starts a game, it passes two event emitters in `RunOptions.editor`: + +- `fromEditor`: editor → engine commands. `EditorLibrary` drains it at the start of every tick, including paused ticks. +- `toEditor`: engine → editor events. + +The game registers `EditorLibrary` from `@nanoforge-dev/editor-lib`, which handles the protocol. The engine itself (`@nanoforge-dev/core`, `@nanoforge-dev/common`) knows nothing about the editor. + +```ts +import { EditorLibrary } from "@nanoforge-dev/editor-lib"; + +app.use(new EditorLibrary()); +``` + +Without `RunOptions.editor` the library does nothing, so a game can always register it. Libraries reach the editor through `Context.editor`, which is `undefined` when no editor started the game or `EditorLibrary` is not registered. + +The protocol version is `EDITOR_PROTOCOL_VERSION` (`@nanoforge-dev/editor-lib`), currently **1**. The command and event payloads are typed by `EditorCommandMap` and `EditorEventMap`. Libraries add their own entries by module augmentation. + +## Handshake + +1. On its first tick, once every library is initialized, the engine emits `hello`: `{ protocolVersion, libraries }`, where `libraries` lists the keys of the registered libraries. +2. The editor answers with the `welcome` command: `{ protocolVersion, features }`, where `features` lists the optional features it wants (below). +3. `EditorLibrary` calls `__editorInit(ctx)` once on every library that has it (below). Libraries read the answer from `ctx.editor.welcome`. + +Commands drained on the same tick as the first `welcome`, before or after it, are not seen by the listeners added in `__editorInit`: they are dispatched before the hook runs. The editor sends the commands meant for libraries (`mute`, `ecs-*`…) at least one tick after its `welcome`. + +If the two protocol versions differ, the editor tells the user to update the engine or the editor. + +## Editor wiring in a library: `__editorInit` + +A library that has editor-only wiring implements `EditorAwareLibrary`. `__editorInit` is called once, in run order, on the tick the editor's `welcome` arrives, before the libraries' `__events` of that tick. It is never called when no editor started the game. A later `welcome` only replaces `ctx.editor.welcome`. + +```ts +import { Library } from "@nanoforge-dev/common"; +import type { EditorAwareLibrary, EditorInitContext } from "@nanoforge-dev/editor-lib"; + +class SoundLibrary extends Library implements EditorAwareLibrary { + async __editorInit(ctx: EditorInitContext) { + ctx.editor.on("mute", (muted) => this.setMuted(muted)); + } +} +``` + +The hook is not part of the engine: `EditorLibrary` calls it with `ctx.app.callHook("__editorInit", ctx)`, which any library can use to define a lifecycle step of its own. + +## Run control + +| Command | Effect | +| -------- | --------------------------------------------- | +| `pause` | `ctx.app.requestPause()` | +| `resume` | `ctx.app.requestResume()` | +| `step` | runs exactly one tick while paused | +| `stop` | `ctx.app.requestStop()`: clears every library | + +A command applies on the tick it is drained in. After a `stop`, that tick still completes before the libraries are cleared. + +The engine reports each change of its run state with the `state` event: `"running"`, `"paused"` or `"stopped"`. It sends `stopped` only after every library's `__clear` has run and the viewport has been disposed, so the editor can safely remove the game container or end the process. + +## Optional features + +Each feature is enabled only if the editor asks for it in `welcome.features`. + +| Feature | Event | Payload | +| ---------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------- | +| `frameStats: { intervalMs }` | `frame-stats` | `{ windowMs, ticks, tps, tick: { avg, max }, libraries: { [key]: { avg, max } } }`, durations in ms | +| `logs: true` | `log` | `{ level, message }` for each console call made by the game's code | +| `logs: { values: true }` | `log` | also `values` (the logged values, as trees) and `caller` (`::`) | +| `networkTrace: { sampleRate?, maxPerSecond? }` | `network-trace` | `{ direction, transport, clientId?, size, head, time }` (network libraries) | +| `viewport: true` | `viewport` | the game's `ViewportState`, at once and on every change (clients) | + +Log forwarding only forwards console calls whose stack contains a frame of the game bundle. Output from before the `welcome` (library `__init`, the start of `main`) is kept, up to 200 lines, and sent as soon as the editor asks for logs. It is dropped if the editor doesn't ask for them. A client runs inside the editor page, and this keeps the editor's own console output out of the game logs. + +### Logged values belong to the host + +The trees in `values` (`EditorLogValue`) are made by the host, not by the engine: the host passes its serializer in `RunOptions.editor.serializeLogValue`, and the bridge calls it on each argument when the line is logged, so later changes to a logged object don't show. A host runs the games it wants values of in its own page (the editor runs clients this way), so the function can be passed as is. + +- A host that gives no serializer gets text only, even if it asks for values. +- An engine older than this field ignores it, and keeps sending text only. +- Lines logged between the creation of `EditorLibrary` and its `__init` are snapshotted when the channels arrive. + +### Viewport + +A point `(x, y)` of the game is drawn at `(contentLeft + originX + x * scaleX, contentTop + originY + y * scaleY)` CSS px of the game's container. The editor uses it to draw over the running game (selecting and moving entities in its Game screen). + +## Hosting a game + +```ts +import { QueuedEventEmitter } from "@nanoforge-dev/editor-lib"; + +const fromEditor = new QueuedEventEmitter(); // drained by the engine +const toEditor = { + on() {}, + off() {}, + runEvents() {}, + // Deliver outside the engine tick. + emit: (event: string, ...args: unknown[]) => queueMicrotask(() => handle(event, args)), +}; + +await main({ ...options, editor: { toEditor, fromEditor, serializeLogValue } }); +fromEditor.emit("welcome", { protocolVersion: 1, features: { frameStats: { intervalMs: 500 } } }); +``` + +The game started by `main` must have registered `EditorLibrary`, or `RunOptions.editor` is ignored. diff --git a/docs/engine/getting-started/documentation.mdx b/docs/engine/getting-started/documentation.mdx new file mode 100644 index 0000000..b6271fa --- /dev/null +++ b/docs/engine/getting-started/documentation.mdx @@ -0,0 +1,14 @@ +--- +title: "Documentation" +icon: "book" +description: "How the engine documentation is written and published" +--- + +# Documentation + +The engine documentation lives in the engine repository and is published to this site automatically at each engine release. + +- **Pages** are the `.mdx` files in `docs/docs`. Their order and groups come from `docs/docs/navigation.json`: every page is listed there exactly once. +- **API references** are generated from the TSDoc comments of each package by `pnpm run docs` (TypeDoc), into `docs/references`. They are never written by hand. + +To change a page, edit it in the engine repository. Links between pages are relative to the file, like `./how-to-use` or `../network/index`. diff --git a/docs/engine/getting-started/how-to-use.mdx b/docs/engine/getting-started/how-to-use.mdx new file mode 100644 index 0000000..d3992cd --- /dev/null +++ b/docs/engine/getting-started/how-to-use.mdx @@ -0,0 +1,17 @@ +--- +title: "Introduction to using the Engine" +icon: "book" +description: "Getting started with the engine" +--- + +# Introduction to using the Engine + +Whether you work on this engine as a developer or you want to use it, you will want a test project. This page is a walkthrough for setting up a basic project. + +## As a developer on the engine + +As a developer you want to be able to use your changes in your own project. Therefore it is recommended to use the provided [CLI](https://github.com/NanoForge-dev/CLI). + +## As a user + +As a user you can either use the template and change the dependency location, or create a project and add the Nanoforge dependencies. It is recommended to use Bun as a package manager. diff --git a/docs/engine/getting-started/index.mdx b/docs/engine/getting-started/index.mdx new file mode 100644 index 0000000..563e9da --- /dev/null +++ b/docs/engine/getting-started/index.mdx @@ -0,0 +1,21 @@ +--- +title: "Engine" +icon: "book" +description: "Nanoforge engine documentation" +--- + +# Engine + +This documentation covers the engine, its packages, and the surrounding usage guides. + +## Start Here + +- [Documentation](/docs/engine/getting-started/documentation) +- [How to Use](/docs/engine/getting-started/how-to-use) + +## Packages + +- [Registry](/docs/engine/registry/index) +- [Network](/docs/engine/network/index) +- [Graphics 3D](/docs/engine/graphics-3d/index) +- [Editor protocol](/docs/engine/editor/protocol) diff --git a/docs/engine/graphics-3d/advanced.mdx b/docs/engine/graphics-3d/advanced.mdx new file mode 100644 index 0000000..688b519 --- /dev/null +++ b/docs/engine/graphics-3d/advanced.mdx @@ -0,0 +1,102 @@ +--- +title: "Graphics 3D: advanced" +icon: "wand-magic-sparkles" +description: "Full Three.js access, cameras, picking and editor events in @nanoforge-dev/graphics-3d" +--- + +# Graphics 3D: advanced + +The library adds no layer between you and Three.js. Everything below is plain Three.js on the objects of `Context.graphics`. + +## Importing Three.js + +| Import | Content | +| -------------------------------------- | ----------------------------------------------------------------- | +| `@nanoforge-dev/graphics-3d/three` | `three/webgpu`: the whole core, `WebGPURenderer`, node materials. | +| `@nanoforge-dev/graphics-3d/three/tsl` | `three/tsl`: the Three.js Shading Language. | +| `three/addons/...` | Add-ons (`GLTFLoader`, `OrbitControls`…), from `three` directly. | + +The subpaths only re-export `three`. `three` is a peer dependency that the app installs, so the library, the game and the add-ons resolve the same copy. Add-ons import `three`, which shares its core classes with `three/webgpu`. For add-on types, add `@types/three` at the same version. + +### Loading a model + +Load project files through `ctx.assets`. It returns the URL the game serves the file at. + +```ts +import { GLTFLoader } from "three/addons/loaders/GLTFLoader.js"; + +const file = ctx.assets.getAsset("models/robot.glb"); +const gltf = await new GLTFLoader().loadAsync(file.path); +ctx.graphics.scene.add(gltf.scene); +``` + +Do not await asset loads in a library's `__init`: start them and add the objects when they arrive. + +### Node materials and TSL + +`WebGPURenderer` compiles node materials to WGSL (WebGPU) and GLSL (WebGL2) from one source. + +```ts +import { Mesh, MeshStandardNodeMaterial, SphereGeometry } from "@nanoforge-dev/graphics-3d/three"; +import { color, sin, time } from "@nanoforge-dev/graphics-3d/three/tsl"; + +const material = new MeshStandardNodeMaterial(); +material.colorNode = color("#ff6040").mul(sin(time).mul(0.5).add(0.5)); +ctx.graphics.scene.add(new Mesh(new SphereGeometry(), material)); +``` + +## Cameras + +Assign any camera to `graphics.camera`. The viewport is applied to it at once, and again on every change. For a `PerspectiveCamera`, the library sets `aspect`. For an `OrthographicCamera`, you choose `left`/`right`/`top`/`bottom` in design proportions. + +```ts +import { OrthographicCamera } from "@nanoforge-dev/graphics-3d/three"; + +graphics.camera = new OrthographicCamera(-16, 16, 9, -9, 0.1, 100); +``` + +After changing `fov`, `near` or `far`, call `camera.updateProjectionMatrix()`. + +## Picking + +`raycast` takes page coordinates, the ones pointer events give: + +```ts +canvas.addEventListener("pointerdown", (event) => { + const [hit] = ctx.graphics.raycast(event.clientX, event.clientY); + if (hit) console.log("clicked", hit.object.name, "at", hit.point); +}); +``` + +`worldToScreen` goes the other way, for example to place an HTML label over an object. + +## Render loop + +Never call `renderer.setAnimationLoop` or render from `requestAnimationFrame`. The engine renders once per tick, and the editor relies on this: pause freezes the image, and step draws exactly one frame. To draw something else than `scene` through `camera`, such as a post-processing pipeline, replace the library's render step. The library still calls it once per tick, and for editor screenshots: + +```ts +import { RenderPipeline } from "@nanoforge-dev/graphics-3d/three"; +import { pass, saturation } from "@nanoforge-dev/graphics-3d/three/tsl"; + +const { renderer, scene, camera } = ctx.graphics; +const postProcessing = new RenderPipeline(renderer); +const scenePass = pass(scene, camera); +postProcessing.outputNode = saturation(scenePass.getTextureNode(), 0.2); + +ctx.graphics.render = () => postProcessing.render(); +``` + +Assign `undefined` to go back to the default render. The custom render is reset when the game restarts. + +## Editor bridge + +When the editor starts the game, the library adds to the editor protocol: + +| Name | Direction | Payload | Purpose | +| ------------------ | --------------- | ---------------------- | -------------------------------------------------------------------------------------- | +| `graphicsCamera` | feature | `boolean` | Asked for in the editor's `welcome`. | +| `graphics-camera` | engine → editor | `{ view, projection }` | The active camera's matrices (16 numbers, column-major), on start and on every change. | +| `graphics-capture` | editor → engine | none | Renders a frame now, even while paused. | +| `graphics-capture` | engine → editor | PNG data URL | That frame. WebGL and WebGPU canvases are only readable right after a render. | + +The projection includes the viewport crop, so its normalized device coordinates span the canvas. The canvas is drawn `visibleWidth` × `visibleHeight` CSS px at (`contentLeft`, `contentTop`) of the container (see the `viewport` event). diff --git a/docs/engine/graphics-3d/editor-proposal.mdx b/docs/engine/graphics-3d/editor-proposal.mdx new file mode 100644 index 0000000..8598260 --- /dev/null +++ b/docs/engine/graphics-3d/editor-proposal.mdx @@ -0,0 +1,97 @@ +--- +title: "Graphics 3D: editor proposal" +icon: "pen-ruler" +description: "Proposal for the editor's 3D Scene screen and plugin needs, for the editor's requirements session" +--- + +# Graphics 3D: editor proposal + +Input for the editor's requirements session on 3D (see `editor/CLAUDE.md`: a plugin starts with a requirements session and a spec in `docs/specs/.md`). Nothing here is built on the editor side yet. + +**Goal:** a beginner edits a 3D scene without code, in the same way the 2D Scene screen works today. + +## What the engine provides now + +`@nanoforge-dev/graphics-3d` ([docs](/docs/engine/graphics-3d/index)) adds to the editor bridge: + +| Name | Kind | Payload | Use in the editor | +| ------------------ | ------- | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `graphicsCamera` | feature | `boolean` | Ask for it in `welcome` while a 3D tool over the running game is active, like `viewport` in `GameMoveOverlay`. | +| `graphics-camera` | event | `{ view, projection }` | Active camera matrices (column-major), sent once on start and then on every change. Together with `viewport` they map pointer ↔ world. | +| `graphics-capture` | command | none | Ask for a screenshot: the engine renders a frame, even while paused. | +| `graphics-capture` | event | PNG data URL | The frame. | + +The library also guarantees the following: + +- **Rendering:** it renders only from the engine tick, so pause freezes the image and step draws one frame. +- **Pop-out:** it creates its canvas in `container.ownerDocument`, so pop-out keeps working. A same-document iframe move was tested in the POC; a real `window.open` window was not. +- **Restarts:** `__init`/`__clear` survive repeated restarts, as tested with 10 cycles. Each clear disposes GPU objects, removes the canvas and deletes `window.__THREE__`. + +## Findings that change the brief + +- **Screenshot:** `plugins/viewport/src/game/screenshot.ts` draws every canvas with `drawImage` at an arbitrary time. A WebGL or WebGPU canvas may be blank then, which never happened with Konva. When the app has graphics-3d, use `graphics-capture` instead. +- **New feature flag:** `graphicsCamera` must be added to the editor's `mergeFeatures`, or it is silently dropped. +- **Telling 2D from 3D:** both libraries use the key `graphics`, so `hello.libraries` cannot tell them apart. The editor must look at the app's dependencies (`@nanoforge-dev/graphics-3d` vs `graphics-2d`). It could also look at the `graphics-camera` answer. +- **The viewport type is 2D:** `EngineViewport` (`packages/protocol`) maps game units to px in 2D. For 3D, it still gives the canvas rectangle, and `graphics-camera` gives the rest. +- **No hot reload today:** a source change while watching rebuilds the app, but nothing restarts the running game. Restart is the manual `runtime.restart`. Asset changes also trigger a rebuild, with no filter. "Hot reload" for 3D therefore means a rebuild plus a restart (manual, or automatic if the editor decides so). The engine side is ready for that. +- **Class names:** `build-scene.ts` matches shapes by class name only (`Rect`, `Circle`), and the bundler renames a component class whose name clashes with another bundled class (`Sphere` → `Sphere2`), which the ECS then fails to match. Three.js ships `Sphere`, `Plane`, `Box3`… That is why the 3D components are named with a `3D` suffix. +- **Vector preset:** `@preset vector` already supports `x`/`y`/`z` (slots `x, y, z, w`, minimum 2). A 3D position needs no new preset. + +## Components (not in the engine library) + +ECS components and systems for 3D are built in [components-systems](https://github.com/NanoForge-dev/components-systems), not in the library: + +- transform: `Position3D`, `Rotation3D` (degrees), `Scale3D`; +- shapes: `Box3D`, `Sphere3D`, `Plane3D`; +- `Model3D` (`@asset model .glb .gltf`), `Camera3D`, `Light3D`; +- the escape hatch `Object3DComponent`; +- a sync system; +- a pure function that maps component params to Three.js objects. + +The editor's Scene screen should import that same pure function, so the game and the Scene screen never drift. + +## Proposed editor work + +### 1. 3D Scene screen (`SCENE_EDITORS`) + +- **Building the scene:** build it from `main.ts` literals without running the game, as `build-scene.ts` does in 2D. Find the position by the `Position3D` component (numeric `x`/`y`/`z`), and turn component params into Three.js objects with the shared mapping function. +- **Rendering:** render with its own `WebGPURenderer`, its own scene and an editor `OrbitControls` camera that is not the game camera. +- **Picking and gizmos:** pick with `Raycaster`; move, rotate and scale with `TransformControls`. +- **Writing a gizmo edit, while stopped:** write `Position3D` / `Rotation3D` / `Scale3D` args to code with `ecs.apply({ kind: "setArgs", … })`, undoable, as `SceneView` does for `Position`. +- **Writing a gizmo edit, while playing:** apply it live with `live.setField` (`ecs-set-component`), then _Apply to code_. + +### 2. Move tool over the running game (`VIEWPORT_OVERLAYS`) + +While the tool is active, ask for `{ viewport: true, graphicsCamera: true }`. Then: + +1. Pointer → NDC on the canvas rectangle (`contentLeft`, `contentTop`, `visibleWidth`, `visibleHeight`). +2. Unproject with `inverse(projection)`, then `inverse(view)`, which gives a world ray. +3. Pick against the entities' bounds, or drag on a plane (the ground, or a plane facing the camera through the object). +4. Write with `live.setField`. + +### 3. Drag and drop + +- **Model file:** dropping a `.glb`/`.gltf` from the file manager onto the 3D Scene screen spawns an entity with `Position3D` at the drop point (a ray on the `y = 0` plane) and `Model3D("")`. +- **Component:** dropping a component from the catalog onto an object adds it to that entity. + +### 4. Inspector contributions + +| Extension point | Proposal | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ecs.paramPresets` | `euler`: slots `x, y, z`, all numbers in degrees, shown with a wrap at ±180 and a dial. Used by `Rotation3D`. | +| `ecs.paramPresets` | `vector` with a uniform-scale lock for `Scale3D` (like `size`'s ratio lock). | +| `ecs.fieldEditors` | `ref` editors for `@nanoforge-dev/graphics-3d/three#Color` and `#Vector3`, for user components that take Three.js objects as params. | +| `color` preset | Already fits the `color` string params of the shape components. | + +### 5. Toolbar + +- **Screenshot:** use `graphics-capture` for 3D apps. +- **Pop-out:** already works. +- **Zoom / pixel-perfect:** these are 2D-only. Hide them for 3D, or map zoom to camera zoom. + +## Questions for the session + +1. Should a source change restart the game automatically while playing, or stay manual? +2. Should the 3D Scene screen live in the ECS plugin (next to the 2D one) or in its own plugin? +3. Picking in the running game: are bounds-based picks on the editor side enough, or should we add a `graphics-pick` command answered by the engine (exact meshes)? +4. Should the editor camera be saved per project, and should there be a "view from game camera" toggle? diff --git a/docs/engine/graphics-3d/index.mdx b/docs/engine/graphics-3d/index.mdx new file mode 100644 index 0000000..4c3e34f --- /dev/null +++ b/docs/engine/graphics-3d/index.mdx @@ -0,0 +1,129 @@ +--- +title: "Graphics 3D" +icon: "cube" +description: "Render a 3D scene with @nanoforge-dev/graphics-3d, built on Three.js" +--- + +# Graphics 3D + +`@nanoforge-dev/graphics-3d` renders a 3D scene in the game's container with [Three.js](https://threejs.org/). It was chosen in the [3D graphics library benchmark](/docs/engine/lib-graphic-3d/index). + +- **Client only.** `__init` throws on a server (no container). +- **One graphics library per app.** It uses the `graphics` key, like graphics-2d, so an app registers one or the other. +- **WebGPU first.** It uses WebGPU where the browser has it, and WebGL2 elsewhere. +- **Rendered by the engine.** One frame per tick, after the ECS systems. A paused game keeps its last image. + +## Your first 3D scene in 5 minutes + +The [`cube-3d` example](https://github.com/NanoForge-dev/Engine/tree/main/example/cube-3d) is this page as a complete app. + +### 1. Install + +```sh +pnpm add @nanoforge-dev/graphics-3d three +``` + +`three` is a peer dependency: the app installs it, so the game and Three.js add-ons share one copy. Also add `@types/three` (same version) if you import add-ons from `three/addons`. + +### 2. Register the library + +```ts +import { Graphics3DLibrary } from "@nanoforge-dev/graphics-3d"; + +const app = NanoforgeFactory.createClient({ + tickRate: 60, + viewport: { width: 1920, height: 1080, fit: "contain" }, +}); +const graphics = new Graphics3DLibrary(); +app.use(graphics); + +await app.init(options); +``` + +### 3. Add a light and an object + +Everything Three.js offers is imported from `@nanoforge-dev/graphics-3d/three`. Add objects to `graphics.scene` to show them. Without a light, `MeshStandardMaterial` objects are black. + +```ts +import { + BoxGeometry, + DirectionalLight, + HemisphereLight, + Mesh, + MeshStandardMaterial, +} from "@nanoforge-dev/graphics-3d/three"; + +const sun = new DirectionalLight("white", 3); +sun.position.set(3, 5, 4); +graphics.scene.add(new HemisphereLight("white", "#445566", 1), sun); + +const cube = new Mesh(new BoxGeometry(1, 1, 1), new MeshStandardMaterial({ color: "#44aa88" })); +graphics.scene.add(cube); +``` + +### 4. Place the camera + +The library starts with a perspective camera at `(0, 0, 5)`, looking at the origin. + +```ts +graphics.camera.position.set(0, 1.5, 4); +graphics.camera.lookAt(0, 0, 0); +``` + +### 5. Move things from a system + +The scene is drawn after the systems run, so a system changes objects and the next frame shows them. `ctx.app.delta` is in milliseconds. + +```ts +export function spin(registry: Registry, ctx: Context) { + registry.getZipper([Model]).forEach(({ Model }) => { + Model.object.rotation.y += ctx.app.delta / 1000; + }); +} +``` + +Systems reach the library through `ctx.graphics`. Do not keep the scene in a module-level variable. + +## Viewport + +The canvas follows `Context.viewport` like the 2D stage: + +- the camera's full frame is the design resolution (`width` × `height` in `createClient`); +- `contain` letterboxes it, `cover` crops it, `fill` stretches it; +- the canvas is resized on every window, fullscreen or pixel-ratio change. + +You never call `renderer.setSize`, and you never set a camera's `aspect` yourself. + +## `Context.graphics` + +| Member | What it is | +| ------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `scene` | The Three.js `Scene` rendered every tick. | +| `camera` | The camera used for rendering. Assign another one to switch; the viewport is applied to it. | +| `renderer` | The `WebGPURenderer`. Never call `setAnimationLoop`: the engine drives rendering. | +| `render` | Draws one frame. Assign your own function for post-processing (see [Advanced](/docs/engine/graphics-3d/advanced#render-loop)). | +| `backend` | `"webgpu"` or `"webgl"`. | +| `raycast(clientX, clientY, objects?)` | Objects under a page point (e.g. a `PointerEvent`), nearest first. | +| `worldToScreen(point)` | Where a world point is drawn in the page, in CSS px. | + +## Options + +```ts +new Graphics3DLibrary({ forceWebGL: true }); +``` + +| Option | Default | Effect | +| ------------ | ------- | ------------------------------------------------------ | +| `forceWebGL` | `false` | Use the WebGL2 backend even where WebGPU is available. | + +## Teardown + +When the game stops (or the editor restarts it), the library disposes everything in the scene: geometries, materials, their textures, and the scene's background and environment. It also disposes the renderer, removes the canvas and deletes `window.__THREE__`. + +Objects you removed from the scene yourself are not disposed by the library. Call their `dispose()` when you drop them. + +## Next + +- [Advanced](/docs/engine/graphics-3d/advanced): Three.js add-ons, custom shaders, cameras, picking, editor events. +- [Performance](/docs/engine/graphics-3d/performance): many objects, and `InstancedMesh`. +- [Editor proposal](/docs/engine/graphics-3d/editor-proposal): what the editor needs for a 3D Scene screen. diff --git a/docs/engine/graphics-3d/performance.mdx b/docs/engine/graphics-3d/performance.mdx new file mode 100644 index 0000000..6875cc0 --- /dev/null +++ b/docs/engine/graphics-3d/performance.mdx @@ -0,0 +1,56 @@ +--- +title: "Graphics 3D: performance" +icon: "gauge" +description: "Drawing many objects with @nanoforge-dev/graphics-3d" +--- + +# Graphics 3D: performance + +Each `Mesh` costs one draw call per frame. In the [benchmark POC](/docs/engine/lib-graphic-3d/poc), 2,000 meshes run at the display rate, while 20,000 run at about 12 FPS. + +When a frame has more than 2,000 draw calls, the library logs this warning once: + +``` +[graphics-3d] 2400 draw calls in one frame: the frame rate may drop. Draw many identical objects with one InstancedMesh (see the graphics-3d "Performance" docs page). +``` + +## Many identical objects: `InstancedMesh` + +An `InstancedMesh` draws many copies of one geometry and one material in a single draw call. Each copy has its own matrix (and optionally its own color). + +```ts +import { + BoxGeometry, + Color, + InstancedMesh, + MeshStandardMaterial, + Object3D, +} from "@nanoforge-dev/graphics-3d/three"; + +const count = 20_000; +const trees = new InstancedMesh(new BoxGeometry(0.2, 1, 0.2), new MeshStandardMaterial(), count); +const dummy = new Object3D(); + +for (let i = 0; i < count; i++) { + dummy.position.set((i % 200) - 100, 0.5, Math.floor(i / 200) - 50); + dummy.updateMatrix(); + trees.setMatrixAt(i, dummy.matrix); + trees.setColorAt(i, new Color().setHSL(0.3, 0.6, 0.3 + Math.random() * 0.2)); +} +ctx.graphics.scene.add(trees); +``` + +To move copies later, set their matrices again and flag the change: + +```ts +trees.setMatrixAt(index, dummy.matrix); +trees.instanceMatrix.needsUpdate = true; +``` + +With `raycast`, a hit on an instanced mesh carries `instanceId`, the index of the copy. + +## Other tips + +- Share geometries and materials between meshes instead of creating one per object. +- Merge static geometry that never moves (`mergeGeometries` from `three/addons/utils/BufferGeometryUtils.js`). +- Check `ctx.graphics.renderer.info.render.drawCalls` to see the cost of a frame. diff --git a/docs/engine/lib-graphic-3d/babylon-js.mdx b/docs/engine/lib-graphic-3d/babylon-js.mdx new file mode 100644 index 0000000..15b131f --- /dev/null +++ b/docs/engine/lib-graphic-3d/babylon-js.mdx @@ -0,0 +1,68 @@ +--- +title: "Babylon.js" +icon: "cube" +description: "Babylon.js in the 3D graphics library benchmark: verdict, integration notes and evidence per criterion" +--- + +# Babylon.js + +Part of the [3D graphics library benchmark](/docs/engine/lib-graphic-3d/index). Scores: ✅ meets, ⚠️ partly, ❌ does not, ❓ unknown. + +| | | +| ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| Package | `@babylonjs/core` (ES packages), plus `@babylonjs/loaders`, `@babylonjs/gui`, `@babylonjs/havok`, `@babylonjs/accessibility` as needed | +| Version | 9.34.0 | +| License | Apache-2.0 | +| Repository | [BabylonJS/Babylon.js](https://github.com/BabylonJS/Babylon.js) | +| Result | Finalist, first | +| Totals | ✅ 23 · ⚠️ 6 · ❌ 1 · ❓ 0 | + +## Verdict + +- The only library with something for player a11y: `@babylonjs/accessibility` mirrors tagged meshes as HTML for screen readers and keyboard navigation. +- Everything the editor needs is in core: picking, `GizmoManager`, editor cameras, scene serialization, a screenshot API. +- Clean engine integration: no hidden loop, no global left on `window`, types shipped, official Havok physics. +- Weak points: the bundle (424 KB gzip, 191 KB first chunk with code splitting), and in the POC its WebGPU backend was the slowest with 20,000 unbatched meshes (5.3 FPS, against 24.9 FPS on WebGL). + +## Integration notes + +- `__init`: `await EngineFactory.CreateAsync(canvas, {})` (WebGPU, then WebGL), or `new WebGPUEngine(canvas)` + `await initAsync()` with a WebGL `Engine` fallback. +- Tick: do not call `runRenderLoop`. Wrap each frame in `engine.beginFrame()`, `scene.render()`, `engine.endFrame()`: without them WebGPU never submits its commands and `CreateScreenshotAsync` never resolves (found in the POC). +- Viewport: `engine.setSize`, `setHardwareScalingLevel(1 / pixelRatio)`, camera `viewport` for the letterbox. +- `__clear`: `scene.dispose()`, `engine.dispose()`. Nothing to delete on `window`. +- Many entities: use instances or thin instances rather than `clone()` (3.1 s to set up 20,000 clones in the POC). + +## Evidence + +| Id | Score | Evidence | +| --- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| A1 | ✅ | `EngineFactory.CreateAsync` tries WebGPU, then WebGL, then `NullEngine`. [Docs](https://doc.babylonjs.com/setup/support/webGPU) | +| A2 | ⚠️ | Shadows, post-process and PBR on both; compute shaders are WebGPU only. [Status](https://doc.babylonjs.com/setup/support/webGPU/webGPUStatus) | +| A3 | ✅ | Built-in materials and `NodeMaterial` emit GLSL and WGSL; hand-written shaders need both. [Docs](https://doc.babylonjs.com/setup/support/webGPU/webGPUWGSL) | +| A4 | ✅ | WebGPU where available; WebGL2/1 fallback for mobile and older browsers. | +| B1 | ⚠️ | POC: 60 FPS (vsync cap) with 2,000 meshes; with 20,000 unbatched meshes 24.9 FPS on WebGL but 5.3 FPS on WebGPU (p95 340 ms). See [POC](/docs/engine/lib-graphic-3d/poc). | +| B2 | ❌ | Measured 1.81 MB raw, 424 KB gzip (WebGPU + fallback, deep imports). WebGL only: 344 KB. Code splitting: 191 KB first chunk. | +| B3 | ⚠️ | POC: about 345 ms to the first frame with 2,000 meshes, about 3.1 s with 20,000 (`clone()` per mesh). See [POC](/docs/engine/lib-graphic-3d/poc). | +| B4 | ✅ | OffscreenCanvas in a worker is documented. [Docs](https://doc.babylonjs.com/features/featuresDeepDive/scene/offscreenCanvas) | +| C1 | ✅ | `new Engine(canvas)` / `new WebGPUEngine(canvas)` takes our canvas. | +| C2 | ✅ | `runRenderLoop` is opt-in; from our tick call `engine.beginFrame()`, `scene.render()`, `engine.endFrame()` (POC: without them WebGPU never submits and screenshots never resolve). | +| C3 | ✅ | `scene.dispose()` and `engine.dispose()`; POC: no global left on `window` in the browser (ES packages; only the UMD build sets `window.BABYLON`). | +| C4 | ✅ | `engine.resize()`, `setHardwareScalingLevel()`, `adaptToDeviceRatio`, camera `viewport`. | +| C5 | ✅ | Measured: `Maths/math.vector.js` imports and computes in Node 24 with no DOM. | +| C6 | ⚠️ | No entity system imposed, but `TransformNode`/`Mesh` are heavy OOP objects. | +| D1 | ✅ | `scene.pick(x, y)`, `createPickingRay`, `Vector3.Project`. [Docs](https://doc.babylonjs.com/features/featuresDeepDive/mesh/interactions/picking_collisions) | +| D2 | ✅ | `GizmoManager` in core: position, rotation, scale, bounding box. [Docs](https://doc.babylonjs.com/features/featuresDeepDive/mesh/gizmo) | +| D3 | ✅ | ArcRotate, Universal and Free cameras; `scene.activeCamera` switch. | +| D4 | ✅ | `SceneSerializer`, `.babylon` JSON, `AssetContainer`. [Docs](https://doc.babylonjs.com/setup/support/.babylonFileFormat) | +| D5 | ✅ | POC: `CreateScreenshotAsync` and `canvas.toDataURL()` give a painted PNG on both backends, once frames are wrapped in `beginFrame`/`endFrame`. | +| D6 | ✅ | POC: the canvas moved into another document (iframe) keeps rendering on both backends, no error. A real `window.open` window is not tested. | +| E1 | ✅ | Large docs and a Playground with thousands of samples; hello cube and glTF in about 10 lines each. [Playground](https://playground.babylonjs.com) | +| E2 | ⚠️ | `@babylonjs/accessibility` mirrors tagged meshes as HTML for screen readers and keyboard navigation; no reduced-motion support. [Docs](https://doc.babylonjs.com/features/featuresDeepDive/accessibility/accessibilityScreenReader) | +| E3 | ⚠️ | Image processing and custom post-process, no built-in colorblind filter; GUI scales with `idealWidth`. | +| F1 | ✅ | Apache-2.0; Havok plugin MIT; no SaaS. | +| F2 | ✅ | 26k stars, about 1,700 commits and 100+ releases in 12 months, 369k npm downloads per week. | +| F3 | ✅ | Written in TypeScript, ships `.d.ts`. | +| F4 | ✅ | glTF via `@babylonjs/loaders`; KTX2/Basis, Draco, meshopt, skeletal and morph animation. | +| G1 | ✅ | `PBRMaterial`, cascaded shadows, IBL. | +| G2 | ✅ | Physics v2 with the official Havok plugin (`@babylonjs/havok`). | +| G3 | ✅ | `@babylonjs/gui`, sprites, text; Konva on top with a transparent `clearColor`. | diff --git a/docs/engine/lib-graphic-3d/index.mdx b/docs/engine/lib-graphic-3d/index.mdx new file mode 100644 index 0000000..113a6e1 --- /dev/null +++ b/docs/engine/lib-graphic-3d/index.mdx @@ -0,0 +1,189 @@ +--- +title: "3D graphics library benchmark" +icon: "cube" +description: "Comparison of 3D libraries with WebGPU and a WebGL fallback, for the game and the editor" +--- + +# 3D graphics library benchmark + +NanoForge needs a 3D graphics library next to `graphics-2d` (Konva). It must render with WebGPU and fall back to WebGL by itself, perform well, and be accessible. It is used by the game and by the editor (Scene screen, entity drag, screenshots, pop-out window). + +Benchmark run on 2026-11-05. + +## Decision + +**NanoForge uses [Three.js](/docs/engine/lib-graphic-3d/three-js)**, confirmed after a discussion with the team. + +Babylon.js scores higher (23 ✅ against 19 ✅), but Three.js was chosen for: + +- a lighter bundle (222 KB gzip against 424 KB) and a faster start (about 60 ms against 350 ms to the first frame); +- the same performance on WebGPU and WebGL in the POC; +- by far the largest ecosystem, examples and community. + +What the `graphics-3d` library has to handle itself, from the benchmark: + +- player a11y (E2): nothing is built in; +- the internal `requestAnimationFrame` loop that runs until `renderer.dispose()` (C2); +- deleting `window.__THREE__` in `__clear` (C3); +- types from the separate `@types/three` package (F3); +- physics through our own integration (G2). + +## Method + +- Each library is scored on every criterion: ✅ meets it, ⚠️ partly or with a workaround, ❌ does not, ❓ unknown (not measured or not tested yet). +- Each score has one line of evidence: official docs, the library's source, or a measurement. +- **Measured:** B2 (bundle size) and C5 (math in Node) for every candidate; B1, B3, C3, D5 and D6 in a browser for the two finalists (see [POC](/docs/engine/lib-graphic-3d/poc)). Everything else comes from docs and source code. +- **Eliminatory:** A1, and every ❌ in families C and D. Those decide whether the library can be integrated at all. + +## Criteria + +### A. Rendering and compatibility + +| Id | Criterion | Description | How it is measured | +| --- | ------------------ | ----------------------------------------------------------------------- | -------------------------------------------------------- | +| A1 | WebGL fallback | Falls back to WebGL by itself when WebGPU is missing, without app code. | Docs and source of the device/engine creation. | +| A2 | Backend parity | Features lost on WebGL (shadows, post-process, compute…). | Docs of WebGPU status; list of WebGPU-only features. | +| A3 | Write-once shaders | One material or custom shader source runs on both backends. | Docs of the shader/material system (TSL, NodeMaterial…). | +| A4 | Browser targets | Chrome, Firefox, Safari, mobile. | Docs and caniuse for WebGPU; WebGL2 support otherwise. | + +### B. Performance + +| Id | Criterion | Description | How it is measured | +| --- | --------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | +| B1 | FPS under load | Frame time of a typical scene (many meshes, instancing) on each backend. | In-browser POC scene, 2,000 and 20,000 meshes (finalists only). | +| B2 | Bundle size | Minimal cost of a game. The loader caches games per file and the editor tracks its chunk sizes. | Minimal scene (renderer, camera, box, material, light), `esbuild --bundle --minify --format=esm`, then `gzip -9`. | +| B3 | Init time | Time from `__init` to the first frame. | In-browser POC, time to the first frame (finalists only). | +| B4 | Off main thread | OffscreenCanvas and worker rendering. | Docs and constructor types. | + +### C. Engine integration + +Modelled on `Graphics2DLibrary` (`modules/graphics-2d`). + +| Id | Criterion | Description | How it is measured | +| --- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| C1 | Provided container | Renders into a canvas or element we give it, without its own page or app shell. | Constructor API. | +| C2 | Render from our tick | A frame can be rendered on demand from the engine tick, with no forced `requestAnimationFrame` loop. Needed for pause and step in the editor. | Source of the render loop. | +| C3 | Clean teardown | `__clear` destroys everything: no GPU leak, no leftover global (we already delete `window.Konva`). | Dispose API; globals added on import, checked in Node and in the bundle. | +| C4 | Follows the viewport | Resize, pixel ratio, letterbox, pixel perfect, from `ViewportState`. | Resize, pixel ratio and viewport APIs. | +| C5 | Math on the server | `Vector3`, `Quaternion` and matrices import in Node or Bun without a DOM, for components shared by client and server. | `node` ESM import of the math classes and one transform. | +| C6 | ECS friendly | A light scene graph we sync from our components, not an entity system of its own. | Docs of the scene model. | + +### D. Editor integration + +| Id | Criterion | Description | How it is measured | +| --- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| D1 | Picking | Screen to object raycast, and world to screen projection (the editor outlines entities over the game from the `viewport` event). | Picking and projection APIs. | +| D2 | Transform gizmos | Translate, rotate, scale, in the library or an official addon. | Docs and package contents. | +| D3 | Editor camera | Orbit and fly controls, separate from the game camera. | Official controls. | +| D4 | Scene from data | Builds the scene from the static model of `main.ts`, without running the game (what the 2D Scene screen does). | Serialization / scene loading APIs. | +| D5 | Canvas capture | PNG screenshot on WebGPU and WebGL. | Screenshot API, or `toBlob` constraints per backend. | +| D6 | Pop-out window | Rendering survives the canvas moving to another window or document. | In-browser POC: canvas moved to another document (finalists only). | + +### E. Accessibility + +| Id | Criterion | Description | How it is measured | +| --- | ---------------- | -------------------------------------------------------------------------------------- | ------------------------------------------ | +| E1 | Ease of learning | Docs quality, number of examples, effort for a hello cube with a glTF model. | Docs, example count, size of a hello cube. | +| E2 | Player a11y | 3D objects exposed to the DOM and ARIA, keyboard navigation, `prefers-reduced-motion`. | Docs and source search. | +| E3 | Visual a11y | Colorblind post-process, contrast, UI scaling. | Docs of post-process and UI. | + +### F. Ecosystem and sustainability + +| Id | Criterion | Description | How it is measured | +| --- | ---------- | -------------------------------------------------------------- | ------------------------------- | +| F1 | License | MIT or Apache, no proprietary part or mandatory SaaS. | `LICENSE` and package metadata. | +| F2 | Activity | Commits and releases over 12 months, maintainers (bus factor). | GitHub and npm APIs. | +| F3 | TypeScript | Shipped types and their quality. | Package contents. | +| F4 | Assets | glTF, KTX2/Basis, Draco, skeletal animation. | Docs of loaders. | + +### G. Game features + +| Id | Criterion | Description | How it is measured | +| --- | ------------------- | -------------------------------------------------- | ------------------ | +| G1 | Materials and light | PBR, shadows, environment lighting. | Docs. | +| G2 | Physics | Official integration or plugin. | Docs. | +| G3 | UI in 3D | Text, sprites, 2D overlay (combinable with Konva). | Docs. | + +## Candidates + +| Library | Version | License | +| ------------------------------------------------------------------------- | -------------- | ---------- | +| [Three.js](https://github.com/mrdoob/three.js) (`three/webgpu`) | r187 (0.187.0) | MIT | +| [Babylon.js](https://github.com/BabylonJS/Babylon.js) (`@babylonjs/core`) | 9.34.0 | Apache-2.0 | +| [PlayCanvas Engine](https://github.com/playcanvas/engine) (`playcanvas`) | 2.23.3 | MIT | +| [luma.gl](https://github.com/visgl/luma.gl) (`@luma.gl/*`) | 9.4.2 | MIT | + +### Eliminated at A1 + +| Library | Reason | +| ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [Galacean Engine](https://github.com/galacean/engine) 1.6.13 | No WebGPU backend, including the 2.0 alphas. | +| [LayaAir](https://github.com/layabox/LayaAir) 3.4.2 | WebGPU is picked at build time (separate WebGPU and WebGL bundles), no runtime fallback. The WebGPU driver is closed source and the engine is not on npm. | +| [RedGPU](https://github.com/redcamel/RedGPU) | WebGPU only. | +| Orillusion, TypeGPU | WebGPU only. | + +## Results + +| | Three.js | Babylon.js | PlayCanvas | luma.gl | +| -------------------------- | --------- | ---------- | ---------- | ---------- | +| A1 WebGL fallback | ✅ | ✅ | ✅ | ✅ | +| A2 Backend parity | ⚠️ | ⚠️ | ⚠️ | ⚠️ | +| A3 Write-once shaders | ✅ | ✅ | ⚠️ | ❌ | +| A4 Browser targets | ✅ | ✅ | ✅ | ✅ | +| B1 FPS under load | ⚠️ | ⚠️ | ❓ | ❓ | +| B2 Bundle size (gzip) | ⚠️ 222 KB | ❌ 424 KB | ⚠️ 279 KB | ⚠️ 112 KB | +| B3 Init time | ✅ | ⚠️ | ❓ | ❓ | +| B4 Off main thread | ⚠️ | ✅ | ⚠️ | ⚠️ | +| C1 Provided container | ✅ | ✅ | ✅ | ✅ | +| C2 Render from our tick | ⚠️ | ✅ | ⚠️ | ✅ | +| C3 Clean teardown | ⚠️ | ✅ | ⚠️ | ⚠️ | +| C4 Follows the viewport | ✅ | ✅ | ✅ | ✅ | +| C5 Math on the server | ✅ | ✅ | ✅ | ✅ | +| C6 ECS friendly | ⚠️ | ⚠️ | ❌ | ✅ | +| D1 Picking | ✅ | ✅ | ✅ | ⚠️ | +| D2 Transform gizmos | ✅ | ✅ | ✅ | ❌ | +| D3 Editor camera | ✅ | ✅ | ✅ | ✅ | +| D4 Scene from data | ✅ | ✅ | ⚠️ | ⚠️ | +| D5 Canvas capture | ✅ | ✅ | ⚠️ | ⚠️ | +| D6 Pop-out window | ✅ | ✅ | ❓ | ❓ | +| E1 Ease of learning | ✅ | ✅ | ✅ | ⚠️ | +| E2 Player a11y | ❌ | ⚠️ | ❌ | ❌ | +| E3 Visual a11y | ⚠️ | ⚠️ | ⚠️ | ❌ | +| F1 License | ✅ | ✅ | ✅ | ✅ | +| F2 Activity | ✅ | ✅ | ✅ | ⚠️ | +| F3 TypeScript | ⚠️ | ✅ | ✅ | ✅ | +| F4 Assets | ✅ | ✅ | ✅ | ⚠️ | +| G1 Materials and light | ✅ | ✅ | ✅ | ⚠️ | +| G2 Physics | ⚠️ | ✅ | ⚠️ | ❌ | +| G3 UI in 3D | ✅ | ✅ | ✅ | ⚠️ | +| **✅ Meets** | **19** | **23** | **15** | **10** | +| **⚠️ Partly** | **10** | **6** | **10** | **12** | +| **❌ Does not** | **1** | **1** | **2** | **5** | +| **❓ Unknown** | **0** | **0** | **3** | **3** | +| **Eliminatory (A1, C, D)** | passes | passes | fails (C6) | fails (D2) | + +## Findings + +- **PlayCanvas** is out on C6: its own entity-component system would compete with ours. [Details](/docs/engine/lib-graphic-3d/playcanvas) +- **luma.gl** is out on D2: no transform gizmo, and it is a GPU layer more than a 3D engine. [Details](/docs/engine/lib-graphic-3d/luma-gl) +- **Babylon.js** leads (23 ✅). [Details](/docs/engine/lib-graphic-3d/babylon-js) + - the only library with something for player a11y (`@babylonjs/accessibility`); + - picking, gizmos, editor cameras, serialization and screenshots all in core; no hidden loop and no global left on `window`; + - weak points: the bundle (424 KB gzip, 191 KB first chunk with code splitting), a slower start (about 350 ms), and a WebGPU backend that stalled with 20,000 unbatched meshes in the POC. +- **Three.js** is second (19 ✅). [Details](/docs/engine/lib-graphic-3d/three-js) + - lighter (222 KB gzip), starts in about 60 ms, the same speed on both backends, by far the largest ecosystem; + - but an internal `requestAnimationFrame` loop runs until `dispose()`, the import leaves `window.__THREE__`, types are a separate package, physics is only example wrappers, and nothing exists for a11y. +- **POC:** both finalists render from our tick, capture PNGs and survive a move to another document on both backends. With 2,000 meshes both reach the display rate. [Details](/docs/engine/lib-graphic-3d/poc) + +## Pages + +- [Three.js](/docs/engine/lib-graphic-3d/three-js): verdict, integration notes, evidence. +- [Babylon.js](/docs/engine/lib-graphic-3d/babylon-js): verdict, integration notes, evidence. +- [PlayCanvas](/docs/engine/lib-graphic-3d/playcanvas): verdict, integration notes, evidence. +- [luma.gl](/docs/engine/lib-graphic-3d/luma-gl): verdict, integration notes, evidence. +- [POC](/docs/engine/lib-graphic-3d/poc): in-browser measurements of the two finalists. + +## Next steps + +- Build a `graphics-3d` library on Three.js, following `Graphics2DLibrary` (see the [integration notes](/docs/engine/lib-graphic-3d/three-js#integration-notes)). +- Measure with instancing, and on Firefox, Safari and mobile. diff --git a/docs/engine/lib-graphic-3d/luma-gl.mdx b/docs/engine/lib-graphic-3d/luma-gl.mdx new file mode 100644 index 0000000..4f074bf --- /dev/null +++ b/docs/engine/lib-graphic-3d/luma-gl.mdx @@ -0,0 +1,66 @@ +--- +title: "luma.gl" +icon: "cube" +description: "luma.gl in the 3D graphics library benchmark: verdict and evidence per criterion" +--- + +# luma.gl + +Part of the [3D graphics library benchmark](/docs/engine/lib-graphic-3d/index). Scores: ✅ meets, ⚠️ partly, ❌ does not, ❓ unknown. + +| | | +| ---------- | ---------------------------------------------------------------------------------------------------------------- | +| Packages | `@luma.gl/core`, `@luma.gl/webgpu`, `@luma.gl/webgl`, `@luma.gl/engine`, `@luma.gl/shadertools`, `@math.gl/core` | +| Version | 9.4.2 (`@math.gl/core` 4.1.0) | +| License | MIT | +| Repository | [visgl/luma.gl](https://github.com/visgl/luma.gl) | +| Result | Eliminated (D2) | +| Totals | ✅ 10 · ⚠️ 12 · ❌ 5 · ❓ 3 | + +## Verdict + +- A GPU abstraction layer more than a 3D engine: no built-in lit material, shaders are hand-written in both WGSL and GLSL. +- The best fit for our ECS (no entity system, no render loop, light `Model` objects) and the lightest bundle. +- Eliminated on D2: no transform gizmo. The editor would also need its own CPU raycast and world to screen projection. +- About 90% of commits come from one person; most downloads come from deck.gl, not standalone 3D use. + +## Integration notes + +- `__init`: `await luma.createDevice({ type: 'best-available', adapters: [webgpuAdapter, webgl2Adapter], createCanvasContext: { canvas } })`. +- `__clear`: `device.destroy()`, then delete the `globalThis.luma`, `mathgl`, `probe` and `Probe` globals set on import. +- `@math.gl/core` alone (8.7 KB gzip) works in Node and could serve shared components whatever the renderer. + +## Evidence + +| Id | Score | Evidence | +| --- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| A1 | ✅ | `luma.createDevice({ type: 'best-available', adapters: [webgpuAdapter, webgl2Adapter] })`. [Docs](https://luma.gl/docs/api-guide/background/webgpu-vs-webgl) | +| A2 | ⚠️ | No compute or storage buffers on WebGL2; 9.4 shadows are WebGPU only. | +| A3 | ❌ | App shaders need WGSL and GLSL; the Slang transpiler is still alpha. | +| A4 | ✅ | WebGL2 everywhere, WebGPU where available. | +| B1 | ❓ | Not measured; no 3D scene benchmark. | +| B2 | ⚠️ | Measured 399 KB raw, 112 KB gzip, without any built-in lit material (hand-written shaders). | +| B3 | ❓ | Async `createDevice`. Not measured. | +| B4 | ⚠️ | Canvas type accepts `OffscreenCanvas`; no worker docs. | +| C1 | ✅ | `createCanvasContext` with our canvas or container. [Docs](https://luma.gl/docs/api-reference/core/canvas-context) | +| C2 | ✅ | No rAF in core; `AnimationLoop` is optional. | +| C3 | ⚠️ | `destroy()` APIs; import sets `globalThis.luma`, `mathgl`, `probe`, `Probe`. | +| C4 | ✅ | `autoResize`, `useDevicePixels`, `pixelSizeSource`. | +| C5 | ✅ | Measured: `@math.gl/core` imports in Node 24 with no DOM (8.7 KB gzip). | +| C6 | ✅ | No entity system; `Model` per entity or optional `ScenegraphNode`. | +| D1 | ⚠️ | GPU picking only; no CPU raycast, world to screen by hand. | +| D2 | ❌ | No transform gizmo. | +| D3 | ✅ | `OrbitControls` in `@luma.gl/engine` 9.4. | +| D4 | ⚠️ | No scene format; glTF load and export only. | +| D5 | ⚠️ | No screenshot helper; `toBlob` right after `submit()`, untested. | +| D6 | ❓ | Not tested; the device belongs to the original window's `navigator.gpu`. | +| E1 | ⚠️ | 135 examples but low level: a hello cube needs hand-written WGSL and GLSL. | +| E2 | ❌ | No a11y features. | +| E3 | ❌ | No colorblind or contrast features. | +| F1 | ✅ | MIT. | +| F2 | ⚠️ | Active (about 1,000 commits in 12 months), but about 90% from one person; downloads come mostly from deck.gl. | +| F3 | ✅ | Written in TypeScript, detailed `.d.ts`. | +| F4 | ⚠️ | glTF with skin, morph and animation; Draco needs `@loaders.gl/draco` added. | +| G1 | ⚠️ | PBR and IBL; shadows only in `@luma.gl/experimental`, WebGPU only. | +| G2 | ❌ | No physics integration. | +| G3 | ⚠️ | `TextRenderer`, no sprite or UI system. | diff --git a/docs/engine/lib-graphic-3d/playcanvas.mdx b/docs/engine/lib-graphic-3d/playcanvas.mdx new file mode 100644 index 0000000..6ef93bd --- /dev/null +++ b/docs/engine/lib-graphic-3d/playcanvas.mdx @@ -0,0 +1,65 @@ +--- +title: "PlayCanvas" +icon: "cube" +description: "PlayCanvas in the 3D graphics library benchmark: verdict and evidence per criterion" +--- + +# PlayCanvas + +Part of the [3D graphics library benchmark](/docs/engine/lib-graphic-3d/index). Scores: ✅ meets, ⚠️ partly, ❌ does not, ❓ unknown. + +| | | +| ---------- | --------------------------------------------------------- | +| Package | `playcanvas` | +| Version | 2.23.3 | +| License | MIT (the SaaS editor is optional) | +| Repository | [playcanvas/engine](https://github.com/playcanvas/engine) | +| Result | Eliminated (C6) | +| Totals | ✅ 15 · ⚠️ 10 · ❌ 2 · ❓ 3 | + +## Verdict + +- Solid engine with editor tools (picking, official gizmos, camera controls) and good docs. +- Eliminated on C6: rendering goes through its own `Entity` + `ComponentSystem` model (render, camera and light are components). It would run a second ECS next to ours, or force us to drive low-level `GraphNode`/`MeshInstance` objects, which is not the documented use. +- Driving it from our tick works (`app.update(dt)` + `app.render()` without `app.start()`), but it is not documented. + +## Integration notes + +- `__init`: `await createGraphicsDevice(canvas, { deviceTypes: ['webgpu', 'webgl2'] })`, then `new AppBase(canvas)` with only the component systems we need (the measured 279 KB gzip). +- `__clear`: `app.destroy()` and `device.destroy()`; the static `AppBase._applications` registry keeps an entry per canvas id. +- Physics through the official components needs ammo.js as a global `Ammo`, which cannot be shared with a Node server. + +## Evidence + +| Id | Score | Evidence | +| --- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| A1 | ✅ | `createGraphicsDevice(canvas, { deviceTypes: ['webgpu', 'webgl2'] })` always appends WebGL2 as a last fallback. [Docs](https://developer.playcanvas.com/user-manual/graphics/webgpu/) | +| A2 | ⚠️ | Shadows, post-process and clustered lighting on both; compute is WebGPU only; WebGPU documented as maturing. | +| A3 | ⚠️ | Built-in materials run on both; custom `ShaderMaterial` needs GLSL and WGSL. | +| A4 | ✅ | WebGL2 everywhere, WebGPU where available. | +| B1 | ❓ | Not measured; no official benchmark. | +| B2 | ⚠️ | Measured 1.08 MB raw, 279 KB gzip (`AppBase` with render, camera and light systems). | +| B3 | ❓ | Async `createGraphicsDevice`. Not measured. | +| B4 | ⚠️ | No documented worker rendering path. | +| C1 | ✅ | `new AppBase(canvas)` takes our canvas. | +| C2 | ⚠️ | `app.start()` runs its own rAF loop; `update(dt)` + `render()` from our tick works but is not documented. | +| C3 | ⚠️ | `app.destroy()`, `device.destroy()`; static `AppBase._applications` registry, physics needs a global `Ammo`. | +| C4 | ✅ | `resizeCanvas`, `setCanvasResolution`, `setCanvasFillMode`, `maxPixelRatio`, camera `rect`. | +| C5 | ✅ | Measured: `Vec3`, `Quat`, `Mat4` import and compute in Node 24 with no DOM. | +| C6 | ❌ | Imposes its own Entity + ComponentSystem model. [Docs](https://developer.playcanvas.com/user-manual/ecs/) | +| D1 | ✅ | `screenToWorld`, `worldToScreen`, `Picker`. | +| D2 | ✅ | Official translate, rotate, scale gizmos and view cube. [Docs](https://developer.playcanvas.com/user-manual/gizmos/) | +| D3 | ✅ | Official `camera-controls` script (orbit, fly). | +| D4 | ⚠️ | Scene and template formats target the SaaS editor export. | +| D5 | ⚠️ | `toBlob` with `preserveDrawingBuffer` on WebGL; on WebGPU right after render or from a render target. | +| D6 | ❓ | Not tested; the device is tied to the canvas context. | +| E1 | ✅ | Large manual, 300+ live examples, hello cube in about 10 lines. [Examples](https://playcanvas.vercel.app/) | +| E2 | ❌ | No ARIA or reduced-motion support. | +| E3 | ⚠️ | No colorblind filter; UI screen scale modes. | +| F1 | ✅ | Engine MIT; the SaaS editor is optional. | +| F2 | ✅ | 17k stars, nightly betas, 148k npm downloads per week, maintained by Snap. | +| F3 | ✅ | Ships `playcanvas.d.ts`, generated from JSDoc. | +| F4 | ✅ | glTF/GLB, KTX2/Basis, Draco, skeletal animation and anim state graph. | +| G1 | ✅ | PBR `StandardMaterial`, clustered lights, cascaded shadows, IBL. | +| G2 | ⚠️ | Official rigidbody components rely on ammo.js as a global. | +| G3 | ✅ | Element component (MSDF text, images), sprites, screen-space UI. | diff --git a/docs/engine/lib-graphic-3d/poc.mdx b/docs/engine/lib-graphic-3d/poc.mdx new file mode 100644 index 0000000..911d1e0 --- /dev/null +++ b/docs/engine/lib-graphic-3d/poc.mdx @@ -0,0 +1,70 @@ +--- +title: "3D benchmark POC" +icon: "flask" +description: "In-browser proof of concept for the two finalists, Three.js and Babylon.js" +--- + +# 3D benchmark POC + +In-browser proof of concept for the two finalists of the [3D graphics library benchmark](/docs/engine/lib-graphic-3d/index): [Three.js](/docs/engine/lib-graphic-3d/three-js) and [Babylon.js](/docs/engine/lib-graphic-3d/babylon-js). It fills the criteria that docs alone could not answer: B1, B3, D5, D6, and checks C2 and C3 in a real browser. + +Run on 2026-11-05. + +## Setup + +- **Machine:** Apple M5, macOS. +- **Browser:** Chrome 153, headless, with `--enable-unsafe-webgpu` and background throttling disabled, driven by Playwright. +- **Versions:** `three` 0.187.0, `@babylonjs/core` 9.34.0. +- **Runs:** 3 per configuration, medians reported. Spot checks in a visible 120 Hz browser gave the same results. + +## Scene + +The same scene in both libraries: + +- an 800×600 canvas; +- a perspective camera, an ambient (hemispheric) light and a directional light; +- N boxes sharing one geometry and one PBR material (`MeshStandardMaterial` / `PBRMetallicRoughnessMaterial`), on a grid; +- every frame, each box gets a new rotation, then the scene renders. + +The frame is rendered from our own `requestAnimationFrame` loop, which stands for the engine tick: Babylon's `runRenderLoop` is not used. Meshes are plain objects, without instancing or batching, which is what a naive ECS sync would produce. + +## Tests + +| Id | Test | +| --- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| B3 | Time from creating the renderer to the first frame shown (two `requestAnimationFrame` after the first render). Library import time is excluded. | +| B1 | Frame time over 5 seconds: average FPS and 95th percentile. N = 2,000 (a small game) and N = 20,000 (stress). | +| D5 | PNG right after a render, with `canvas.toDataURL()` and the library's own API (Babylon `CreateScreenshotAsync`), checked to contain more than the clear color. | +| D6 | The canvas is moved with `adoptNode` into a same-origin iframe (another document, as in a pop-out window) and renders 10 more frames; then a PNG is checked. | +| C3 | After dispose, the list of `window` keys added since before the import. | + +## Results + +| Library | Backend | N | Init (ms) | FPS | p95 frame (ms) | D5 capture | D6 other document | Globals left | +| ---------- | ------- | ------ | --------- | ---- | -------------- | ---------- | ----------------- | ------------ | +| Three.js | WebGPU | 2,000 | 57 | 60.1 | 16.8 | ✅ | ✅ | `__THREE__` | +| Three.js | WebGL | 2,000 | 58 | 60.0 | 17.3 | ✅ | ✅ | `__THREE__` | +| Babylon.js | WebGPU | 2,000 | 348 | 59.5 | 17.2 | ✅ | ✅ | none | +| Babylon.js | WebGL | 2,000 | 341 | 59.9 | 17.2 | ✅ | ✅ | none | +| Three.js | WebGPU | 20,000 | 367 | 11.7 | 90.5 | ✅ | ✅ | `__THREE__` | +| Three.js | WebGL | 20,000 | 327 | 12.4 | 83.9 | ✅ | ✅ | `__THREE__` | +| Babylon.js | WebGPU | 20,000 | 3,129 | 5.3 | 340.3 | ✅ | ✅ | none | +| Babylon.js | WebGL | 20,000 | 3,064 | 24.9 | 40.3 | ✅ | ✅ | none | + +Headless Chrome caps at 60 FPS, so 2,000 meshes run at the cap for both. In the visible browser (120 Hz) they ran at 120 FPS for both. + +## Findings + +- **B1:** with 2,000 meshes both reach the display rate. With 20,000 unbatched meshes neither is playable: Three.js gives about 12 FPS on both backends, Babylon.js 25 FPS on WebGL but 5 FPS on WebGPU with long stalls (p95 340 ms). Both libraries offer instancing for this case, which the POC does not use. +- **B3:** Three.js reaches the first frame in about 60 ms, Babylon.js in about 350 ms. With 20,000 meshes Babylon takes about 3 s, spent in `clone()`. +- **C2 (Babylon.js):** rendering from our tick needs `engine.beginFrame()` and `engine.endFrame()` around `scene.render()`. Without them, WebGPU frames are never submitted and `CreateScreenshotAsync` never resolves. This is not in the getting-started docs. +- **D5:** both capture a painted PNG on both backends, provided the capture happens right after a render. +- **D6:** both keep rendering after the canvas moves to another document, on both backends, with no error. +- **C3:** Babylon.js leaves nothing on `window`; Three.js leaves `window.__THREE__`. +- **Cold start:** the very first run of Three.js in a fresh browser took 3.4 s (WebGPU) and 27.6 s (WebGL) to the first frame. It did not happen again, including in new pages, so it is most likely the GPU shader cache warming up. Not investigated further. + +## Limits + +- One machine and one browser (Chrome on Apple Silicon). Firefox, Safari and mobile are not measured. +- D6 uses a same-origin iframe, not a real `window.open` pop-out window (popups need a user gesture in the test browser). +- The stress scene is not optimized (no instancing, no frozen meshes), so it measures the default per-object cost, not the best case. diff --git a/docs/engine/lib-graphic-3d/three-js.mdx b/docs/engine/lib-graphic-3d/three-js.mdx new file mode 100644 index 0000000..9a0e354 --- /dev/null +++ b/docs/engine/lib-graphic-3d/three-js.mdx @@ -0,0 +1,67 @@ +--- +title: "Three.js" +icon: "cube" +description: "Three.js in the 3D graphics library benchmark: verdict, integration notes and evidence per criterion" +--- + +# Three.js + +Part of the [3D graphics library benchmark](/docs/engine/lib-graphic-3d/index). Scores: ✅ meets, ⚠️ partly, ❌ does not, ❓ unknown. + +| | | +| ---------- | ----------------------------------------------------- | +| Package | `three` (`three/webgpu` entry, `WebGPURenderer`) | +| Version | r187 (0.187.0) | +| License | MIT | +| Repository | [mrdoob/three.js](https://github.com/mrdoob/three.js) | +| Result | **Chosen** (second on score) | +| Totals | ✅ 19 · ⚠️ 10 · ❌ 1 · ❓ 0 | + +## Verdict + +- Lighter than Babylon.js (222 KB gzip) and by far the largest ecosystem (33.5M npm downloads per week). +- Fast to start: 57 ms to the first frame with 2,000 meshes in the POC, and the same speed on WebGPU and WebGL. +- Editor needs are covered by official addons: `Raycaster`, `TransformControls`, `OrbitControls`, `ObjectLoader`. +- Weak points: an internal `requestAnimationFrame` loop runs until `dispose()` even when we render from our tick, the import leaves `window.__THREE__`, types are a separate package (`@types/three`), physics is only example wrappers, and nothing exists for player a11y. + +## Integration notes + +- `__init`: `new WebGPURenderer({ canvas })`, `await renderer.init()`. The WebGL2 fallback is automatic; `forceWebGL: true` forces it. +- Tick: `renderer.render(scene, camera)` from our loop. Capture with `canvas.toDataURL()` right after it. +- Viewport: `setSize(visibleWidth, visibleHeight, false)`, `setPixelRatio(pixelRatio)`, `camera.setViewOffset` for the origin. +- `__clear`: dispose geometries, materials and textures we created, `await renderer.dispose()`, then `delete window.__THREE__` (as we do for `window.Konva`). + +## Evidence + +| Id | Score | Evidence | +| --- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| A1 | ✅ | `WebGPURenderer` switches to its WebGL2 backend by itself; `forceWebGL` forces it. [Docs](https://threejs.org/docs/#api/en/renderers/webgpu/WebGPURenderer) | +| A2 | ⚠️ | Shadows and TSL post-processing on both; storage textures, indirect draw and full compute are reduced on WebGL2. [Manual](https://threejs.org/manual/#en/webgpurenderer) | +| A3 | ✅ | TSL and node materials compile to WGSL and GLSL from one source. [TSL](https://github.com/mrdoob/three.js/wiki/Three.js-Shading-Language) | +| A4 | ✅ | WebGPU on Chrome/Edge 113+, Safari 26, Firefox 141+ (Windows); WebGL2 elsewhere. [caniuse](https://caniuse.com/webgpu) | +| B1 | ⚠️ | POC: 60 FPS (vsync cap) with 2,000 meshes; 11.7 FPS on WebGPU and 12.4 on WebGL with 20,000 unbatched meshes. See [POC](/docs/engine/lib-graphic-3d/poc). | +| B2 | ⚠️ | Measured 818 KB raw, 222 KB gzip. The `three/webgpu` entry pulls the whole node system. | +| B3 | ✅ | POC: 57 ms to the first frame with 2,000 meshes, about 350 ms with 20,000, on both backends. See [POC](/docs/engine/lib-graphic-3d/poc). | +| B4 | ⚠️ | OffscreenCanvas documented for WebGL; WebGPU in a worker not verified. [Manual](https://threejs.org/manual/#en/offscreencanvas) | +| C1 | ✅ | Takes our `canvas`, or `renderer.domElement` goes in any container. | +| C2 | ⚠️ | `render()` can be called from our tick, but it starts an internal rAF bookkeeping loop that runs until `dispose()`. | +| C3 | ⚠️ | `await renderer.dispose()`, plus `.dispose()` on each geometry, material, texture. POC: `window.__THREE__` stays after dispose. | +| C4 | ✅ | `setSize`, `setPixelRatio`, `setViewport`, `setScissor`, `camera.setViewOffset`. | +| C5 | ✅ | Measured: `Vector3`, `Quaternion`, `Matrix4` import and compute in Node 24 with no DOM. | +| C6 | ⚠️ | `Object3D` imposes no entity system, but it is a heavy OOP hierarchy to keep in sync. | +| D1 | ✅ | `Raycaster.setFromCamera`, `Vector3.project(camera)`. [Docs](https://threejs.org/docs/#api/en/core/Raycaster) | +| D2 | ✅ | Official `TransformControls` addon. | +| D3 | ✅ | Official `OrbitControls`, `MapControls`, `FlyControls`, `ArcballControls`. | +| D4 | ✅ | `Object3D.toJSON()` and `ObjectLoader`. [Docs](https://threejs.org/docs/#api/en/loaders/ObjectLoader) | +| D5 | ✅ | POC: `canvas.toDataURL()` right after `render()` gives a painted PNG on WebGPU and WebGL, without `preserveDrawingBuffer`. | +| D6 | ✅ | POC: the canvas moved into another document (iframe) keeps rendering on both backends, no error. A real `window.open` window is not tested. | +| E1 | ✅ | Large manual, about 500 official examples, hello cube with `GLTFLoader` in about 20 lines. [Examples](https://threejs.org/examples/) | +| E2 | ❌ | No ARIA, keyboard navigation or reduced-motion support. | +| E3 | ⚠️ | No built-in colorblind pass; writable as a TSL post-process. | +| F1 | ✅ | MIT, no SaaS. | +| F2 | ✅ | About 2,300 commits in 12 months, monthly releases, 117k stars, 33.5M npm downloads per week. | +| F3 | ⚠️ | Types in the separate `@types/three`, sometimes behind a release. | +| F4 | ✅ | `GLTFLoader`, `KTX2Loader`, `DRACOLoader`, `AnimationMixer`. | +| G1 | ✅ | `MeshStandardMaterial`, `MeshPhysicalMaterial`, shadow maps, PMREM/IBL. | +| G2 | ⚠️ | No official physics; basic Rapier, Jolt and Ammo wrappers in the examples. | +| G3 | ✅ | Sprites, `CSS2DRenderer`/`CSS3DRenderer`, troika-three-text; Konva on top or as a `CanvasTexture`. | diff --git a/docs/engine/navigation.json b/docs/engine/navigation.json new file mode 100644 index 0000000..2f15896 --- /dev/null +++ b/docs/engine/navigation.json @@ -0,0 +1,60 @@ +[ + { + "group": "Getting started", + "pages": [ + "docs/engine/getting-started/index", + "docs/engine/getting-started/how-to-use", + "docs/engine/getting-started/documentation" + ] + }, + { + "group": "Registry", + "pages": [ + "docs/engine/registry/index", + "docs/engine/registry/writing-web-assembly" + ] + }, + { + "group": "Network", + "pages": [ + "docs/engine/network/index", + "docs/engine/network/network-client", + "docs/engine/network/network-server", + "docs/engine/network/network-peer", + "docs/engine/network/packet-framing", + "docs/engine/network/network-client-api", + "docs/engine/network/network-server-api" + ] + }, + { + "group": "Graphics 3D", + "pages": [ + "docs/engine/graphics-3d/index", + "docs/engine/graphics-3d/advanced", + "docs/engine/graphics-3d/performance" + ] + }, + { + "group": "Editor", + "pages": [ + "docs/engine/editor/protocol" + ] + }, + { + "group": "Design notes", + "pages": [ + "docs/engine/graphics-3d/editor-proposal", + { + "group": "3D graphics library benchmark", + "pages": [ + "docs/engine/lib-graphic-3d/index", + "docs/engine/lib-graphic-3d/three-js", + "docs/engine/lib-graphic-3d/babylon-js", + "docs/engine/lib-graphic-3d/playcanvas", + "docs/engine/lib-graphic-3d/luma-gl", + "docs/engine/lib-graphic-3d/poc" + ] + } + ] + } +] diff --git a/docs/engine/network/index.mdx b/docs/engine/network/index.mdx new file mode 100644 index 0000000..3bca845 --- /dev/null +++ b/docs/engine/network/index.mdx @@ -0,0 +1,24 @@ +--- +title: "Network Overview" +icon: "book" +description: "Overview of the engine networking docs" +--- + +# Network Overview + +This page describes the engine's networking libraries: `network-server` and `network-client`. Together they provide a small, pragmatic networking layer used by the example `pong-network` game. The same apps can also run without a game server, hosted by one of the players. + +## Goals + +- Keep the protocol minimal and predictable for multiplayer games. +- Let each packet pick its delivery guarantees through four channels: reliable or unreliable, ordered or unordered. +- Use well-understood transports: TCP for the reliable channels and UDP (WebRTC) for low-latency, best-effort ones. + +## Related Pages + +- [Network Client](/docs/engine/network/network-client) +- [Network Server](/docs/engine/network/network-server) +- [Packet Channels](/docs/engine/network/packet-framing) +- [Network Server API](/docs/engine/network/network-server-api) +- [Network Client API](/docs/engine/network/network-client-api) +- [Peer-to-peer Networking](/docs/engine/network/network-peer) diff --git a/docs/engine/network/network-client-api.mdx b/docs/engine/network/network-client-api.mdx new file mode 100644 index 0000000..3f34987 --- /dev/null +++ b/docs/engine/network/network-client-api.mdx @@ -0,0 +1,155 @@ +--- +title: "network-client API" +icon: "book" +description: "API reference for the client networking package" +--- + +# network-client API + +`NetworkClientLibrary` is exposed on `ctx.network`. Its methods take an optional +`{ channel }` to pick one of the four [channels](/docs/engine/network/packet-framing): +`Channel.ReliableOrdered`, `Channel.ReliableUnordered`, +`Channel.UnreliableOrdered` or `Channel.UnreliableUnordered`. + +Reliable channels need `SERVER_TCP_PORT` and unreliable ones `SERVER_UDP_PORT`. +Using a channel whose port is not configured throws. + +The client connects during `__init`, so its channels are open once the game runs. +TCP connects first, then UDP with the TCP session token, so both share one client +id. `__init` rejects when a transport fails, or when its channels are not open +within 10 seconds. + +```ts +import { Channel } from "@nanoforge-dev/network/client"; + +ctx.network.sendData({ type: "join" }); // Channel.ReliableOrdered +ctx.network.sendData({ x: 1, y: 2 }, { channel: Channel.UnreliableOrdered }); + +const messages = ctx.network.getReceivedPackets().map((packet) => packet.json()); // every channel +``` + +## sendData(data, options?) + +Send a payload to the server. + +Parameter `data`: [`NetworkPayload`](#networkpayload), bytes, a string or any +JSON value. + +Option `channel`: `Channel` to send on. `Channel.ReliableOrdered` by default. + +Throws a `TypeError` when `data` cannot be encoded as JSON (`undefined`, a +function). + +Returns: `void` + +## getReceivedPackets(options?) + +Return the packets received since the last call. Call it once per frame: +packets left unread for a whole tick are dropped. Typed packets never show up +here. + +Option `channel`: `Channel` to read from. Without it, the packets of every +configured channel are returned, reliable channels first. + +Returns: [`NetworkData[]`](#networkdata) + +## packets + +Typed packets, declared with `definePacket` (see below). +Packets of a type are routed to its listeners and to `read`, never to +`getReceivedPackets`. + +### packets.on(packet, listener) + +Call `listener(data, { channel, ctx })` for every packet of this type, each tick +before the ECS systems (not while paused). Packets are dispatched in the order +they arrived, reliable channels first. A listener that throws, or returns a +rejected promise, is logged and does not stop the others. + +Returns: `() => void`, a function that removes the listener. + +### packets.read(packet) + +Return the packets of this type received this tick, as `{ data, channel }[]`. +Meant for ECS systems, which run after the packets are dispatched. + +Returns: `{ data: T; channel: Channel }[]` + +### packets.send(packet, data?, options?) + +Send a packet to the server. `data` must match the definition's payload type and +is encoded as JSON. Leave it out for a packet without payload, declared without +a type: `send(Play)`. + +Option `channel`: `Channel` to send on. The definition's channel by default. + +Throws a `TypeError` when `data` cannot be encoded as JSON. + +Returns: `void` + +## definePacket(name, options?) + +Declare a packet type, in a file both apps import. Also exported by +`@nanoforge-dev/network` itself, for that shared file. + +Parameter `name`: `string`, 1 to 255 UTF-8 bytes, unique in the game. It is +written in front of every packet of this type. + +Option `channel`: `Channel` used when `send` gets no `channel`. +`Channel.ReliableOrdered` by default. + +Option `validate`: `(data: unknown) => data is T`, run on every received payload +before listeners and `read`. Packets that fail it are dropped with a warning. + +Throws when the name is empty or too long, and later, in `packets.on` or `read`, +when another definition of the same name has another channel or `validate`. + +Returns: `PacketDefinition`. Without a type, `T` is `void`: the packet +carries no payload. + +```ts +export const Move = definePacket<{ id: number; x: number; y: number }>("move", { + channel: Channel.UnreliableOrdered, +}); +``` + +## isConnected(options?) + +Return `true` when packets can be sent and received. + +Option `channel`: `Channel` to check. Without it, every configured channel must +be connected. + +Returns: `boolean` + +## clientId + +Client id assigned by the server, shared by TCP and UDP. `undefined` until +the server has welcomed the client. It is only kept in memory: a page +reload gets a new id. + +Type: `string | undefined` + +## NetworkPayload + +What `sendData` accepts. Its payload carries no format tag: the receiver reads +a packet the way it was sent. + +| Value | Encoded as | Read back with | +| -------------------------------------------------- | --------------------- | ----------------------------- | +| `Uint8Array`, `ArrayBuffer`, any `ArrayBufferView` | The bytes as they are | `bytes()` or `arrayBuffer()` | +| `string` | UTF-8 text | `text()` | +| `NetworkData` | Its bytes, unchanged | What the original sender used | +| Any other value (object, array, number, …) | `JSON.stringify` text | `json()` | + +## NetworkData + +One received packet. Its methods are synchronous and return a new value on +every call. + +| Method | Returns | +| --------------- | -------------------------------------------------------------------------- | +| `bytes()` | `Uint8Array`: the payload bytes. | +| `arrayBuffer()` | `ArrayBuffer`: the payload bytes. | +| `text()` | `string`: the payload decoded as UTF-8. | +| `json()` | `T`: the payload parsed as JSON. Throws a `SyntaxError` if it is not JSON. | diff --git a/docs/engine/network/network-client.mdx b/docs/engine/network/network-client.mdx new file mode 100644 index 0000000..74a71e1 --- /dev/null +++ b/docs/engine/network/network-client.mdx @@ -0,0 +1,89 @@ +--- +title: "Client Networking (network-client)" +icon: "book" +description: "How the client-side networking package works" +--- + +# Client Networking (network-client) + +This document describes how the `network-client` package connects to a `network-server` instance and the concrete APIs used from client-side code. + +## Overview + +A client connects to a single server instance and sends every packet on one of +four [channels](/docs/engine/network/packet-framing), picked with the `channel` option: + +- `Channel.ReliableOrdered` (the default) and `Channel.ReliableUnordered`, + carried by a TCP WebSocket, for control commands such as join, play, and input. +- `Channel.UnreliableOrdered` and `Channel.UnreliableUnordered`, carried by + WebRTC data channels, for server snapshots or low-latency updates. + +## Example + +```javascript +import { Channel } from "@nanoforge-dev/network/client"; + +// Send a value as JSON, on Channel.ReliableOrdered +network.sendData({ hello: "world" }); + +// Or pick another channel +network.sendData({ x: 1 }, { channel: Channel.UnreliableOrdered }); + +// Strings are sent as UTF-8 text, bytes as they are +network.sendData("hello"); +network.sendData(new Uint8Array([1, 2, 3])); + +// Receive the server packets of every channel +const latestPackets = network.getReceivedPackets(); + +// Read each packet the way it was sent: json(), text(), bytes() or arrayBuffer() +const decodedPackets = latestPackets.map((packet) => packet.json()); +``` + +## Typed packets + +Instead of switching on a `type` field, declare each packet type once, in a file +both the client and the server import, and let the library route packets to it. + +```ts +// shared/protocol.ts +import { Channel, definePacket } from "@nanoforge-dev/network"; + +export const Play = definePacket("play"); // no payload +export const Input = definePacket<{ key: "up" | "down" }>("input"); +export const Move = definePacket<{ id: number; x: number; y: number }>("move", { + channel: Channel.UnreliableOrdered, // default channel of this type +}); +``` + +```ts +// client: listen once, after app.init() +const off = network.packets.on(Move, (move, { channel, ctx }) => { + applyMove(ctx.ecs.registry, move); // `move` is typed +}); + +// or read this tick's packets from an ECS system +export const applyMoves = (registry, ctx) => { + for (const { data } of ctx.network.packets.read(Move)) applyMove(registry, data); +}; + +// send: the payload is checked against the definition +ctx.network.packets.send(Input, { key: "up" }); // Channel.ReliableOrdered +ctx.network.packets.send(Play); // no payload to give +``` + +- Listeners are called every tick before the ECS systems, in the order the + packets arrived, reliable channels first. They are not called while the game + is paused: packets wait for the next tick. +- `read` returns the packets of the current tick; a system that does not read + them every tick misses some. +- Typed packets never appear in `getReceivedPackets`, which only returns the + packets sent with `sendData`. +- A packet type with no listener and no reader is dropped with a warning, + printed once per type. + +## Notes + +- See [Network Client API](/docs/engine/network/network-client-api) for the full list of available functions, + and for how each kind of payload is encoded. +- For the channels and how packets are framed on each, see [Packet Channels](/docs/engine/network/packet-framing). diff --git a/docs/engine/network/network-peer.mdx b/docs/engine/network/network-peer.mdx new file mode 100644 index 0000000..9bb52cf --- /dev/null +++ b/docs/engine/network/network-peer.mdx @@ -0,0 +1,134 @@ +--- +title: "Peer-to-peer Networking" +icon: "book" +description: "Run the same client and server apps without a game server: one player hosts" +--- + +# Peer-to-peer Networking + +A game made of a client app and a server app can run **without a game server**. +The first player to open the game hosts it: their browser tab runs the server +app next to their client app. The other players join that tab over WebRTC, on +the same four [channels](/docs/engine/network/packet-framing) and typed packets. + +Nothing changes in the game code: the same systems, components and +`ctx.network` APIs run in both modes. Only one line of configuration picks the +mode. + +## Turning it on + +In the workspace `nanoforge.config.ts`: + +```ts +import { defineConfig } from "@nanoforge-dev/config"; + +export default defineConfig({ + type: "workspace", + packages: ["apps/*"], + network: "p2p", // "dedicated" (default) runs the server app in Bun +}); +``` + +The environment is the same as with a dedicated server: + +```dotenv +NANOFORGE_CLIENT_SERVER_ADDRESS=127.0.0.1 +NANOFORGE_CLIENT_SERVER_TCP_PORT=4445 +NANOFORGE_SERVER_LISTENING_TCP_PORT=4445 + +# STUN for every player; add a TURN server for players behind strict NATs +NANOFORGE_ICE_SERVERS=stun:stun.cloudflare.com:3478 +``` + +## How it works + +``` + server process (Bun): signaling only + ╱ ╲ + host tab ───────── player tab one WebRTC connection per player, + server app ╲ carrying the four channels + + client app╲───── player tab +``` + +- `nf build` builds the server app a second time, for the browser, into the + client's output (`server/`). The engine picks browser builds of + `@nanoforge-dev/ecs/server` and `@nanoforge-dev/network/server` on its own. +- `nf start` sets `NETWORK_MODE=p2p` for both apps. The Bun server process then + only pairs players for the WebRTC handshake, on `LISTENING_TCP_PORT`. Game + traffic never goes through it, and one process serves any number of games. + The server app still starts there, with no players: its sends do nothing. +- A page opened **without** `?room=` hosts: its client app starts the server + app in the same tab and joins it through an in-memory loopback. The server + app gets the client's environment. +- A page opened **with** `?room=CODE` joins that game's host over WebRTC. +- The host and its client app keep separate worlds, exactly as on two machines. + +## Inviting players + +The host logs its invite link to the console. The game can also show it: + +| `ctx.network` member | Host | Player who joined | Dedicated mode | +| -------------------- | --------------------- | --------------------- | -------------- | +| `roomCode` | `"ABC234"` | `"ABC234"` | `undefined` | +| `inviteLink` | page URL `?room=CODE` | page URL `?room=CODE` | `undefined` | + +```ts +export const showInvite = (registry: Registry, ctx: Context) => { + const link = ctx.network.inviteLink; + if (link) inviteText.text(`Invite your friends: ${link}`); +}; +``` + +## Developing, testing and deploying + +- **Editor:** play runs the game in dedicated mode. The game code is the same in + both modes. +- **Locally:** `nf build && nf start`, open the game, then open the logged + invite link in a second tab. +- **Hosted:** build and enable a host as usual. Each player who opens the game + without a link hosts their own game, so one host serves many games at once. + +## Players coming and going + +- **A player joins.** `server.clients.onConnect` fires on the host once the + player's four channels are open, so the listener can already send to it. +- **A player leaves.** `server.clients.onDisconnect` fires as soon as the + signaling server reports it gone, a data channel closes, or its connection + fails. +- **The host leaves.** The game ends: the signaling server closes the room, and + each player's `isConnected()` turns `false` about a second later. + +## Limits + +- **Message size.** Keep each packet at or below 64 KiB: WebRTC data channels + cap message size. +- **`ReliableUnordered` is really unordered**, unlike over a dedicated server's + WebSocket. +- **NAT.** A direct connection fails for some pairs of players, typically on + strict corporate or mobile networks. A TURN server in `ICE_SERVERS` relays + them; the default list only has STUN servers. +- **Trust.** The host runs the server app, so it can cheat. Check what players + send with `definePacket`'s `validate`. Anyone with the room code can join. +- **Background tabs.** Browsers slow down timers in hidden tabs, so the server + app in the host's tab times its ticks with a Web Worker: the game keeps its + pace for every player when the host switches tabs. Only the host's own view + slows down while hidden. +- **Server environment.** The server app gets the client's environment: + `NANOFORGE_SERVER_*` variables do not reach it in this mode. + +## Signaling protocol + +JSON text frames, at most 64 KiB each: + +| Who | Sends | Server forwards | +| ------ | ------------------------------------ | ------------------------------------- | +| Host | connects without a `room` | `{type:"room", room}` to the host | +| Player | connects with `?room=CODE` | HTTP 404 when the room does not exist | +| Player | any frame (its WebRTC offer and ICE) | `{type:"signal", from, data}` to host | +| Host | `{type:"signal", to, data}` | `data` to that player of its room | +| Player | closes | `{type:"leave", from}` to the host | +| Host | closes | close code `4001` to its players | + +The host welcomes a player (`{type:"welcome", id, token}`) once its data +channels are open, so players speak the same protocol as with a dedicated UDP +server. diff --git a/docs/engine/network/network-server-api.mdx b/docs/engine/network/network-server-api.mdx new file mode 100644 index 0000000..942ab12 --- /dev/null +++ b/docs/engine/network/network-server-api.mdx @@ -0,0 +1,209 @@ +--- +title: "network-server API" +icon: "book" +description: "API reference for the server networking package" +--- + +# network-server API + +## ClientId + +`string`: an opaque, random identifier (UUID) of a client session. A client +connected over both TCP and UDP has the same `ClientId` on both servers. + +## Methods + +`NetworkServerLibrary` is exposed on `ctx.network`. Its methods take an optional +`{ channel }` to pick one of the four [channels](/docs/engine/network/packet-framing): +`Channel.ReliableOrdered`, `Channel.ReliableUnordered`, +`Channel.UnreliableOrdered` or `Channel.UnreliableUnordered`. + +Reliable channels need `LISTENING_TCP_PORT` and unreliable ones +`LISTENING_UDP_PORT`. Using a channel whose port is not configured throws. + +```ts +import { Channel } from "@nanoforge-dev/network/server"; + +ctx.network.sendToAll({ type: "start" }); // Channel.ReliableOrdered +ctx.network.sendToAll({ x: 1, y: 2 }, { channel: Channel.UnreliableUnordered }); + +ctx.network.getReceivedPackets().forEach((packets, clientId) => { + const messages = packets.map((packet) => packet.json()); // every channel +}); +``` + +### sendToAll(data, options?) + +Send a payload to every client reachable on the channel. + +Parameter `data`: [`NetworkPayload`](#networkpayload), bytes, a string or any +JSON value. + +Option `channel`: `Channel` to send on. `Channel.ReliableOrdered` by default. + +Throws a `TypeError` when `data` cannot be encoded as JSON (`undefined`, a +function). + +Returns: `void` + +### sendToClient(clientId, data, options?) + +Send a payload to one client. Logs an error when the client is not reachable on +the channel. + +Parameter `clientId`: `ClientId` client identifier. + +Parameter `data`: [`NetworkPayload`](#networkpayload), bytes, a string or any +JSON value. + +Option `channel`: `Channel` to send on. `Channel.ReliableOrdered` by default. + +Returns: `void` + +### getReceivedPackets(options?) + +Return the packets each client sent since the last call. Call it once per +frame: packets left unread for a whole tick are dropped. Typed packets never +show up here. + +Option `channel`: `Channel` to read from. Without it, the packets of every +configured channel are merged per client, reliable channels first. + +Returns: `Map`, see [NetworkData](#networkdata) + +### getConnectedClients(options?) + +Return a snapshot array of the clients reachable on the channel: clients with an +open WebSocket for reliable channels, clients with the channel's data channel for +unreliable ones. + +Option `channel`: `Channel` to check. Without it, clients reachable on any +configured channel. + +Returns: `ClientId[]` + +### getClientInfo(clientId) + +Return what is known about a client session. See [ClientInfo](#clientinfo). + +Parameter `clientId`: `ClientId` + +Returns: `ClientInfo | undefined` (`undefined` once the client is gone) + +## packets (`ctx.network.packets`) + +Typed packets, declared with `definePacket` (see the +[network-client API](/docs/engine/network/network-client-api)). Packets of a type +are routed to its listeners and to `read`, never to `getReceivedPackets`. + +### on(packet, listener) + +Call `listener(data, { clientId, channel, ctx })` for every packet of this type, +each tick before the ECS systems (not while paused). Packets are dispatched in +the order they arrived, reliable channels first. A listener that throws, or +returns a rejected promise, is logged and does not stop the others. + +Returns: `() => void`, a function that removes the listener. + +### read(packet) + +Return the packets of this type received this tick, as +`{ data, clientId, channel }[]`. Meant for ECS systems, which run after the +packets are dispatched. + +Returns: `{ data: T; clientId: ClientId; channel: Channel }[]` + +### sendToAll(packet, data?, options?) + +Send a packet to every client reachable on the channel. `data` must match the +definition's payload type and is encoded as JSON. Leave it out for a packet +without payload: `sendToAll(Start)`. + +Option `channel`: `Channel` to send on. The definition's channel by default. + +Throws a `TypeError` when `data` cannot be encoded as JSON. + +### sendToClient(clientId, packet, data?, options?) + +Send a packet to one client, like `sendToAll`. + +## NetworkPayload + +What `sendToAll` and `sendToClient` accept. Their payload carries no format +tag: the receiver reads a packet the way it was sent. + +| Value | Encoded as | Read back with | +| -------------------------------------------------- | --------------------- | ----------------------------- | +| `Uint8Array`, `ArrayBuffer`, any `ArrayBufferView` | The bytes as they are | `bytes()` or `arrayBuffer()` | +| `string` | UTF-8 text | `text()` | +| `NetworkData` | Its bytes, unchanged | What the original sender used | +| Any other value (object, array, number, …) | `JSON.stringify` text | `json()` | + +Passing a received `NetworkData` relays a client's packet as it is. + +## NetworkData + +One received packet. Its methods are synchronous and return a new value on +every call. + +| Method | Returns | +| --------------- | -------------------------------------------------------------------------- | +| `bytes()` | `Uint8Array`: the payload bytes. | +| `arrayBuffer()` | `ArrayBuffer`: the payload bytes. | +| `text()` | `string`: the payload decoded as UTF-8. | +| `json()` | `T`: the payload parsed as JSON. Throws a `SyntaxError` if it is not JSON. | + +## clients (`ctx.network.clients`) + +Client sessions shared by the TCP and UDP servers. Also available as +`NetworkServerLibrary.clients`. + +### get(clientId) + +Returns: `ClientInfo | undefined` + +### list() + +Return every connected client session. + +Returns: `ClientInfo[]` + +### onConnect(listener) + +Call `listener(info)` when a new client session starts, i.e. when its first +transport is up. With TCP and UDP, it fires on TCP open, before UDP is linked: +`sendToClient(info.id)` on an unreliable channel may still report an unknown +client at that point. With UDP only, it fires when the signaling socket opens, +before the data channels exist, so it may also report an unknown client. + +Returns: `() => void` that removes the listener. + +### onDisconnect(listener) + +Call `listener(info)` when a client session ends, i.e. when its last transport +closes. + +Returns: `() => void` that removes the listener. + +## ClientInfo + +| Field | Type | Description | +| ------------- | ------------------------------------------------ | ------------------------------------------------- | +| `id` | `ClientId` | Session identifier. | +| `connectedAt` | `number` | Timestamp (ms) of the first transport connection. | +| `transports` | `{ tcp?: ConnectionInfo; udp?: ConnectionInfo }` | Transports currently attached (live object). | + +## ConnectionInfo + +| Field | Type | Description | +| ------------- | ------------------------ | ----------------------------------------------------------- | +| `transport` | `"tcp" \| "udp"` | Transport of this connection. | +| `address` | `string` | Remote address. | +| `port` | `number` | Remote port. | +| `family` | `string` | `"IPv4"` or `"IPv6"`. | +| `userAgent` | `string \| undefined` | `User-Agent` header of the upgrade request. | +| `origin` | `string \| undefined` | `Origin` header of the upgrade request. | +| `params` | `Record` | Query parameters of the upgrade request, without the token. | +| `connectedAt` | `number` | Timestamp (ms) of the upgrade request. | + +`Cookie` and `Authorization` headers are never recorded. diff --git a/docs/engine/network/network-server.mdx b/docs/engine/network/network-server.mdx new file mode 100644 index 0000000..88a18f4 --- /dev/null +++ b/docs/engine/network/network-server.mdx @@ -0,0 +1,107 @@ +--- +title: "Server Networking (network-server)" +icon: "book" +description: "How the server-side networking package works" +--- + +# Server Networking (network-server) + +This document explains the `network-server` package implementation and the APIs used from server-side code. + +## Overview + +The server listens on configured ports and accepts client connections. A single server process can accept many clients, and typical responsibilities in a game are: + +- Accept reliable control messages from clients on `Channel.ReliableOrdered` + and `Channel.ReliableUnordered`, carried by a TCP WebSocket. +- Optionally establish `RTCPeerConnection`s via WebSocket signaling for + `Channel.UnreliableOrdered` and `Channel.UnreliableUnordered`, carried by WebRTC data + channels, for low-latency state updates. + +See [Packet Channels](/docs/engine/network/packet-framing) for what each channel guarantees. + +## Client identification + +Every client gets a `ClientId`: a random string (UUID) shared by the TCP and UDP +transports. + +1. The first transport a client opens starts a session. The server answers with a + `welcome` message carrying the id and a secret session token (a text frame on + TCP, where game data is always binary, and a JSON message on the UDP signaling + socket). +2. The client presents that token (`?token=...`) when it opens its other + transport, which joins the same session. An unknown token, or a second + connection on a transport the session already has, is rejected with `401`. +3. The session ends when its last transport closes. + +A page reload opens a new session, with a new `ClientId`. + +```javascript +network.clients.onConnect((info) => { + console.log(`${info.id} joined from ${info.transports.tcp?.address}`); +}); + +network.clients.onDisconnect((info) => { + console.log(`${info.id} left`); +}); + +// Anytime: what is known about a client +const info = network.clients.get(clientId); +``` + +`onConnect` fires as soon as the first transport is up, so when both transports +are used, UDP may not be linked yet. + +## Example + +```javascript +import { Channel } from "@nanoforge-dev/network/server"; + +// Send everybody a value as JSON, on Channel.ReliableOrdered +network.sendToAll({ type: "are you here" }); + +// Or pick another channel +network.sendToAll({ x: 1 }, { channel: Channel.UnreliableUnordered }); + +// Check connected clients (ClientId strings) +const connectedClients = network.getConnectedClients(); + +// Receive the packets of every channel +const allPackets = network.getReceivedPackets(); + +// Get first client packets +const firstClientPackets = allPackets.get(connectedClients[0]); + +// Read each packet the way it was sent: json(), text(), bytes() or arrayBuffer() +const decodedPackets = firstClientPackets.map((packet) => packet.json()); +``` + +## Typed packets + +The server uses the same packet types as the client, from the shared protocol +file (see [Typed packets](/docs/engine/network/network-client#typed-packets)). Its listeners and +`read` also get the sender. + +```ts +import { Input, Move, Play } from "../../shared/protocol"; + +// listen once, after app.init() +network.packets.on(Input, ({ key }, { clientId, ctx }) => { + handleInput(clientId, key, ctx); +}); + +// or read this tick's packets from an ECS system +for (const { data, clientId } of ctx.network.packets.read(Input)) handleInput(clientId, data.key); + +// send to everybody or to one client, on the definition's channel by default +ctx.network.packets.sendToAll(Move, { id: 1, x: 2, y: 3 }); +ctx.network.packets.sendToClient(clientId, Move, { id: 1, x: 2, y: 3 }); +``` + +Payloads come from the clients, so check the ones the game cannot trust with +the `validate` option of `definePacket`. + +## Notes + +- See [Network Server API](/docs/engine/network/network-server-api) for the full list of available functions. +- For the channels and how packets are framed on each, see [Packet Channels](/docs/engine/network/packet-framing). diff --git a/docs/engine/network/packet-framing.mdx b/docs/engine/network/packet-framing.mdx new file mode 100644 index 0000000..d69c7e2 --- /dev/null +++ b/docs/engine/network/packet-framing.mdx @@ -0,0 +1,72 @@ +--- +title: "Packet Channels" +icon: "book" +description: "The four delivery channels and how packets are framed on each" +--- + +# Packet Channels + +Every packet is sent on one of four channels, picked with the `channel` option +of the network methods, for example +`ctx.network.sendData(data, { channel: Channel.UnreliableOrdered })`. Without +it, packets are sent on `Channel.ReliableOrdered`, and typed packets on the +channel of their definition. Pick the channel by what the +packet needs: whether it may be lost, and whether an older packet is still +useful once a newer one has arrived. + +| Channel | Lost? | Order | Carried by | Typical use | +| --------------------- | -------- | ------------------------ | ------------------- | ------------------------------ | +| `ReliableOrdered` | Never | Send order | TCP WebSocket | Join, chat, game events | +| `ReliableUnordered` | Never | No promise | TCP WebSocket | Independent one-off messages | +| `UnreliableOrdered` | Possibly | Late packets are dropped | WebRTC data channel | Positions, snapshots | +| `UnreliableUnordered` | Possibly | Any order | WebRTC data channel | Fire-and-forget effects, pings | + +The reliable channels need a TCP port (`SERVER_TCP_PORT` / `LISTENING_TCP_PORT`), +the unreliable ones a UDP port (`SERVER_UDP_PORT` / `LISTENING_UDP_PORT`). +Using a channel whose port is not configured throws. + +Over TCP, `ReliableUnordered` is delivered in order in practice: it only +promises that nothing is lost. + +## Framing + +Both transports deliver whole messages, so one message is one packet: there is +no delimiter and payloads may contain any bytes. + +Every packet starts with the name of its packet type: one length byte, then the +name in UTF-8, then the payload. + +- **Typed packets** (`ctx.network.packets.send`, see + [Typed packets](/docs/engine/network/network-client#typed-packets)) carry the name given to + `definePacket`, and their payload is the `JSON.stringify` text of the data, + or nothing for a packet without payload. + The receiver routes them to the listeners and `read` of that type. +- **`sendData` packets** have a length of `0`, so no name. Their payload carries + no format tag: bytes are sent as they are, a string as its UTF-8 text, and any + other value as its `JSON.stringify` text. The receiver gets a `NetworkData` + from `getReceivedPackets` and reads it the way it was sent, with `bytes()`, + `text()` or `json()`. + +``` +typed : [4]["move"][{"id":1,"x":2}] +sendData : [0][payload] +``` + +- **TCP**: each binary WebSocket frame starts with one tag byte, `0` for + `ReliableOrdered` and `1` for `ReliableUnordered`, followed by the packet. + Text frames are reserved for control messages such as the server `welcome`. +- **WebRTC**: the client opens one data channel per unreliable channel, labelled + `unreliable-ordered` and `unreliable-unordered`. Both use `ordered: false` and + `maxRetransmits: 0`. + +## Dropping late packets + +Each `UnreliableOrdered` message starts with a big-endian `uint32` sequence +number, followed by the packet; the number is counted per peer and per +direction. The receiver delivers a packet only if it is +newer than the last one it delivered, and drops it otherwise. Nothing ever waits +for a lost packet: a gap is skipped as soon as a newer packet arrives. Numbers +are compared as serial numbers, so the counter can wrap around. + +The sequence is shared by every packet type sent on the channel: a late packet +is dropped even when the newer one was of another type. diff --git a/docs/engine/registry/index.mdx b/docs/engine/registry/index.mdx new file mode 100644 index 0000000..ac8647b --- /dev/null +++ b/docs/engine/registry/index.mdx @@ -0,0 +1,21 @@ +--- +title: "Registry" +icon: "book" +description: "Registry and WebAssembly notes" +--- + +# Registry + +The registry class is written in C++ and exposed to WebAssembly using Emscripten. That choice keeps the performance benefits of C++ for entity and component management while still making the code available to web applications. + +## Design Choices + +This design makes some trade-offs between performance and ease of use. A pure C++ ECS would be easier to use on its own, but exposing it to WebAssembly means the interface has to balance clarity and browser-friendly integration. + +### Const Correctness + +In a regular C++ ECS, const correctness is a given, but when exposing C++ to WebAssembly the boundaries do not map perfectly to JavaScript. Methods that would typically return const references in C++ may return non-const references or copies when exposed to WebAssembly. We keep the const correctness in the C++ code to preserve intent and clarity within the C++ domain, even if it does not fully carry over to the WebAssembly interface. + +### Error Handling + +Any thrown exceptions in C++ will result in a runtime error in JavaScript. That can make error messages less descriptive or user-friendly than native JavaScript errors. To mitigate that, thorough testing and validation in the C++ code is recommended before issues reach the WebAssembly layer. diff --git a/docs/engine/registry/writing-web-assembly.mdx b/docs/engine/registry/writing-web-assembly.mdx new file mode 100644 index 0000000..6515dc8 --- /dev/null +++ b/docs/engine/registry/writing-web-assembly.mdx @@ -0,0 +1,21 @@ +--- +title: "Writing Web Assembly" +icon: "book" +description: "Guidance for WebAssembly modules" +--- + +# Writing Web Assembly + +## Code Splitting + +When writing WebAssembly modules, it is important to consider code splitting for readability and maintainability. We try to split binding and logic into separate files wherever possible. That keeps the codebase organized and makes it easier to navigate. + +For example, in the ECS package, the binding logic is in `.cpp` files while the core logic resides in `.hpp` files. That separation lets developers focus on either the bindings or the logic without having to work through both at the same time. + +## Documentation + +When documenting WebAssembly modules, we follow the same general approach as C++ documentation. Doxygen-style comments are used to provide clear explanations of classes, methods, and parameters. That documentation is important for developers who will use or maintain the modules because it provides the necessary context and usage information. + +## Logging + +Logging in WebAssembly is costly in memory because of the interaction between C++ and JavaScript. For that reason, logging from the JavaScript side is preferred whenever possible. If logging from C++ is necessary, be aware of the performance implications and the risk of memory leaks. WebAssembly memory is limited, so excessive logging can lead to out-of-memory errors. From e0f46502c34b390d0e474227409fa3906f598648 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 7 Nov 2026 00:40:38 +0100 Subject: [PATCH 03/11] chore(cli): deploy docs --- docs/cli/commands/build.mdx | 48 ++++++ docs/cli/commands/create.mdx | 57 +++++++ docs/cli/commands/dev.mdx | 30 ++++ docs/cli/commands/editor.mdx | 39 +++++ docs/cli/commands/install.mdx | 44 +++++ docs/cli/commands/new.mdx | 54 ++++++ docs/cli/commands/overview.mdx | 49 ++++++ docs/cli/commands/registry.mdx | 65 +++++++ docs/cli/commands/start.mdx | 55 ++++++ docs/cli/configuration/configuration-file.mdx | 160 ++++++++++++++++++ .../configuration/environment-variables.mdx | 33 ++++ docs/cli/getting-started/installation.mdx | 38 +++++ docs/cli/getting-started/introduction.mdx | 38 +++++ docs/cli/getting-started/quickstart.mdx | 61 +++++++ docs/cli/navigation.json | 45 +++++ docs/cli/schematics/component.mdx | 120 +++++++++++++ docs/cli/schematics/overview.mdx | 50 ++++++ docs/cli/schematics/project.mdx | 98 +++++++++++ docs/cli/schematics/system.mdx | 103 +++++++++++ docs/cli/schematics/workspace.mdx | 67 ++++++++ guides/cli/build-and-deploy.mdx | 52 ++++++ guides/cli/components-and-systems.mdx | 50 ++++++ guides/cli/create-a-project.mdx | 49 ++++++ guides/cli/develop-locally.mdx | 32 ++++ guides/cli/navigation.json | 8 + guides/cli/overview.mdx | 26 +++ guides/cli/publish-a-package.mdx | 40 +++++ 27 files changed, 1511 insertions(+) create mode 100644 docs/cli/commands/build.mdx create mode 100644 docs/cli/commands/create.mdx create mode 100644 docs/cli/commands/dev.mdx create mode 100644 docs/cli/commands/editor.mdx create mode 100644 docs/cli/commands/install.mdx create mode 100644 docs/cli/commands/new.mdx create mode 100644 docs/cli/commands/overview.mdx create mode 100644 docs/cli/commands/registry.mdx create mode 100644 docs/cli/commands/start.mdx create mode 100644 docs/cli/configuration/configuration-file.mdx create mode 100644 docs/cli/configuration/environment-variables.mdx create mode 100644 docs/cli/getting-started/installation.mdx create mode 100644 docs/cli/getting-started/introduction.mdx create mode 100644 docs/cli/getting-started/quickstart.mdx create mode 100644 docs/cli/navigation.json create mode 100644 docs/cli/schematics/component.mdx create mode 100644 docs/cli/schematics/overview.mdx create mode 100644 docs/cli/schematics/project.mdx create mode 100644 docs/cli/schematics/system.mdx create mode 100644 docs/cli/schematics/workspace.mdx create mode 100644 guides/cli/build-and-deploy.mdx create mode 100644 guides/cli/components-and-systems.mdx create mode 100644 guides/cli/create-a-project.mdx create mode 100644 guides/cli/develop-locally.mdx create mode 100644 guides/cli/navigation.json create mode 100644 guides/cli/overview.mdx create mode 100644 guides/cli/publish-a-package.mdx diff --git a/docs/cli/commands/build.mdx b/docs/cli/commands/build.mdx new file mode 100644 index 0000000..7af6ac5 --- /dev/null +++ b/docs/cli/commands/build.mdx @@ -0,0 +1,48 @@ +--- +title: build +description: Build your NanoForge project for production +--- + +## Overview + +`nf build` compiles your NanoForge project. The client and server entry points, static directories, +and output directories all default to the values in your +[configuration file](/docs/cli/configuration/configuration-file) and can be overridden per run. + +When the workspace sets `network: "p2p"`, each server app is also built for the browser, into the +client's output directory under `server/`, so the host player's tab can run it. + +## Usage + +```bash +nf build +``` + +## Options + +| Option | Description | +| --------------------------------------- | -------------------------------------- | +| `-d, --directory ` | Working directory of the command. | +| `-c, --config ` | Path to the configuration file. | +| `--client-entry ` | Entry file of the client. | +| `--server-entry ` | Entry file of the server. | +| `--client-static-dir ` | Static directory of the client. | +| `--server-static-dir ` | Static directory of the server. | +| `--client-out-dir ` | Output directory of the client. | +| `--server-out-dir ` | Output directory of the server. | +| `--editor` | Build with the editor configuration. | +| `--watch` | Build in watch mode. Default: `false`. | + +## Examples + +**Build using the configuration defaults:** + +```bash +nf build +``` + +**Rebuild on change with a custom client output directory:** + +```bash +nf build --watch --client-out-dir dist/client +``` diff --git a/docs/cli/commands/create.mdx b/docs/cli/commands/create.mdx new file mode 100644 index 0000000..0f8751b --- /dev/null +++ b/docs/cli/commands/create.mdx @@ -0,0 +1,57 @@ +--- +title: create +description: Create a NanoForge component, system or editor plugin +--- + +## Overview + +`nf create` scaffolds a single ECS **component** or **system** in your project. By default it +creates files for the client; pass `--server` to target the server instead. + +## Usage + +```bash +nf create +``` + +`` is `component`, `system`, or `plugin` (an editor plugin, a project of its own). + +## Options + +| Option | Description | +| ----------------------------- | --------------------------------------------------------------- | +| `` | The type to create: `component`, `system` or `plugin`. | +| `-d, --directory ` | Working directory of the command. | +| `-c, --config ` | Path to the configuration file. | +| `-n, --name ` | Name of the component or system. | +| `-s, --server` | Create on the server instead of the client. Default: `false`. | +| `-p, --path ` | Path to the component/system folder, or the plugin's folder. | +| `-t, --template