Class: IWSDKInteractions

Defined in: packages/iwsdk-interactions/src/register.ts:149

Constructors

Constructor

new IWSDKInteractions(world: World, options?: IWSDKRegisterOptions): IWSDKInteractions;

Defined in: packages/iwsdk-interactions/src/register.ts:157

Parameters

Parameter	Type
world	World
options	IWSDKRegisterOptions

Returns

IWSDKInteractions

Properties

Property	Modifier	Type	Defined in
provider	readonly	IWSDKInputProvider	packages/iwsdk-interactions/src/register.ts:151
runtime	readonly	InteractionRuntime	packages/iwsdk-interactions/src/register.ts:150

Methods

dispose()

dispose(): void;

Defined in: packages/iwsdk-interactions/src/register.ts:260

Returns

void

---

getEntity()

getEntity(id: string): Entity | undefined;

Defined in: packages/iwsdk-interactions/src/register.ts:200

Parameters

Parameter	Type
id	string

Returns

Entity | undefined

---

getPort()

getPort(id: string): IWSDKTransformPort | undefined;

Defined in: packages/iwsdk-interactions/src/register.ts:196

Parameters

Parameter	Type
id	string

Returns

IWSDKTransformPort | undefined

---

register()

register(
   descriptor: InteractableDescriptor, 
   entity: Entity, 
   options?: IWSDKRegisterEntityOptions
): IWSDKTransformPort | undefined;

Defined in: packages/iwsdk-interactions/src/register.ts:167

Parameters

Parameter	Type
descriptor	InteractableDescriptor
entity	Entity
options	IWSDKRegisterEntityOptions

Returns

IWSDKTransformPort | undefined

---

tick()

tick(
   delta: number, 
   pressedEntities: Iterable<Entity>, 
   grabbedEntities: Iterable<Entity>
): void;

Defined in: packages/iwsdk-interactions/src/register.ts:205

Called by the bridge system once per frame.

Parameters

Parameter	Type
delta	number
pressedEntities	Iterable<Entity>
grabbedEntities	Iterable<Entity>

Returns

void

---

unregister()

unregister(id: string): void;

Defined in: packages/iwsdk-interactions/src/register.ts:189

Parameters

Parameter	Type
id	string

Returns

void