AnimatorIK

Defined in: sdk/src/animation/animatorIK.ts:37

Properties

align?

optional align?: boolean

Defined in: sdk/src/animation/animatorIK.ts:54

foot-plant: lay the foot along the slope under it. Default true.

---

axis?

optional axis?: "x" | "y" | "z"

Defined in: sdk/src/animation/animatorIK.ts:50

look-at: the tip’s own axis that ends up pointing at the target.

---

kind

kind: AnimatorIKKind

Defined in: sdk/src/animation/animatorIK.ts:38

---

layers?

optional layers?: number

Defined in: sdk/src/animation/animatorIK.ts:60

foot-plant: the physics layers that count as ground. Default all of them.

---

parameter?

optional parameter?: string

Defined in: sdk/src/animation/animatorIK.ts:46

A float parameter scaling weight — how a game fades a constraint in.

---

pelvis?

optional pelvis?: string

Defined in: sdk/src/animation/animatorIK.ts:52

foot-plant: a joint lowered so the leg reaching the lowest foot still can: the hips.

---

pole?

optional pole?: string

Defined in: sdk/src/animation/animatorIK.ts:48

two-bone: a joint the middle one bends towards. Absent keeps its own bend.

---

reach?

optional reach?: number

Defined in: sdk/src/animation/animatorIK.ts:56

foot-plant: how far up and down to look for ground, in the rig’s units. Default the leg’s length.

---

smooth?

optional smooth?: number

Defined in: sdk/src/animation/animatorIK.ts:58

foot-plant: seconds to settle on a new height, so a step onto a kerb is not a jump. Default 0.06.

---

target

target: string

Defined in: sdk/src/animation/animatorIK.ts:42

What it should reach, or look at, named the same way.

---

tip

tip: string

Defined in: sdk/src/animation/animatorIK.ts:40

The joint the chain ends at, by the childPath a clip names it with.

---

weight?

optional weight?: number

Defined in: sdk/src/animation/animatorIK.ts:44

0 leaves the pose alone, 1 puts the tip on the target.