API
Docs
Samples
Pricing
Preparing search index...
The search index is not available
Needle Engine
Needle Engine
Engine Core
Module Engine Core
Contains core functionality for Needle Engine. This includes
Context Management
Asset Loading
Component Lifecycle
Time Handling
XR support
Unified Input Handling
Needle Menu
Networking
Physics, Collisions, Raycasting
Math and Filtering Helpers
Rendering Utilities
Debugging Utilities, Gizmos
User agent detection
and more.
Networking
syncDestroy
syncInstantiate
Other
BlobStorage
DeviceUtilities
InternalScreenshotUtils
NEEDLE_ENGINE_MODULES
PreviewHelper
ConnectionEvents
ContextEvent
OwnershipEvent
RoomEvents
Addressables
AnimationUtils
AnimatorStateInfo
Application
AssetDatabase
AssetReference
ButtonsFactory
CircularBuffer
Collision
ComponentLifecycleEvents
ContactPoint
Context
ContextArgs
ContextCreateArgs
ContextRegistry
CustomShader
FileReference
FileSpawnModel
Gizmos
GltfLoadEvent
Graphics
ImageReference
Input
InstancingUtil
InstantiateIdProvider
InstantiateOptions
JoinedRoomResponse
KeyEventArgs
LeftRoomResponse
LightData
LoadingProgressArgs
NeedleButtonElement
NeedleEngineHTMLElement
NeedleXRController
NeedleXRSession
NeedleXRSync
NeedleXRUtils
NEKeyboardEvent
NEPointerEvent
NetworkConnection
NetworkedStreams
NewInstanceModel
ObjectUtils
OneEuroFilter
OneEuroFilterXYZ
OwnershipModel
PeerHandle
PeerNetworking
Physics
PlayerView
PlayerViewManager
Progress
PromiseErrorResult
RapierPhysics
RaycastOptions
RendererData
RenderTexture
RenderTextureSerializer
RGBAColor
SceneLightSettings
SerializationContext
SphereIntersection
SphereOverlapResult
StateMachineBehaviour
StreamEndedEvent
StreamReceivedEvent
TestSceneUtils
Time
UriSerializer
UserJoinedOrLeftRoomModel
Watch
WebXRButtonFactory
IBeforeNetworkedDestroy
IBoxCollider
ICameraController
ICollider
IComponent
IConnectionData
IEventList
IGameObject
IHasGuid
IInput
ILight
IModel
INeedleEngineComponent
INeedleGLTFExtensionPlugin
INeedleGltfLoader
INeedleXRSessionEventReceiver
INetworkConnection
INetworkingWebsocketUrlProvider
IPhysics
IPhysicsEngine
IPointerHitEventReceiver
IRaycastOptions
IRenderer
IRigidbody
ISerializable
ISharedMaterials
ISphereCollider
ITime
IWatch
IXRRig
UIDProvider
ButtonName
ControllerChangedEvt
CursorTypeName
FBX
FileType
GamepadButtonName
GLTF
InstantiateContext
IpAndLocation
LoadedModel
Model
MouseButtonName
NeedleEngineAttributes
NeedleMenuPostMessageModel
NeedleXRControllerEventArgs
NeedleXREventArgs
NeedleXRHitTestResult
NEPointerEventIntersection
OBJ
ObjectOptions
OnRenderCallback
PhysicsMaterial
ScreenshotOptions
SourceIdentifier
StylusButtonName
SyncInstantiateOptions
TextOptions
XRControllerButtonName
BUILD_TIME
GENERATOR
VERSION
__internalNotifyObjectDestroyed
addAttributeChangeCallback
addComponent
addCustomExtensionPlugin
addGltfLoadEventListener
addNewComponent
addPatch
applyHMRChanges
beginListenDestroy
beginListenInstantiate
clearBalloonMessages
compareAssociation
copyTexture
createLoader
createMotion
deepClone
delay
delayForFrames
deserializeObject
destroy
destroyComponentInstance
disposeObjectResources
disposeStream
enableSpatialConsole
exportAsGLTF
findByGuid
findObjectOfType
findObjectsOfType
findResourceUsers
fitObjectIntoVolume
foreachComponent
foreachComponentEnumerator
forward
generateQRCode
generateSeed
getBoundingBox
getCameraController
getComponent
getComponentInChildren
getComponentInParent
getComponents
getComponentsInChildren
getComponentsInParent
getFormattedDate
getIconElement
getIconTexture
getIp
getIpAndLocation
getIpCloudflare
getLoader
getOrAddComponent
getParam
getParentHierarchyPath
getPath
getPeerjsInstance
getPeerOptions
getResourceUserCount
getTempColor
getTempQuaternion
getTempVector
getUrlParams
getVisibleInCustomShadowRendering
getWorldDirection
getWorldEuler
getWorldPosition
getWorldQuaternion
getWorldRotation
getWorldScale
hideDebugConsole
instantiate
isActiveInHierarchy
isActiveSelf
isAndroidDevice
isAnimationAction
isComponent
isDesktop
isDestroyed
isDevEnvironment
isDisposed
isExporting
isHostedOnGlitch
isIconElement
isiOS
isiPad
isIPad
isLocalNetwork
isMacOS
isMobileDevice
isMozillaXR
isQuest
isResourceTrackingEnabled
isSafari
isUsingInstancing
loadSync
logHierarchy
lookAtInverse
lookAtObject
lookAtScreenPoint
makeId
makeIdFromRandomWords
markAsInstancedRendered
microphonePermissionsGranted
offXRSessionEnd
offXRSessionStart
onAfterRender
onBeforeRender
onClear
onDestroy
onInitialized
onStart
onUpdate
onXRSessionEnd
onXRSessionStart
parseSync
placeOnSurface
postprocessFBXMaterials
prefix
PromiseAllWithErrors
pushState
randomNumber
registerComponent
registerComponentExtension
registerExportExtensions
registerExtensions
registerLoader
registerPrefabProvider
registerType
removeAttributeChangeCallback
removeComponent
removeCustomImportExtensionType
removeGltfLoadEventListener
removePatch
resolveUrl
sanitizeString
saveImage
screenshot
screenshot2
sendDestroyed
serializable
serializeable
serializeObject
setActive
setAllowBalloonMessages
setAllowOverlayMessages
setAutoFitEnabled
setCameraController
setDestroyed
setDevEnvironment
setDisposable
setDontDestroy
setOrAddParamsToUrl
setParam
setParamWithoutReload
setPeerOptions
setResourceTrackingEnabled
setState
setVisibleInCustomShadowRendering
setWorldEuler
setWorldPosition
setWorldPositionXYZ
setWorldQuaternion
setWorldQuaternionXYZW
setWorldRotation
setWorldRotationXYZ
setWorldScale
showBalloonError
showBalloonMessage
showBalloonWarning
showDebugConsole
slerp
syncField
textureToCanvas
tryDetermineFileTypeFromURL
tryFindObject
unwatchWrite
validate
WaitForFrames
WaitForPromise
WaitForSeconds
watchWrite
Settings
Member Visibility
Protected
Inherited
Deprecated
Theme
OS
Light
Dark
On This Page
Networking
sync
Destroy
sync
Instantiate
Other
Blob
Storage
Device
Utilities
Internal
Screenshot
Utils
NEEDLE_
ENGINE_
MODULES
Preview
Helper
Connection
Events
Context
Event
Ownership
Event
Room
Events
Addressables
Animation
Utils
Animator
State
Info
Application
Asset
Database
Asset
Reference
Buttons
Factory
Circular
Buffer
Collision
Component
Lifecycle
Events
Contact
Point
Context
Context
Args
Context
Create
Args
Context
Registry
Custom
Shader
File
Reference
File
Spawn
Model
Gizmos
Gltf
Load
Event
Graphics
Image
Reference
Input
Instancing
Util
Instantiate
Id
Provider
Instantiate
Options
Joined
Room
Response
Key
Event
Args
Left
Room
Response
Light
Data
Loading
Progress
Args
Needle
Button
Element
Needle
EngineHTMLElement
NeedleXRController
NeedleXRSession
NeedleXRSync
NeedleXRUtils
NEKeyboard
Event
NEPointer
Event
Network
Connection
Networked
Streams
New
Instance
Model
Object
Utils
One
Euro
Filter
One
Euro
FilterXYZ
Ownership
Model
Peer
Handle
Peer
Networking
Physics
Player
View
Player
View
Manager
Progress
Promise
Error
Result
Rapier
Physics
Raycast
Options
Renderer
Data
Render
Texture
Render
Texture
Serializer
RGBAColor
Scene
Light
Settings
Serialization
Context
Sphere
Intersection
Sphere
Overlap
Result
State
Machine
Behaviour
Stream
Ended
Event
Stream
Received
Event
Test
Scene
Utils
Time
Uri
Serializer
User
Joined
Or
Left
Room
Model
Watch
WebXRButton
Factory
IBefore
Networked
Destroy
IBox
Collider
ICamera
Controller
ICollider
IComponent
IConnection
Data
IEvent
List
IGame
Object
IHas
Guid
IInput
ILight
IModel
INeedle
Engine
Component
INeedleGLTFExtension
Plugin
INeedle
Gltf
Loader
INeedleXRSession
Event
Receiver
INetwork
Connection
INetworking
Websocket
Url
Provider
IPhysics
IPhysics
Engine
IPointer
Hit
Event
Receiver
IRaycast
Options
IRenderer
IRigidbody
ISerializable
IShared
Materials
ISphere
Collider
ITime
IWatch
IXRRig
UIDProvider
Button
Name
Controller
Changed
Evt
Cursor
Type
Name
FBX
File
Type
Gamepad
Button
Name
GLTF
Instantiate
Context
Ip
And
Location
Loaded
Model
Model
Mouse
Button
Name
Needle
Engine
Attributes
Needle
Menu
Post
Message
Model
NeedleXRController
Event
Args
NeedleXREvent
Args
NeedleXRHit
Test
Result
NEPointer
Event
Intersection
OBJ
Object
Options
On
Render
Callback
Physics
Material
Screenshot
Options
Source
Identifier
Stylus
Button
Name
Sync
Instantiate
Options
Text
Options
XRController
Button
Name
BUILD_
TIME
GENERATOR
VERSION
__internal
Notify
Object
Destroyed
add
Attribute
Change
Callback
add
Component
add
Custom
Extension
Plugin
add
Gltf
Load
Event
Listener
add
New
Component
add
Patch
applyHMRChanges
begin
Listen
Destroy
begin
Listen
Instantiate
clear
Balloon
Messages
compare
Association
copy
Texture
create
Loader
create
Motion
deep
Clone
delay
delay
For
Frames
deserialize
Object
destroy
destroy
Component
Instance
dispose
Object
Resources
dispose
Stream
enable
Spatial
Console
export
AsGLTF
find
By
Guid
find
Object
Of
Type
find
Objects
Of
Type
find
Resource
Users
fit
Object
Into
Volume
foreach
Component
foreach
Component
Enumerator
forward
generateQRCode
generate
Seed
get
Bounding
Box
get
Camera
Controller
get
Component
get
Component
In
Children
get
Component
In
Parent
get
Components
get
Components
In
Children
get
Components
In
Parent
get
Formatted
Date
get
Icon
Element
get
Icon
Texture
get
Ip
get
Ip
And
Location
get
Ip
Cloudflare
get
Loader
get
Or
Add
Component
get
Param
get
Parent
Hierarchy
Path
get
Path
get
Peerjs
Instance
get
Peer
Options
get
Resource
User
Count
get
Temp
Color
get
Temp
Quaternion
get
Temp
Vector
get
Url
Params
get
Visible
In
Custom
Shadow
Rendering
get
World
Direction
get
World
Euler
get
World
Position
get
World
Quaternion
get
World
Rotation
get
World
Scale
hide
Debug
Console
instantiate
is
Active
In
Hierarchy
is
Active
Self
is
Android
Device
is
Animation
Action
is
Component
is
Desktop
is
Destroyed
is
Dev
Environment
is
Disposed
is
Exporting
is
Hosted
On
Glitch
is
Icon
Element
isiOS
isi
Pad
isIPad
is
Local
Network
is
MacOS
is
Mobile
Device
is
MozillaXR
is
Quest
is
Resource
Tracking
Enabled
is
Safari
is
Using
Instancing
load
Sync
log
Hierarchy
look
At
Inverse
look
At
Object
look
At
Screen
Point
make
Id
make
Id
From
Random
Words
mark
As
Instanced
Rendered
microphone
Permissions
Granted
offXRSession
End
offXRSession
Start
on
After
Render
on
Before
Render
on
Clear
on
Destroy
on
Initialized
on
Start
on
Update
onXRSession
End
onXRSession
Start
parse
Sync
place
On
Surface
postprocessFBXMaterials
prefix
Promise
All
With
Errors
push
State
random
Number
register
Component
register
Component
Extension
register
Export
Extensions
register
Extensions
register
Loader
register
Prefab
Provider
register
Type
remove
Attribute
Change
Callback
remove
Component
remove
Custom
Import
Extension
Type
remove
Gltf
Load
Event
Listener
remove
Patch
resolve
Url
sanitize
String
save
Image
screenshot
screenshot2
send
Destroyed
serializable
serializeable
serialize
Object
set
Active
set
Allow
Balloon
Messages
set
Allow
Overlay
Messages
set
Auto
Fit
Enabled
set
Camera
Controller
set
Destroyed
set
Dev
Environment
set
Disposable
set
Dont
Destroy
set
Or
Add
Params
To
Url
set
Param
set
Param
Without
Reload
set
Peer
Options
set
Resource
Tracking
Enabled
set
State
set
Visible
In
Custom
Shadow
Rendering
set
World
Euler
set
World
Position
set
World
PositionXYZ
set
World
Quaternion
set
World
QuaternionXYZW
set
World
Rotation
set
World
RotationXYZ
set
World
Scale
show
Balloon
Error
show
Balloon
Message
show
Balloon
Warning
show
Debug
Console
slerp
sync
Field
texture
To
Canvas
try
Determine
File
Type
FromURL
try
Find
Object
unwatch
Write
validate
Wait
For
Frames
Wait
For
Promise
Wait
For
Seconds
watch
Write
API
Docs
Samples
Pricing
Needle Engine
Loading...
Contains core functionality for Needle Engine. This includes