• Preparing search index...
  • The search index is not available
SDK Documentation - v7.0.0
  • SDK Documentation - v7.0.0
  • ECS
  • getDefaultOpts

Function getDefaultOpts

  • getDefaultOpts(opts?: Partial<EventSystemOptions>): EventSystemOptions
  • Parameters

    • Optional opts: Partial<EventSystemOptions>

    Returns EventSystemOptions

    • Defined in ecs/dist/systems/events.d.ts:20
Documentation

Settings

Member Visibility

Theme

Modules

  • SDK Documentation - v7.0.0
    • ECS
      • AppendValueOperation
      • AvatarTexture
      • BorderRect
      • CameraTransition
      • ComponentData
      • Composite
      • CompositeComponent
      • CompositeComponent_DataEntry
      • CompositeDefinition
      • CrdtMessageProtocol
      • DeleteComponent
      • DeleteComponentNetwork
      • DeleteEntity
      • DeleteEntityNetwork
      • EntityUtils
      • Move
      • PBAnimationState
      • PBAnimator
      • PBAudioEvent
      • PBAudioSource
      • PBAudioStream
      • PBAvatarAttach
      • PBAvatarBase
      • PBAvatarEmoteCommand
      • PBAvatarEquippedData
      • PBAvatarModifierArea
      • PBAvatarShape
      • PBBillboard
      • PBCameraMode
      • PBCameraModeArea
      • PBColor3
      • PBColor4
      • PBEngineInfo
      • PBGltfContainer
      • PBGltfContainerLoadingState
      • PBInputModifier
      • PBInputModifier_StandardInput
      • PBMainCamera
      • PBMaterial
      • PBMaterial_PbrMaterial
      • PBMaterial_UnlitMaterial
      • PBMeshCollider
      • PBMeshCollider_BoxMesh
      • PBMeshCollider_CylinderMesh
      • PBMeshCollider_PlaneMesh
      • PBMeshCollider_SphereMesh
      • PBMeshRenderer
      • PBMeshRenderer_BoxMesh
      • PBMeshRenderer_CylinderMesh
      • PBMeshRenderer_PlaneMesh
      • PBMeshRenderer_SphereMesh
      • PBNftShape
      • PBPlayerIdentityData
      • PBPointerEvents
      • PBPointerEventsResult
      • PBPointerEvents_Entry
      • PBPointerEvents_Info
      • PBPointerLock
      • PBPosition
      • PBQuaternion
      • PBRaycast
      • PBRaycastResult
      • PBRealmInfo
      • PBTextShape
      • PBTween
      • PBTweenSequence
      • PBTweenState
      • PBUiBackground
      • PBUiCanvasInformation
      • PBUiDropdown
      • PBUiDropdownResult
      • PBUiInput
      • PBUiInputResult
      • PBUiText
      • PBUiTransform
      • PBVector2
      • PBVector3
      • PBVideoEvent
      • PBVideoPlayer
      • PBVirtualCamera
      • PBVisibilityComponent
      • PutComponentOperation
      • PutNetworkComponentOperation
      • RaycastHit
      • Rect
      • Rotate
      • Scale
      • Schemas
      • Texture
      • TextureMove
      • TextureUnion
      • VideoTexture
    • Etherum Provider
    • Math & Colors
      • Color3
      • Color4
      • Matrix
      • Plane
      • Quaternion
      • Scalar
      • Vector2
      • Vector3
    • ReactEcs
      • ReactEcs
        • JSX
    • js-runtime/apis
      • "~system/CommsApi"
      • "~system/CommunicationsController"
      • "~system/EngineApi"
      • "~system/EnvironmentApi"
      • "~system/EthereumController"
      • "~system/Players"
      • "~system/PortableExperiences"
      • "~system/RestrictedActions"
      • "~system/Runtime"
      • "~system/Scene"
      • "~system/SignedFetch"
      • "~system/Testing"
      • "~system/UserActionModule"
      • "~system/UserIdentity"
    • sdk/src/composite-provider
    • sdk/src/ethereum-provider/text-encoder
    • sdk/src/ethereum-provider/text-encoding
    • sdk/src/network
    • sdk/src/network/binary-message-bus
    • sdk/src/network/entities
    • sdk/src/network/filter
    • sdk/src/network/message-bus-sync
    • sdk/src/network/state
    • sdk/src/network/utils
    • sdk/src/players
  • Engine
  • areConnected
  • createEntityContainer
  • createInputSystem
  • createPointerEventsSystem
  • createTweenSystem
  • cyclicParentingChecker
  • executeTask
  • getComponentEntityTree
  • getCompositeRootComponent
  • getDefaultOpts
  • isEqual
  • removeEntityWithChildren
  • Animator
  • AudioEvent
  • AudioSource
  • AudioStream
  • AvatarAttach
  • AvatarBase
  • AvatarEmoteCommand
  • AvatarEquippedData
  • AvatarModifierArea
  • AvatarShape
  • Billboard
  • CRDT_MESSAGE_HEADER_LENGTH
  • CameraMode
  • CameraModeArea
  • EngineInfo
  • GltfContainer
  • GltfContainerLoadingState
  • InputModifier
  • MainCamera
  • Material
  • MeshCollider
  • MeshRenderer
  • Name
  • NetworkEntity
  • NetworkParent
  • NftShape
  • PlayerIdentityData
  • PointerEvents
  • PointerEventsResult
  • PointerLock
  • RESERVED_STATIC_ENTITIES
  • Raycast
  • RaycastResult
  • RealmInfo
  • SYSTEMS_REGULAR_PRIORITY
  • SyncComponents
  • TextShape
  • Transform
  • Tween
  • TweenSequence
  • TweenState
  • UiBackground
  • UiCanvasInformation
  • UiDropdown
  • UiDropdownResult
  • UiInput
  • UiInputResult
  • UiText
  • UiTransform
  • VideoEvent
  • VideoPlayer
  • VirtualCamera
  • VisibilityComponent
  • componentDefinitionByName
  • engine
  • inputSystem
  • pointerEventsSystem
  • raycastSystem
  • tweenSystem
  • videoEventsSystem
  • AnimatorComponentDefinitionExtended
  • AudioSourceComponentDefinitionExtended
  • AudioStreamComponentDefinitionExtended
  • AvatarTexture
  • BaseComponent
  • BorderRect
  • ByteBuffer
  • CameraTransition
  • CameraTransitionHelper
  • ComponentData
  • CompositeComponent
  • CompositeComponent_DataEntry
  • CompositeDefinition
  • GrowOnlyValueSetComponentDefinition
  • IEngine
  • IEngineOptions
  • INetowrkEntityType
  • INetowrkParentType
  • ISchema
  • ISyncComponentsType
  • InputModifierComponentDefinitionExtended
  • InputModifierHelper
  • LastWriteWinElementSetComponentDefinition
  • MapComponentDefinition
  • MaterialComponentDefinitionExtended
  • MeshColliderComponentDefinitionExtended
  • MeshRendererComponentDefinitionExtended
  • Move
  • NameType
  • PBAnimationState
  • PBAnimator
  • PBAudioEvent
  • PBAudioSource
  • PBAudioStream
  • PBAvatarAttach
  • PBAvatarBase
  • PBAvatarEmoteCommand
  • PBAvatarEquippedData
  • PBAvatarModifierArea
  • PBAvatarShape
  • PBBillboard
  • PBCameraMode
  • PBCameraModeArea
  • PBColor3
  • PBColor4
  • PBEngineInfo
  • PBGltfContainer
  • PBGltfContainerLoadingState
  • PBInputModifier
  • PBInputModifier_StandardInput
  • PBMainCamera
  • PBMaterial
  • PBMaterial_PbrMaterial
  • PBMaterial_UnlitMaterial
  • PBMeshCollider
  • PBMeshCollider_BoxMesh
  • PBMeshCollider_CylinderMesh
  • PBMeshCollider_PlaneMesh
  • PBMeshCollider_SphereMesh
  • PBMeshRenderer
  • PBMeshRenderer_BoxMesh
  • PBMeshRenderer_CylinderMesh
  • PBMeshRenderer_PlaneMesh
  • PBMeshRenderer_SphereMesh
  • PBNftShape
  • PBPlayerIdentityData
  • PBPointerEvents
  • PBPointerEventsResult
  • PBPointerEvents_Entry
  • PBPointerEvents_Info
  • PBPointerLock
  • PBPosition
  • PBQuaternion
  • PBRaycast
  • PBRaycastResult
  • PBRealmInfo
  • PBTextShape
  • PBTween
  • PBTweenSequence
  • PBTweenState
  • PBUiBackground
  • PBUiCanvasInformation
  • PBUiDropdown
  • PBUiDropdownResult
  • PBUiInput
  • PBUiInputResult
  • PBUiText
  • PBUiTransform
  • PBVector2
  • PBVector3
  • PBVideoEvent
  • PBVideoPlayer
  • PBVirtualCamera
  • PBVisibilityComponent
  • PointerEventsSystem
  • RaycastHit
  • RaycastSystem
  • Rect
  • Rotate
  • Scale
  • Spec
  • Texture
  • TextureHelper
  • TextureMove
  • TextureUnion
  • TransformComponentExtended
  • TweenComponentDefinitionExtended
  • TweenHelper
  • VideoEventsSystem
  • VideoTexture
  • VirtualCameraComponentDefinitionExtended
  • AppendValueMessage
  • AppendValueMessageBody
  • Color3Type
  • Color4Type
  • ComponentDefinition
  • Composite
  • CompositeProvider
  • CompositeResource
  • CompositeRootType
  • ConflictResolutionMessage
  • Coords
  • CrdtMessage
  • CrdtMessageBody
  • CrdtMessageHeader
  • CrdtNetworkMessageBody
  • DeepReadonly
  • DeepReadonlyMap
  • DeepReadonlyObject
  • DeepReadonlySet
  • DeleteComponentMessage
  • DeleteComponentMessageBody
  • DeleteComponentNetworkMessage
  • DeleteComponentNetworkMessageBody
  • DeleteEntityMessage
  • DeleteEntityMessageBody
  • DeleteEntityNetworkMessage
  • DeleteEntityNetworkMessageBody
  • Entity
  • EventSystemCallback
  • EventSystemOptions
  • ExcludeUndefined
  • GSetComponentGetter
  • GlobalDirectionRaycastOptions
  • GlobalDirectionRaycastSystemOptions
  • GlobalTargetRaycastOptions
  • GlobalTargetRaycastSystemOptions
  • IEntityContainer
  • IInputSystem
  • INetowrkEntity
  • INetowrkParent
  • ISyncComponents
  • IncludeUndefined
  • InstanceCompositeOptions
  • JsonArray
  • JsonMap
  • JsonPrimitive
  • JsonSchemaExtended
  • LocalDirectionRaycastOptions
  • LocalDirectionRaycastSystemOptions
  • LwwComponentGetter
  • MapResult
  • NameComponent
  • OnChangeFunction
  • OnlyNonUndefinedTypes
  • OnlyOptionalUndefinedTypes
  • PutComponentMessage
  • PutComponentMessageBody
  • PutNetworkComponentMessage
  • PutNetworkComponentMessageBody
  • QuaternionType
  • RaycastSystemCallback
  • RaycastSystemOptions
  • ReadOnlyGrowOnlyValueSetComponentDefinition
  • ReadOnlyLastWriteWinElementSetComponentDefinition
  • ReadonlyComponentSchema
  • ReadonlyPrimitive
  • ReceiveMessage
  • SystemFn
  • SystemItem
  • TargetEntityRaycastOptions
  • TargetEntityRaycastSystemOptions
  • Task
  • ToOptional
  • TransformComponent
  • TransformType
  • TransformTypeWithOptionals
  • Transport
  • TransportMessage
  • TweenSystem
  • Unpacked
  • ValueSetOptions
  • Vector3Type
  • VideoEventsSystemCallback
  • uint32
  • AvatarAnchorPointType
  • AvatarModifierType
  • BackgroundTextureMode
  • BillboardMode
  • CameraType
  • ColliderLayer
  • ComponentType
  • CrdtMessageType
  • EasingFunction
  • EntityMappingMode
  • EntityState
  • Font
  • InputAction
  • LoadingState
  • MaterialTransparencyMode
  • MediaState
  • NftFrameType
  • PointerEventType
  • PointerFilterMode
  • ProcessMessageResultType
  • RaycastQueryType
  • TextAlignMode
  • TextWrap
  • TextureFilterMode
  • TextureMovementType
  • TextureWrapMode
  • TweenLoop
  • TweenStateStatus
  • VideoState
  • YGAlign
  • YGDisplay
  • YGEdge
  • YGFlexDirection
  • YGJustify
  • YGOverflow
  • YGPositionType
  • YGUnit
  • YGWrap