Fx Tool Tasks
- Main page: FxGUI
Fx Tool Tasks, unlike Basic FxTasks that create instances in the Fx System, are utilities which perform operations on already existing instances of FxTasks. For example, the transformer moves or resizes instances of existing FxTasks, and the attacher tool attaches one FxTask to another, and so forth. Fx Tools appear on the righthand side of the Fx Toolbar.
|Attacher||Tool that attaches specified 3d instance to other specified 3d instance or character|
|Transformer||Tool that Transforms position, rotation and/or scale of a 3d instance from start to target|
|TransformArc||Tool specialized to transform that moves a 3d instance from start to target in an arc shape.|
|mFader||Tool that adjusts the alpha of models allowing fade in and fade out.|
|AnimCmd||Tool that sends the specified animation command string to specified character.|
|Fx||An optional organizational container.|
|X||Closes the Fx Control Bar and all other Fx GUI panels.|
|New! Fx Script Call||Generate a call to a client-side script. See Script Call Tool below|
An Attacher takes one instance and attaches (or parents) it to another instance. Once attached, an object will move with the parent. Any instance task can be attached to another when it starts but if you want attach an instance at any other time you must use an Attacher.
|AttachThis||The name of the instance that will be attached to another object.|
|AttachTo||The name of the instance that we will attach our object to.|
|AttachPosition||Offsets the attached object relative to its parent.|
|AttachRotation||Sets the rotation of the object being attached.|
|AttachRelative||When TRUE, maintains the objects current position relative to the parent its about to be attached to.|
Transformers can change the position, rotation and/or scale of an instance from one setting to another over time. Examples: Using a Transformer, we can take a any object and have it rotate around your characters head, spin around in any direction, or have it shrink or grow.
FxTransformer properties (specify what to transform)
|AssetName||The name of the instance that will be transformed.|
|StartLoc||If set to DEFAULT, the instance's current position becomes its starting position. Otherwise, we use the position of the specified instance as the starting position.|
|StartLocBone||If StartLoc is a character, this specifies a bone name to start at.|
|TargetLoc||If set to DEFAULT, the instance's current position becomes its target position. Otherwise, we use the position of the specified instance as the target position.|
|TargetLocBone||If TargetLoc is a character, this specifies a bone name to end at.|
Transform3D properties (specifies how to transform)
|UseOneCurveType||True means apply a single Interpolation Curve to the entire transformation. False allows you to set a different Interpolation Curve for every individual axis used in the transformation which allows some very complex transformations.|
|CurveType||Sets the Interpolation Curve to apply to the transformation. See [Interpolation Curve]|
|Delay||Amount of time to delay the start of a transformation. This delay starts AFTER any delay set in FxEvent StartDelay. (yeah it's redundant but part of Transform3d which was integrated into Fx)|
|Duration||Specifies the time interval to take to transform from the start to the target.|
|RepeatCount||How many times to perform this transformation. Must be at least 1.|
|Reverse||If true, the instance is transformed from start to target, then transformed back from target to start.|
|IgnorePosition||If true, the Position of the instance is not transformed.|
|IgnoreRotation||If true, the Rotation of the instance is not transformed.|
|IgnoreScale||If true, the Scale of the instance is not transformed.|
|StartPosition||Sets the position of the instance at the start of the transformation. Ignored if the a StartLoc is set to anything other than DEFAULT.|
|StartRotation||Sets the rotation of the instance at the start of the transformation.|
|StartScale||Sets the scale of the instance at the start of the transformation.|
|TargetPosition||The position that the instance will be transformed to. Ignored if the a TargetLoc is set to anything other than DEFAULT.|
|TargetRotation||The rotation that the instance will be transformed to.|
|TargetScale||The scale that the instance will be transformed to.|
|OffsetPosition||If set, transforms the object from its start position to this offset of that starting position.|
|OffsetRotation||If set, transforms the object from its start rotation to this offset of that starting rotation.|
|OffsetScale||If set, transforms the object from its start scale to this offset of that starting scale.|
A TransformArc is a special version of a transformer that moves an instance in an arc from its start position to a target position. Currently, arcs only support the Y axis (thus you get arcs similar to the path of a ball thrown into the air in front of you.
|AssetName||The name of the instance that will be moves along our arc.|
|ArcSize||Size or height of the arc (in standard units)|
|Duration||Time it takes to move our instance from its start position to the target position.|
|StartLoc||Specifies the starting location of the arc. If DEFAULT, the current position of the instance becomes the start position.|
|StartOffset||Offsets the start position from its specified start position.|
|TargetLoc||Specifies the target location of the arc. If DEFAULT, the current position of the instance becomes the target position.|
|TargetOffset||Offsets the target position from its specified target position.|
|RotateWithArc||If true, rotates the object along the arc as if it were an arrow.|
A ModelFader allows you to change the transparency of a model (3d mesh). It has several features similar to transformers, in that you specify a start and target alpha, duration of effect, interpolation curve, number of times to repeat, and reverse.
|AssetName||Specifies the instance to be faded. NOTE: Fading characters not yet supported.|
|CurveType||Sets the Interpolation Curve to apply to the fade.|
|Duration||The length of time it takes to fade from StartAlpha to EndAlpha|
|RepeatCount||Sets how many times to perform the fade. Minimum value 1.|
|Reverse||If true when the target alpha is achieved, fade continues from target to start.|
|StartAlpha||Starting alpha value. 1.0 is fully opaque. 0.0 is fully transparent.|
|EndAlpha||Ending alpha value. 1.0 is fully opaque. 0.0 is fully transparent.|
Allows you to send an animation command (also known as Behave command) to a character.
|ActorName||CASTER or TARGET. Characters can only be specified in the _Target class passed in at runtime.|
|AnimMode||Characters must be in the proper animation mode to accept an animation command for that mode.|
|AnimCmd||The text of the animation command. Example: Input Attacking Sideslash|
Script Call Tool
Allows you to call a script.
When this tool is started, a call is made a shared function (shown below) to the specified client script. This allows the scripter to tweak settings or make calls to other systems at predictable times.
shared function _FxScriptCallEvent(event as String, fxName as String, theFxGroup as NodeRef of Class _FxGroup) //----------------------------- // Called by task _FxScriptCall //----------------------------- .