godotClassName

Other members in extension

Instance members

• var interpolation: Double

  Interpolation value for how much the IK results are applied to the current skeleton bone chain. A value of 1.0 will overwrite all skeleton bone transforms completely while a value of 0.0 will visually disable the SkeletonIK. A value at or below 0.01 also calls clearBonesGlobalPoseOverride.

• var magnet: Vector3

  Secondary target position (first is target property or targetNode) for the IK chain. Use magnet position (pole target) to control the bending of the IK chain. Only works if the bone chain has more than 2 bones. The middle chain bone position will be linearly interpolated with the magnet position.

• var maxIterations: Int32

  Number of iteration loops used by the IK solver to produce more accurate (and elegant) bone chain results.

• var minDistance: Double

  The minimum distance between bone and goal target. If the distance is below this value, the IK solver stops further iterations.

• var overrideTipBasis: Bool

  If true overwrites the rotation of the tip bone with the rotation of the target (or targetNode if defined).

• var rootBone: StringName

  The name of the current root bone, the first bone in the IK chain.

• var target: Transform3D

  First target of the IK chain where the tip bone is placed and, if overrideTipBasis is true, how the tip bone is rotated. If a targetNode path is available the nodes transform is used instead and this property is ignored.

• var targetNode: NodePath

  Target node NodePath for the IK chain. If available, the node’s current Transform3D is used instead of the target property.

• var tipBone: StringName

  The name of the current tip bone, the last bone in the IK chain placed at the target transform (or targetNode if defined).

• var useMagnet: Bool

  If true, instructs the IK solver to consider the secondary magnet target (pole target) when calculating the bone chain. Use the magnet position (pole target) to control the bending of the IK chain.

• func getParentSkeleton() -> Skeleton3D?

  Returns the parent Skeleton3D Node that was present when SkeletonIK entered the SceneTree. Returns null if the parent node was not a Skeleton3D Node when SkeletonIK3D entered the SceneTree.

• func isRunning() -> Bool

  Returns true if SkeletonIK is applying IK effects on continues frames to the Skeleton3D bones. Returns false if SkeletonIK is stopped or start(oneTime:) was used with the one_time parameter set to true.

• func start(oneTime: Bool)

  Starts applying IK effects on each frame to the Skeleton3D bones but will only take effect starting on the next frame. If oneTime is true, this will take effect immediately but also reset on the next frame.

• func stop()

  Stops applying IK effects on each frame to the Skeleton3D bones and also calls clearBonesGlobalPoseOverride to remove existing overrides on all bones.