Class Material

Represents a material on a mesh.

Hierarchy

Asset
- Material

Implements

Index

Constructors

constructor

Methods

copy

Constructors

constructor

new Material(container: AssetContainer, def: AssetLike): Material

- Defined in src/asset/material.ts:185
INTERNAL USE ONLY. To create a new material from scratch, use [[AssetManager.createMaterial]].

Parameters
- container: AssetContainer
- def: AssetLike
Returns Material

Accessors

alphaCutoff

get alphaCutoff(): number
set alphaCutoff(value: number): void

- Defined in src/asset/material.ts:181
Visibility threshold in masked alpha mode

inheritdoc

Returns number
- Defined in src/asset/material.ts:182
Visibility threshold in masked alpha mode

Parameters
- value: number
Returns void

alphaMode

get alphaMode(): AlphaMode
set alphaMode(value: AlphaMode): void

- Defined in src/asset/material.ts:177
How the color/texture's alpha channel should be handled

inheritdoc

Returns AlphaMode
- Defined in src/asset/material.ts:178
How the color/texture's alpha channel should be handled

Parameters
- value: AlphaMode
Returns void

animationData

get animationData(): AnimationData

Inherited from Asset.animationData
- Defined in src/asset/asset.ts:99
Only populated when this asset is animation data. An asset will only have one of these types specified.

inheritdoc

Returns AnimationData

color

get color(): Color4
set color(value: Color4): void

- Defined in src/asset/material.ts:93
The base color of this material.

inheritdoc

Returns Color4
- Defined in src/asset/material.ts:94
The base color of this material.

Parameters
- value: Color4
Returns void

created

get created(): Promise<void>

Inherited from Asset.created
- Defined in src/asset/asset.ts:112
A promise that resolves when the asset is finished loading

Returns Promise<void>

emissiveColor

get emissiveColor(): Color3
set emissiveColor(value: Color3): void

- Defined in src/asset/material.ts:135
The lighting-independent color of this material.

inheritdoc

Returns Color3
- Defined in src/asset/material.ts:136
The lighting-independent color of this material.

Parameters
- value: Color3
Returns void

emissiveTexture

get emissiveTexture(): Texture
set emissiveTexture(value: Texture): void

- Defined in src/asset/material.ts:139
Returns Texture

A shared reference to this material's texture asset
- Defined in src/asset/material.ts:142
Parameters
- value: Texture
Returns void

A shared reference to this material's texture asset

emissiveTextureId

get emissiveTextureId(): Guid
set emissiveTextureId(value: Guid): void

- Defined in src/asset/material.ts:147
The emissive (unlit) texture asset ID

inheritdoc

Returns Guid
- Defined in src/asset/material.ts:148
The emissive (unlit) texture asset ID

Parameters
- value: Guid
Returns void

emissiveTextureOffset

get emissiveTextureOffset(): Vector2
set emissiveTextureOffset(value: Vector2): void

- Defined in src/asset/material.ts:169
The emissive texture's offset from default

inheritdoc

Returns Vector2
- Defined in src/asset/material.ts:170
The emissive texture's offset from default

Parameters
- value: Vector2
Returns void

emissiveTextureScale

get emissiveTextureScale(): Vector2
set emissiveTextureScale(value: Vector2): void

- Defined in src/asset/material.ts:173
The emissive texture's scale from default

inheritdoc

Returns Vector2
- Defined in src/asset/material.ts:174
The emissive texture's scale from default

Parameters
- value: Vector2
Returns void

id

get id(): Guid

Inherited from Asset.id
- Defined in src/asset/asset.ts:90
The unique id of this asset. Use this to reference this asset in actors, etc.

inheritdoc

Returns Guid

mainTexture

get mainTexture(): Texture
set mainTexture(value: Texture): void

- Defined in src/asset/material.ts:97
Returns Texture

A shared reference to this material's texture asset
- Defined in src/asset/material.ts:100
Parameters
- value: Texture
Returns void

A shared reference to this material's texture asset

mainTextureId

get mainTextureId(): Guid
set mainTextureId(value: Guid): void

- Defined in src/asset/material.ts:105
The main (albedo) texture asset ID

inheritdoc

Returns Guid
- Defined in src/asset/material.ts:106
The main (albedo) texture asset ID

Parameters
- value: Guid
Returns void

mainTextureOffset

get mainTextureOffset(): Vector2
set mainTextureOffset(value: Vector2): void

- Defined in src/asset/material.ts:127
The main texture's offset from default

inheritdoc

Returns Vector2
- Defined in src/asset/material.ts:128
The main texture's offset from default

Parameters
- value: Vector2
Returns void

mainTextureScale

get mainTextureScale(): Vector2
set mainTextureScale(value: Vector2): void

- Defined in src/asset/material.ts:131
The main texture's scale from default

inheritdoc

Returns Vector2
- Defined in src/asset/material.ts:132
The main texture's scale from default

Parameters
- value: Vector2
Returns void

material

get material(): Material

Overrides Asset.material
- Defined in src/asset/material.ts:185
Only populated when this asset is a material. An asset will have only one of these types specified.

inheritdoc

Returns Material

mesh

get mesh(): Mesh

Inherited from Asset.mesh
- Defined in src/asset/asset.ts:103
Only populated when this asset is a mesh. An asset will have only one of these types specified.

inheritdoc

Returns Mesh

name

get name(): string

Inherited from Asset.name
- Defined in src/asset/asset.ts:93
A human-readable string identifying the asset. Not required to be unique, but can be referenced by name if it is.

inheritdoc

Returns string

prefab

get prefab(): Prefab

Inherited from Asset.prefab
- Defined in src/asset/asset.ts:101
Only populated when this asset is a prefab. An asset will have only one of these types specified.

inheritdoc

Returns Prefab

sound

get sound(): Sound

Inherited from Asset.sound
- Defined in src/asset/asset.ts:109
Only populated when this asset is a sound. An asset will have only one of these types specified.

inheritdoc

Returns Sound

source

get source(): AssetSource

Inherited from Asset.source
- Defined in src/asset/asset.ts:96
Where this asset came from. Used for loading on late-joining clients.

inheritdoc

Returns AssetSource

texture

get texture(): Texture

Inherited from Asset.texture
- Defined in src/asset/asset.ts:107
Only populated when this asset is a texture. An asset will have only one of these types specified.

inheritdoc

Returns Texture

Methods

copy

copy(from: Partial<AssetLike>): this

Overrides Asset.copy
- Defined in src/asset/material.ts:257
Parameters
- from: Partial<AssetLike>
Returns this