API
Docs
Samples
Pricing
Preparing search index...
The search index is not available
Needle Engine
Needle Engine
Engine Core
getIpCloudflare
Function getIpCloudflare
getIpCloudflare
()
:
Promise
<
null
|
string
>
Returns
Promise
<
null
|
string
>
Settings
Member Visibility
Protected
Inherited
Deprecated
Theme
OS
Light
Dark
API
Docs
Samples
Pricing
Needle Engine
Built-in Components
Animation and Sequencing
Animation
Animator
PlayableDirector
Asset Management
DropListener
GltfExport
SceneSwitcher
Camera Controls
Camera
CharacterController
CharacterControllerInput
OrbitControls
Effects
Antialiasing
BloomEffect
ChromaticAberration
ColorAdjustments
DepthOfField
EffectWrapper
PixelationEffect
PostProcessingEffect
ScreenSpaceAmbientOcclusion
ScreenSpaceAmbientOcclusionN8
SharpeningEffect
TiltShiftEffect
ToneMappingEffect
Vignette
Volume
Everywhere Actions
ChangeMaterialOnClick
ChangeTransformOnClick
EmphasizeOnClick
HideOnStart
PlayAnimationOnClick
PlayAudioOnClick
SetActiveOnClick
TapGestureTrigger
VisibilityAction
Helpers
AxesHelper
BoxGizmo
BoxHelperComponent
GltfExportBox
GridHelper
TransformGizmo
Interactivity
CharacterControllerInput
Deletable
DeleteBox
DragControls
Duplicatable
EventTrigger
OpenURL
SmoothFollow
SpatialTrigger
SpatialTriggerReceiver
Multimedia
AudioListener
AudioSource
VideoPlayer
Networking
Avatar
Networking
PlayerColor
ScreenCapture
SpectatorCamera
SyncedCamera
SyncedRoom
SyncedTransform
Voip
Physics
BoxCollider
CapsuleCollider
Collider
MeshCollider
Rigidbody
SphereCollider
Rendering
ContactShadows
GroundProjectedEnv
Light
LODGroup
MeshRenderer
ParticleSystem
ReflectionProbe
Renderer
ShadowCatcher
SkinnedMeshRenderer
Sprite
Volume
User Interface
BaseUIComponent
Button
Canvas
CanvasGroup
EventSystem
Graphic
GridLayoutGroup
HorizontalLayoutGroup
Image
InputField
MaskableGraphic
NeedleMenu
RawImage
RectTransform
Text
UIRootComponent
VerticalLayoutGroup
Utilities
DeviceFlag
XRFlag
XR
Avatar
USDZExporter
WebARSessionRoot
WebXR
WebXRImageTracking
WebXRPlaneTracking
XRControllerFollow
XRControllerMovement
XRFlag
XRRig
Other
ClearFlags
DragMode
__Ignore
ActionBuilder
ActionCollection
ActionModel
AlignmentConstraint
AnimationCurve
AnimationExtension
AnimationTrackHandler
AnimatorController
AudioExtension
AudioTrackHandler
AvatarLoader
AvatarMarker
AvatarModel
BasicIKConstraint
BehaviorExtension
BehaviorModel
Behaviour
CallInfo
CameraTargetReachedEvent
ColorBySpeedModule
ColorOverLifetimeModule
ControlTrackHandler
CustomBranding
DocumentExtension
EmissionModule
EventList
EventListEvent
FieldWithDefault
FixedJoint
GameObject
Gradient
GraphicRaycaster
GroupActionModel
HingeJoint
InheritVelocityModule
InstanceHandle
InstancingHandler
Interactable
Keyframe
LimitVelocityOverLifetimeModule
LODModel
LogStats
LookAt
LookAtConstraint
MainModule
MarkerModel
MinMaxCurve
MinMaxGradient
NeedleUSDZExporter
NestedGltf
NoiseModule
ObjectRaycaster
OffsetConstraint
Outline
Padding
ParticleBurst
ParticleSubEmitter
ParticleSystemBaseBehaviour
PhysicsExtension
PointerEventData
PostProcessingHandler
PreliminaryAction
PreliminaryTrigger
Rect
RegisteredAnimationInfo
RemoteSkybox
RendererLightmap
RotationBySpeedModule
RotationOverLifetimeModule
ShapeModule
SignalAsset
SignalMarkerModel
SignalReceiver
SignalReceiverEvent
SignalTrackHandler
Size
SizeBySpeedModule
SizeOverLifetimeModule
SpatialGrabRaycaster
SpatialHtml
SpriteData
SpriteRenderer
SpriteSheet
TeleportTarget
TextBuilder
TextExtension
TextureSheetAnimationModule
TrackHandler
TrailModule
TransformData
TriggerBuilder
TriggerModel
UIRaycastUtils
UsageMarker
USDDocument
USDObject
USDWriter
USDZExporterContext
USDZText
USDZUIExtension
VariantAction
VelocityOverLifetimeModule
VolumeParameter
WebARCameraBackground
WebXRImageTrackingModel
WebXRTrackedImage
XRControllerModel
XRState
IEffectProvider
IInputEventArgs
IPointerClickHandler
IPointerDownHandler
IPointerEnterHandler
IPointerEventHandler
IPointerExitHandler
IPointerMoveHandler
IPointerUpHandler
ISceneEventListener
ITimelineAnimationOverride
UsdzBehaviour
DropListenerNetworkEventArguments
DropListenerOnDropArguments
WebXRPlaneTrackingEvent
XRPlaneContext
decompressGpuTexture
imageToCanvas
makeNameSafeForUSD
registerCustomEffectType
Engine Core
Networking
syncDestroy
syncInstantiate
Other
BlobStorage
baseUrl
canUpload
download
getBlobUrlForKey
hashMD5
hashMD5_Base64
hashSha256
upload
DeviceUtilities
getChromeVersion
getiOSVersion
isAndroidDevice
isDesktop
isiOS
isiPad
isIPad
isMacOS
isMobileDevice
isMozillaXR
isQuest
isSafari
isVisionOS
microphonePermissionsGranted
supportsQuickLookAR
InternalScreenshotUtils
compositeWithCameraImage
makeFullscreenPlane
NEEDLE_ENGINE_MODULES
POSTPROCESSING
load
ready
POSTPROCESSING_AO
load
ready
RAPIER_PHYSICS
load
ready
PreviewHelper
addPreview
removePreview
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
Experimental Components
Networking
PlayerSync
Other
PlayerStateEvent
PlayerState
PlayerStateOwnerChangedArgs
PlayerStateEventCallback
Networking Schemes
registerBinaryType
tryCastBinary
tryGetGuid
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R