Material ​Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
Interface · import type { Material } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 8. Materials and textures
A material parts wear: one Part.material reads, or one materials.create makes. Its one write is Frame.material, which changes every part that wears it for that frame; to change a look, wear another through a rule (PartWriteOptions.fadeMs crossfades).
| Member | Kind | Summary |
|---|---|---|
id |
property | For a worn MaterialNode: its nodeId. |
spec |
property | Intent read: the material's current values. |
disposed |
property | True once disposed. |
dispose |
method | Terminal and immediate. |
export interface Material<C extends object = NoCommitOptions> {
readonly id: string;
readonly spec: Readonly<MaterialSpec>;
readonly disposed: boolean;
dispose(): void;
}
| Rule | Result |
|---|---|
| 1. Neutral name | pass: Material names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | not recorded: no ledger row names this member or its owner |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |