RealityOS Docs and Examples

Appearance

@tmrw-realityos/charm • Docs

@tmrw-realityos/charm / tmrwRooms / NativeEntity

Interface: NativeEntity ​

Properties ​

enabled ​

enabled: boolean

Defined in ​

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

hover ​

hover: boolean

Defined in ​

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

layers ​

layers: number

Defined in ​

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

name ​

name: EmbindString

Defined in ​

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

native ​

native: boolean

Defined in ​

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

node ​

readonly node: NativeNode

Defined in ​

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

type ​

type: NativeEntity$Type

Defined in ​

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

Methods ​

createComponent() ​

createComponent(_0): NativeEntityComponent

Parameters ​

• _0: EmbindString

Returns ​

NativeEntityComponent

Defined in ​

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

createNode() ​

createNode(_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:767

createRootNode() ​

createRootNode(_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:766

decalGetNormal() ​

decalGetNormal(): vec3

Returns ​

vec3

Defined in ​

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

decalProject() ​

decalProject(): void

Returns ​

void

Defined in ​

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

decalSetDepthThreshold() ​

decalSetDepthThreshold(_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:755

decalSetFlipU() ​

decalSetFlipU(_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:735

decalSetFlipV() ​

decalSetFlipV(_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:736

decalSetIntensity() ​

decalSetIntensity(_0) ​

decalSetIntensity(_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:752

decalSetIntensity(_0) ​

decalSetIntensity(_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:754

decalSetMetalness() ​

decalSetMetalness(_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:756

decalSetNormalScale() ​

decalSetNormalScale(_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:758

decalSetPOM() ​

decalSetPOM(_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:734

decalSetPOMAlphaFading() ​

decalSetPOMAlphaFading(_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:762

decalSetPOMDisplacement() ​

decalSetPOMDisplacement(_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:759

decalSetPOMHeightBias() ​

decalSetPOMHeightBias(_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:761

decalSetPOMSelfShadow() ​

decalSetPOMSelfShadow(_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:760

decalSetPreset() ​

decalSetPreset(_0): void

Parameters ​

• _0: EmbindString

Returns ​

void

Defined in ​

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

decalSetRotation() ​

decalSetRotation(_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:753

decalSetRoughness() ​

decalSetRoughness(_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:757

decalSetSize() ​

decalSetSize(_0): void

Parameters ​

• _0: vec3

Returns ​

void

Defined in ​

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

decalSetSquare() ​

decalSetSquare(_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:733

decalSetTextures() ​

decalSetTextures(_0, _1): void

Parameters ​

• _0: EmbindString

• _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:774

decalUnprojected() ​

decalUnprojected(): boolean

Returns ​

boolean

Defined in ​

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

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:777

getAnimDuration() ​

getAnimDuration(_0): number

Parameters ​

• _0: EmbindString

Returns ​

number

Defined in ​

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

getBodyNode() ​

getBodyNode(): NativeNode

Returns ​

NativeNode

Defined in ​

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

getComponent() ​

getComponent(_0): NativeEntityComponent

Parameters ​

• _0: EmbindString

Returns ​

NativeEntityComponent

Defined in ​

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

getID() ​

getID(): number

Returns ​

number

Defined in ​

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

getInfoNode() ​

getInfoNode(): NativeNode

Returns ​

NativeNode

Defined in ​

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

getMouseInteractive() ​

getMouseInteractive(): boolean

Returns ​

boolean

Defined in ​

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

getPrefabComponent() ​

getPrefabComponent(): NativeEntityPrefabComponent

Returns ​

NativeEntityPrefabComponent

Defined in ​

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

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:719

getStreamNode() ​

getStreamNode(): NativeNode

Returns ​

NativeNode

Defined in ​

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

getWalkNode() ​

getWalkNode(): NativeNode

Returns ​

NativeNode

Defined in ​

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

lastCollidedNode() ​

lastCollidedNode(): NativeNode

Returns ​

NativeNode

Defined in ​

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

lightSetArea() ​

lightSetArea(_0): void

Parameters ​

• _0: vec2

Returns ​

void

Defined in ​

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

lightSetCastShadows() ​

lightSetCastShadows(_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:737

lightSetColor() ​

lightSetColor(_0): void

Parameters ​

• _0: vec3

Returns ​

void

Defined in ​

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

lightSetDirection() ​

lightSetDirection(_0): void

Parameters ​

• _0: vec3

Returns ​

void

Defined in ​

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

lightSetFalloff() ​

lightSetFalloff(_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:764

lightSetIntensity() ​

lightSetIntensity(_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:763

lightSetSpotCone() ​

lightSetSpotCone(_0, _1): void

Parameters ​

• _0: number

• _1: number

Returns ​

void

Defined in ​

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

lightSetTexture() ​

lightSetTexture(_0, _1): void

Parameters ​

• _0: EmbindString

• _1: number

Returns ​

void

Defined in ​

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

lightSetType() ​

lightSetType(_0): void

Parameters ​

• _0: NativeLight$Type

Returns ​

void

Defined in ​

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

mouseInteraction() ​

mouseInteraction(_0, _1, _2, _3, _4): void

Parameters ​

• _0: number

• _1: number

• _2: number

• _3: number

• _4: number

Returns ​

void

Defined in ​

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

physicalizeEntity() ​

physicalizeEntity(_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:740

removeComponent() ​

removeComponent(_0) ​

removeComponent(_0): void

Parameters ​

• _0: NativeEntityComponent

Returns ​

void

Defined in ​

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

removeComponent(_0) ​

removeComponent(_0): void

Parameters ​

• _0: EmbindString

Returns ​

void

Defined in ​

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

setAnimTime() ​

setAnimTime(_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:751

setColor() ​

setColor(_0): void

Parameters ​

• _0: vec4

Returns ​

void

Defined in ​

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

setInteractive() ​

setInteractive(_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:731

setOutline() ​

setOutline(_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:728

setPosition() ​

setPosition(_0): void

Parameters ​

• _0: vec3

Returns ​

void

Defined in ​

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

setRotation() ​

setRotation(_0): void

Parameters ​

• _0: vec4

Returns ​

void

Defined in ​

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

setScale() ​

setScale(_0): void

Parameters ​

• _0: vec3

Returns ​

void

Defined in ​

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

setTexture() ​

setTexture(_0, _1, _2): void

Parameters ​

• _0: EmbindString

• _1: number

• _2: boolean

Returns ​

void

Defined in ​

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

setUrl() ​

setUrl(_0): void

Parameters ​

• _0: EmbindString

Returns ​

void

Defined in ​

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

setWalkingMode() ​

setWalkingMode(_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:729

unprojectPos() ​

unprojectPos(_0): void

Parameters ​

• _0: vec2

Returns ​

void

Defined in ​

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