Documentation

modifier2d component

Poses 2D bones toward target after the clip runs. kind is look_at, two_bone_ik, fabrik, ccdik, jiggle or follow; follow moves the node by offset and lag.

Di halaman ini

Properties

2d · animation · 16 properties · 2D

Poses 2D bones toward target after the clip runs. kind is look_at, two_bone_ik, fabrik, ccdik, jiggle or follow; follow moves the node by offset and lag.

In a scene, modifier2d is the node key that applies it. A script reaches each property below as a field on node.modifier2d: reading one asks the running component, and assigning one leaves the rest alone. The whole table is node.modifier2d.get() and node.modifier2d.set(table).

Properties

property	type	default	description
`angle_limit`	float	`0`	How far a ccdik bone may turn from its rest, in radians; 0 leaves it free
`bone`	node	—	The driven bone; empty means this node. For a chain solver, its root
`chain_count`	int	`0`	How many bones the chain holds, counting the driven one; 0 walks to the deepest tip
`damping`	float	`0.75`	How much of a jiggle bone's speed survives a tick, 0 to 1
`enabled`	bool	`true`	Whether the modifier runs; off leaves the clip's pose alone
`flip_bend_direction`	bool	`false`	Bend a two-bone chain the other way
`gravity`	vec3	`[0,-6,0]`	Pull on a jiggle bone while `use_gravity` is on
`iterations`	int	`10`	Solver passes for fabrik and ccdik
`kind`	enum	`look_at`	Aim one bone at the target, bend a two-bone chain to it, reach with a chain of any length (fabrik or ccdik), let a chain lag behind the pose (jiggle), or trail the target at an offset (follow) One of `look_at`, `two_bone_ik`, `fabrik`, `ccdik`, `jiggle`, `follow`.
`lag`	float	`0`	Seconds a follow node takes to close most of the gap to its target; 0 pins it there
`mass`	float	`0.75`	What gravity weighs against stiffness on a jiggle bone
`offset`	vec3	`[0,0,0]`	Where a follow node sits relative to its target, in world units
`stiffness`	float	`3`	How hard a jiggle bone is pulled back to the pose
`target`	node	—	The point to aim at. Unused by jiggle
`tolerance`	float	`0.01`	How close to the target ends a fabrik or ccdik solve early
`use_gravity`	bool	`false`	Whether a jiggle chain is pulled by `gravity`