RealityOS Docs and Examples

Appearance

@tmrw-realityos/charm • Docs

@tmrw-realityos/charm / tmrwRooms / NativeRoomAPI

Interface: NativeRoomAPI ​

Properties ​

collisionNormal ​

collisionNormal: vec3

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:631

collisionPosition ​

collisionPosition: vec3

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:630

Methods ​

addEntity() ​

addEntity(_0, _1): void

Parameters ​

• _0: NativeEntity

• _1: EmbindString

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:670

addOpticalFlowSession() ​

addOpticalFlowSession(): number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:649

createEntity() ​

createEntity(_0, _1, _2, _3, _4): number

Parameters ​

• _0: EmbindString

• _1: EmbindString

• _2: EmbindString

• _3: EmbindString

• _4: number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:668

createEntityByID() ​

createEntityByID(_0): NativeEntity

Parameters ​

• _0: number

Returns ​

NativeEntity

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:645

createEntityEmpty() ​

createEntityEmpty(): NativeEntity

Returns ​

NativeEntity

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:633

createMaterial() ​

createMaterial(_0): NativeMaterial

Parameters ​

• _0: EmbindString

Returns ​

NativeMaterial

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:669

decalPaint() ​

decalPaint(_0, _1, _2): void

Parameters ​

• _0: number

• _1: number

• _2: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:646

decalPlace() ​

decalPlace(_0, _1, _2): NativeEntity

Parameters ​

• _0: NativeEntity

• _1: vec3

• _2: vec3

Returns ​

NativeEntity

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:654

decalsClear() ​

decalsClear(): void

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:637

decalsConfigDensity() ​

decalsConfigDensity(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:659

decalsConfigDepthThreshold() ​

decalsConfigDepthThreshold(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:663

decalsConfigMetalness() ​

decalsConfigMetalness(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:661

decalsConfigNormalScale() ​

decalsConfigNormalScale(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:664

decalsConfigPOM() ​

decalsConfigPOM(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:642

decalsConfigPOMDisplacement() ​

decalsConfigPOMDisplacement(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:665

decalsConfigPOMHeightBias() ​

decalsConfigPOMHeightBias(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:667

decalsConfigPOMSelfShadow() ​

decalsConfigPOMSelfShadow(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:666

decalsConfigRotation() ​

decalsConfigRotation(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:660

decalsConfigRoughness() ​

decalsConfigRoughness(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:662

decalsConfigScale() ​

decalsConfigScale(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:658

decalsConfigTexture() ​

decalsConfigTexture(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:647

decalsConfigTextureNormal() ​

decalsConfigTextureNormal(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:648

decalsUndo() ​

decalsUndo(): void

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:636

delete() ​

delete(): void

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:675

destroyEntity() ​

destroyEntity(_0): boolean

Parameters ​

• _0: number

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:644

destroyEntityObj() ​

destroyEntityObj(_0): boolean

Parameters ​

• _0: NativeEntity

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:639

disableRendering() ​

disableRendering(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:638

findNodeByName() ​

findNodeByName(_0): NativeNode

Parameters ​

• _0: EmbindString

Returns ​

NativeNode

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:671

getEntity() ​

getEntity(_0): NativeEntity

Parameters ​

• _0: number

Returns ​

NativeEntity

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:643

getInspectedEntity() ​

getInspectedEntity(): NativeEntity

Returns ​

NativeEntity

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:632

getMaterial() ​

getMaterial(_0): NativeMaterial

Parameters ​

• _0: EmbindString

Returns ​

NativeMaterial

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:672

getMaterialCombinations() ​

getMaterialCombinations(): string

Returns ​

string

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:673

getMaterials() ​

getMaterials(): any

Returns ​

any

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:674

getRootNode() ​

getRootNode(): NativeNode

Returns ​

NativeNode

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:634

getTimeOfDay() ​

getTimeOfDay(): number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:655

isMouseBlockedByGUI() ​

isMouseBlockedByGUI(): boolean

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:640

optFlowGetTexture() ​

optFlowGetTexture(_0, _1): number

Parameters ​

• _0: number

• _1: number

Returns ​

number

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:653

optFlowHFTexture() ​

optFlowHFTexture(_0, _1, _2, _3): void

Parameters ​

• _0: number

• _1: number

• _2: number

• _3: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:651

optFlowLFTexture() ​

optFlowLFTexture(_0, _1, _2, _3): void

Parameters ​

• _0: number

• _1: number

• _2: number

• _3: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:652

releaseOpticalFlowSession() ​

releaseOpticalFlowSession(_0): void

Parameters ​

• _0: number

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:650

resetMaterialCombinations() ​

resetMaterialCombinations(): void

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:635

setAdvancedVideoBlend() ​

setAdvancedVideoBlend(_0): void

Parameters ​

• _0: boolean

Returns ​

void

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:641

setTimeOfDay() ​

setTimeOfDay(_0): boolean

Parameters ​

• _0: number

Returns ​

boolean

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:656

testRay() ​

testRay(_0, _1, _2, _3): NativeEntity

Parameters ​

• _0: vec3

• _1: vec3

• _2: number

• _3: number

Returns ​

NativeEntity

Defined in ​

node_modules/.pnpm/@tmrw-realityos+native@5.18.10/node_modules/@tmrw-realityos/native/artifacts/tmrwRooms-nt.d.ts:657