NanoForge home page
NanoForge
Documentation
Guides
Search...
Navigation
Engine
text
Search...
⌘K
CLI
CLI
Usage
Schematics
Technical Documentation
API Reference
Architecture
Schematics Reference
Engine
getAsset
__init
__name
AssetManagerLibrary class
asset-manager package
API Reference
_delta
delta
isRunning
muteSoundLibraries
setIsRunning
ApplicationContext class
ASSET_MANAGER_LIBRARY variable
getAsset
__init
BaseAssetManagerLibrary class
__run
BaseComponentSystemLibrary class
__run
BaseGraphicsLibrary class
BaseInputLibrary class
__init
mute
play
BaseMusicLibrary class
BaseNetworkLibrary class
__init
mute
play
BaseSoundLibrary class
ClearContext class
constructor
getAssetManager
getComponentSystem
getGraphics
getInput
get
getMusic
getNetwork
getSound
ClientLibraryManager class
COMPONENT_SYSTEM_LIBRARY variable
app
constructor
libs
Context class
DefaultLibrariesEnum enum
ExecutionContext class
GRAPHICS_LIBRARY variable
getAsset
IAssetManagerLibrary interface
IComponentSystemLibrary interface
registerConfig
IConfigRegistry interface
IExposedLibrary interface
IGraphicsLibrary interface
IInputLibrary interface
__clear
__init
__name
__relationship
ILibrary interface
IMusicLibrary interface
mute
IMutableLibrary interface
INetworkLibrary interface
config
constructor
container
env
files
InitContext class
INPUT_LIBRARY variable
container
env
files
IRunClientOptions interface
__run
IRunnerLibrary interface
IRunOptions type
env
files
IRunServerOptions interface
ISoundLibrary interface
_status
status
LibraryContext class
constructor
context
library
symbol
LibraryHandle class
constructor
getAssetManager
getComponentSystem
getGraphics
getInput
getMusic
getNetwork
getSound
LibraryManager class
LibraryStatusEnum enum
MUSIC_LIBRARY variable
NETWORK_LIBRARY variable
code
constructor
NfConfigException class
code
constructor
NfFetchException class
arrayBuffer
blob
bytes
constructor
formData
json
path
text
NfFile class
code
constructor
NfNotFound class
code
constructor
NfNotInitializedException class
SOUND_LIBRARY variable
common package
API Reference
Default function
IsIpOrFQDN function
TransformToBoolean function
config package
API Reference
useGraphics
useInput
useSound
NanoforgeClient class
NanoforgeFactory variable
NanoforgeServer class
core package
API Reference
useGraphics
useInput
useSound
NanoforgeClient class
NanoforgeFactory variable
NanoforgeServer class
core-editor package
API Reference
constructor
__init
__name
ECSClientLibrary class
ecs-client package
API Reference
constructor
module
__name
path
_registry
registry
__run
AbstractECSLibrary class
Component type
EditorComponentManifest type
EditorSystemManifest type
getId
Entity interface
addComponent
addSystem
clearEntities
clearSystems
entityFromIndex
getComponentsConst
getComponents
getEntityComponentConst
getEntityComponent
getZipper
killEntity
maxEntities
registerComponent
removeComponent
removeSystem
runSystems
spawnEntity
Registry interface
clear
empty
erase
getConst
getIndex
get
insertAt
insertAt
resize
setByCopy
setByMove
set
size
SparseArray interface
System type
ecs-lib package
API Reference
constructor
__init
__name
ECSServerLibrary class
Module variable
ecs-server package
API Reference
angleDeg variable
Animation_2 variable
ArcConfig type
Arc variable
ArrowConfig type
Arrow variable
autoDrawEnabled variable
Canvas variable
capturePointerEventsEnabled variable
CircleConfig type
Circle variable
ContainerConfig type
Container variable
Context variable
dblClickWindow variable
DD variable
document_2 variable
dragButtons variable
dragDistance variable
Easings variable
EllipseConfig type
Ellipse variable
enableTrace variable
FastLayer variable
Filters variable
getAngle function
_global variable
baseLayer
__init
__name
__run
stage
Graphics2DLibrary class
GroupConfig type
Group variable
hitOnDragEnabled variable
Image_2 variable
ImageConfig type
_injectGlobal function
isBrowser variable
isDragging function
isDragReady function
isTransforming function
isUnminified variable
KonvaEventListener type
KonvaEventObject type
KonvaPointerEvent type
LabelConfig type
Label variable
LayerConfig type
Layer variable
legacyTextRendering variable
LineConfig type
Line variable
_mouseDblClickPointerId variable
_mouseInDblClickWindow variable
_mouseListenClick variable
Node_2 variable
NodeConfig type
PathConfig type
Path variable
pixelRatio variable
_pointerDblClickPointerId variable
pointerEventsEnabled variable
_pointerInDblClickWindow variable
_pointerListenClick variable
RectConfig type
Rect variable
RegularPolygonConfig type
RegularPolygon variable
releaseCanvasOnDestroy variable
_renderBackend variable
RingConfig type
Ring variable
ShapeConfig type
Shape variable
shapes variable
showWarnings variable
SpriteConfig type
Sprite variable
StageConfig type
Stage variable
stages variable
StarConfig type
Star variable
TagConfig type
Tag variable
Text_2 variable
TextConfig type
TextPathConfig type
TextPath variable
_touchDblClickPointerId variable
_touchInDblClickWindow variable
_touchListenClick variable
Transformer_2 variable
TransformerConfig type
Transform variable
TweenConfig type
Tween variable
Util variable
Vector2d type
version variable
WedgeConfig type
Wedge variable
graphics-2d package
API Reference
API Reference
InputEnum enum
constructor
getDragState
getMousePosition
getMouseState
getPressedKeys
getWheelState
__init
isDragging
isKeyPressed
__name
__run
InputLibrary class
input package
API Reference
__init
load
mute
__name
play
MusicLibrary class
music package
API Reference
__init
__name
tcp
udp
NetworkClientLibrary class
connect
constructor
getReceivedPackets
isConnected
sendData
TCPClient class
connect
constructor
getReceivedPackets
isConnected
sendData
UDPClient class
network-client package
API Reference
__init
__name
tcp
udp
NetworkServerLibrary class
constructor
getConnectedClients
getReceivedPackets
listen
sendToClient
sendToEverybody
TCPServer class
constructor
getConnectedClients
getReceivedPackets
listen
sendToClient
sendToEverybody
UDPServer class
network-server package
API Reference
__init
load
mute
__name
play
SoundLibrary class
sound package
Documentation
Introduction to using the Engine
Engine
Network Overview
network-client API
Client Networking (network-client)
network-server API
Server Networking (network-server)
Packet Framing
Registry
Writing Web Assembly
English
On this page
text
Signature
Parameters
Returns
Engine
text
text API documentation
text
Signature
text
():
Promise
<
string
>
;
Parameters
This method takes no parameters.
Returns
Type
:
Promise<string>
path
Previous
NfFile class
Next
⌘I