Interface: InstallSkinnedFamilyOptions
Hierarchy
-
↳
InstallSkinnedFamilyOptions
Properties
entities
• entities: Entities
entity
• Optional entity: (id: string, pool: SkinnedInstancePool<any, SkinnedRigInfo>, options?: InstancedEntityOptions) => InstancedEntity<any, any>
A subclass of the family's Entity to register instead.
Type declaration
• new entity(id, pool, options?): InstancedEntity<any, any>
Parameters
| Name | Type |
|---|---|
id | string |
pool | SkinnedInstancePool<any, SkinnedRigInfo> |
options? | InstancedEntityOptions |
Returns
InstancedEntity<any, any>
lightAt
• Optional lightAt: (position: Vector3) => Color
The light an instance standing at a point is shaded with (multiplier
for its albedo). LightShined.lightAt fits; instances stay at the
pool's white default when this is unset.
Type declaration
▸ (position): Color
Parameters
| Name | Type |
|---|---|
position | Vector3 |
Returns
Color
Inherited from
InstancedEntityOptions.lightAt
lightIntervalFrames
• Optional lightIntervalFrames: number
Frames between light samples (staggered per entity). Defaults to 3.
Inherited from
InstancedEntityOptions.lightIntervalFrames
maxPerVariant
• Optional maxPerVariant: number
Instances per variant (and per baby variant). Defaults to 128.
roster
• roster: InstancedEntityRoster
Owns the pool: warms it, advances it, adds it to the scene.
world
• Optional world: World<any>