$boneflexdriver: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(Created page with "(Todo: What does this do?) == Example == $boneflexdriver "flexAnimBone" tx "testanim" 0 1 b")
 
No edit summary
Line 1: Line 1:
(Todo: What does this do?)
'''$boneflexdriver''' is a QC command which enables [[vertex animation]].
 
== Availability ==
 
* [[Source Filmmaker]]
* [[Dota 2]]
 
== Syntax ==
 
<syntaxhighlight lang=php>
$boneflexdriver <bone_name> <graph_axis> <flex_name> <start_offset> <time_factor>
</syntaxhighlight>
 
; bone_name
: The name of an existing bone that will host vertex animation for this model.
; graph_axis
: One of two values:
:; <code>tx</code>
:: Links the target flex controller to the weight of the animation (much like a [[skeletal animation]]'s). Normally set to 1.0.
:; <code>ty</code>
:: Links the target flex controller to the current frame of vertex animation. Normally increases from 0 to 1.0 over time.
; flex_name
: The name of the flex controller this command operates on. There are two sensible options:
:* <code><vca_name></code> (for tx)
:* <code>multi_<vca_name></code> (for ty)
: In both cases, <code><vca_name></code> is the name of the model's [[vcafile]] minus any file extension.
; start_offset
: Adds a delay before the vertex animation starts.
; time_factor
: The keyframe rate of the animation is multiplied by this value. It doesn't actually change the animation's duration however, making it of little use.


== Example ==
== Example ==


$boneflexdriver "flexAnimBone" tx "testanim" 0 1
The command should be used twice:


<syntaxhighlight lang=php>
$boneflexdriver "flexAnimBone" tx "my_vca_name" 0 1
$boneflexdriver "flexAnimBone" ty "multi_my_vca_name" 0 1
</syntaxhighlight>


[[Category:QC Commands|b]]
[[Category:QC Commands|b]]

Revision as of 02:58, 4 May 2014

$boneflexdriver is a QC command which enables vertex animation.

Availability

Syntax

$boneflexdriver <bone_name> <graph_axis> <flex_name> <start_offset> <time_factor>
bone_name
The name of an existing bone that will host vertex animation for this model.
graph_axis
One of two values:
tx
Links the target flex controller to the weight of the animation (much like a skeletal animation's). Normally set to 1.0.
ty
Links the target flex controller to the current frame of vertex animation. Normally increases from 0 to 1.0 over time.
flex_name
The name of the flex controller this command operates on. There are two sensible options:
  • <vca_name> (for tx)
  • multi_<vca_name> (for ty)
In both cases, <vca_name> is the name of the model's vcafile minus any file extension.
start_offset
Adds a delay before the vertex animation starts.
time_factor
The keyframe rate of the animation is multiplied by this value. It doesn't actually change the animation's duration however, making it of little use.

Example

The command should be used twice:

$boneflexdriver "flexAnimBone" tx "my_vca_name" 0 1
$boneflexdriver "flexAnimBone" ty "multi_my_vca_name" 0 1