Source 2 Animation System VScript API/CModelVScriptCompile.CreateIKControlRig

From Valve Developer Community
< Source 2 Animation System VScript API
Revision as of 06:21, 2 October 2017 by Rectus (talk | contribs) (Created page with "== Function Description == ''' int CModelVScriptCompile::CreateIKControlRig(string type, table parameters) ''' Creates an Inverse Kinematics rig out of a set of IK chains....")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function Description

int CModelVScriptCompile::CreateIKControlRig(string type, table parameters)

Creates an Inverse Kinematics rig out of a set of IK chains.

Parameters

Type Name Description
string type Type of the rig. Two types are known, "biped" and "bug".
table parameters IK rig parameters (see below).

Returns

int - Index of the IK rig.

Biped Parameters

When the type is set to "biped", a bipedal leg rig is created, suitable for humans and similar creatures. The parameters are added as keys in the parameters table.

Todo: This list is likely incomplete.
Name Type Description
pelvisBoneName string
tiltBone string
maxCenterOfMassDifference unknown
leftFootChain string Name of the left foot IK chain.
rightFootChain string Name of the right foot IK chain.


Bug Parameters

The "bug" type creates a rig for insect legs. The parameters are added as keys in the parameters table.

Todo: This list is likely incomplete.
Name Type Description
legs array of strings Names of all the IK chains for the individual legs.
Todo: Does order matter?
pivot_bone string
pivot_influence float
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Source_2_Animation_System_VScript_API/CModelVScriptCompile.CreateIKControlRig&oldid=210924"