Interface: SkinnedFamily<TVariant, TBone, TData>
Type parameters
| Name | Type |
|---|---|
TVariant | extends string |
TBone | extends string |
TData | extends InstancedEntityData |
Properties
Entity
• Readonly Entity: (id: string, pool: SkinnedInstancePool<TVariant, SkinnedRigInfo>, options?: InstancedEntityOptions) => InstancedEntity<TData, TVariant>
The entity class install registers; subclass it for more control.
Type declaration
• new Entity(id, pool, options?): InstancedEntity<TData, TVariant>
Parameters
| Name | Type |
|---|---|
id | string |
pool | SkinnedInstancePool<TVariant, SkinnedRigInfo> |
options? | InstancedEntityOptions |
Returns
InstancedEntity<TData, TVariant>
bone
• Readonly bone: Readonly<Record<TBone, number>>
Bone name to index.
config
• Readonly config: SkinnedFamilyConfig<TVariant, CanvasTexture<HTMLCanvasElement>>
The pool configuration this definition compiles to.
type
• Readonly type: string
Methods
createPool
▸ createPool(maxPerVariant?): SkinnedInstancePool<TVariant, SkinnedRigInfo>
Parameters
| Name | Type |
|---|---|
maxPerVariant? | number |
Returns
SkinnedInstancePool<TVariant, SkinnedRigInfo>
install
▸ install(options): SkinnedInstancePool<TVariant, SkinnedRigInfo>
Creates the pool, registers it on the roster, and registers the entity
class for type on entities. Returns the pool.
Parameters
| Name | Type |
|---|---|
options | InstallSkinnedFamilyOptions |
Returns
SkinnedInstancePool<TVariant, SkinnedRigInfo>