Info about animation script
07-24-2024, 07:34 PM
write XXX in my local name, this way I'm sure it is not already use by the default local.
1. you need to create a SContainer and a TContainer Locals.
The TContainer will use the first local of the scene file (the one with: Object.Name "Shared/Item/R9ToyXXX.ma"; ) as parent and be connected to the SContainer.
The SContainer will contain all the animations of your scene file.
If toy will not really need use of multiple animation, room however may do (eg room with tv, npc, ceiling fan and other animated object in it)
2. you will need to create the "AnimationScheduler :local" linked in your "SContainer :local".
This AnimationScheduler :local will be linked to One "ConnectionGroup :local" and possibly multiple "AnimationClip :local".
These "AnimationClip :local" seem to be sub-animation...
but unleast you manage to tell the game that you only want to use a specific sub-animation of your animation, do yourself a favor and only link one "AnimationClip :local"
Note that the "Object.Name" of your "AnimationScheduler :local" and the "Object.Name" of your "ConnectionGroup :local" are extremely linked:
Your "Object.Name" of your "AnimationScheduler :local" should be exactly "Object.Name" of your "ConnectionGroup :local" + the word "Scheduler".
Nothing more, nothing less.
A simple char difference will prevent your animation to work.
3. you will need to create the "ConnectionGroup :local" previously linked.
This local will contain the name of your animation (will be require in some other .bs file).
This local will contain movement type ("ConnectionGroup.Member") and some :local("ConnectionGroup.Object") that will be both connected to the movement type and the object(eg mesh) you want to animate.
Normally, the :local for your mesh should already exist.(look at step 4)
Note that each line (parameter) of your "ConnectionGroup :local" must contain the same number of item.
Each item go together: the first item of "ConnectionGroup.Object" go with the first item of "ConnectionGroup.Member"...
4. let create the local linked in "ConnectionGroup.Object" from your "ConnectionGroup :local" (if they don't already exist.)
however, if "Object.Name" of "TTransform :local is "tool_group", that mean that this local is the master one(It move all the mesh at the same time).
If it is the case and that you dont want all your object to move, you will need to create a new S/TTtansform local and connect your TNode.Parent TTransform from your TPolygonGeometry to it. You will also use the "TTransform :local" having "tool_group" as name, the parent of your newly created "TTransform :local".
For texture animation:
You need link the "TexCoordTransform" paramter to a new local, then use the parent in the new local.
5. you need to create the "AnimationClip :local" (sub-animation) linked in your "AnimationScheduler :local".
This local will be linked to a "AnimationLibrary :local" and may possibly contain the "StartTime" parameter.
As I can see, this "StartTime" is simply a delay before to start the animation.
6. you need to create the "AnimationLibrary :local" linked in your "AnimationClip :local".
This local will contain a "EndTime" parameter, which is actually your animation lenght.
This local will contain a "Curve" parameter, which will contain a :local for each "ConnectionGroup.Member" (movement type) writed in your "ConnectionGroup :local".
7. you need to create all the "SplineVector3f :local" linked in your "AnimationLibrary :local".
The "SplineVector3f.KeyValue Array_Vector3f" parameter control the movement value( eg. (0, 120, 0) if used with a rotation type movement normaly mean a rotation of 120 degree on the y axis.
The "SplineVector3f.KeyTangentIn/Out Array_Vector3f" seem to have some kind of "push/pull" effect.
When used for texture animation: if used with a value of 0: (0, 0, 0) , you see the image sliding to each frame (like a slide show).
If using value of 2.00000003e+030: (2.00000003e+030, 2.00000003e+030, 0), the image change with/out the sliding affect = perfect.
Any other value cause a shaking affect.
Whatever value you use, "SplineVector3f.KeyTangentIn" and "SplineVector3f.KeyTangentOut" seem to do the same thing= use the value you want on one of the two and let teh other one with a value of 0.
The "SplineBase.KeyTime Array_F32" Control the timing. (eg. a value of 372.154 mean: when the animation will reach the time of 372.154F)
Note that each line (parameter) of your "SplineVector3f :local" must contain the same number of item.
Each item go together: the first item of "SplineVector3f.KeyValue Array_Vector3f" go with the first item of "SplineBase.KeyTime Array_F32"...
From what I can see, it look that's better to start with a value of 0.
. We're done with the scene file, now it's time to move to the script Ac file.
For Room: \Scripts\Luder\RoomXXX\AcRoomXXX.bs
For Toy: \Scripts\Luder\Item\AcToolXXX.bs
You should normaly, have a ".ComponentArray [ ]" inside it you will add the script for using the animation.
First, you will write a AppCharacter, an AppAction and an AppImportSound (only if you need sound effect).
9.Only one file remaining, just remember that your "Action" name in this step his the .ActionPrefix + .Name of your .AppAction
For toy:
\Scripts\Shared\Common\TcToolsR9ToyXXX.bs
You simply need to add the .InitActionArray, .ActivityActionArray ( and .ToolSoundActivity if you use sound effect)
For Room:
\Scripts\Luder\Common\RoomXXX.bs
The .RoomSituation parameter must contain a value higher than 0.
\Scripts\Luder\RoomXXX\AvRoomXXX.bs
You must have a Def [ AvPose . { inside your AvSituation quote.
than for each animation, you simply need to add a ".Do [ AvPlay . {" inside the AvSituation quote.
1. you need to create a SContainer and a TContainer Locals.
The TContainer will use the first local of the scene file (the one with: Object.Name "Shared/Item/R9ToyXXX.ma"; ) as parent and be connected to the SContainer.
The SContainer will contain all the animations of your scene file.
If toy will not really need use of multiple animation, room however may do (eg room with tv, npc, ceiling fan and other animated object in it)
Code:
TContainer :local_Container . {[/color]
[color=#000000]TNode.SNode SContainer :local_SContainer;[/color]
[color=#000000]TNode.Parent TTransform :local_1;[/color]
[color=#000000]Object.Name "Container";[/color]
[color=#000000]};[/color]
[color=#000000]SContainer :local_SContainer . {[/color]
[color=#000000]SContainer.Object [ AnimationScheduler :local_myAnimationScheduler , AnimationScheduler :local_mySecondAnimationScheduler]; // All the animations, each animation use a different "AnimationScheduler :local"[/color]
[color=#000000]Object.Name "SContainer";[/color]
[color=#000000]};[/color]
[color=#000000]//Note that I will only write the script of the ":local_myAnimationScheduler".2. you will need to create the "AnimationScheduler :local" linked in your "SContainer :local".
This AnimationScheduler :local will be linked to One "ConnectionGroup :local" and possibly multiple "AnimationClip :local".
These "AnimationClip :local" seem to be sub-animation...
but unleast you manage to tell the game that you only want to use a specific sub-animation of your animation, do yourself a favor and only link one "AnimationClip :local"
Code:
AnimationScheduler :local_myAnimationScheduler . {[/color]
[color=#000000]AnimationScheduler.ConnectionGroup ConnectionGroup :local_myAnimation;[/color]
[color=#000000]AnimationScheduler.AnimationClip [ AnimationClip :local_myAnimation_Start]; // sub-animation[/color]
[color=#000000]Object.Name "myAnimationScheduler";[/color]
[color=#000000]};Note that the "Object.Name" of your "AnimationScheduler :local" and the "Object.Name" of your "ConnectionGroup :local" are extremely linked:
Your "Object.Name" of your "AnimationScheduler :local" should be exactly "Object.Name" of your "ConnectionGroup :local" + the word "Scheduler".
Nothing more, nothing less.
A simple char difference will prevent your animation to work.
3. you will need to create the "ConnectionGroup :local" previously linked.
This local will contain the name of your animation (will be require in some other .bs file).
This local will contain movement type ("ConnectionGroup.Member") and some :local("ConnectionGroup.Object") that will be both connected to the movement type and the object(eg mesh) you want to animate.
Normally, the :local for your mesh should already exist.(look at step 4)
Note that each line (parameter) of your "ConnectionGroup :local" must contain the same number of item.
Each item go together: the first item of "ConnectionGroup.Object" go with the first item of "ConnectionGroup.Member"...
Code:
ConnectionGroup :local_myAnimation . {[/color]
[color=#000000]ConnectionGroup.Object [ STransform :local_XXX6 , STransform :local_XXX6 , STransform :local_XXX7]; //parent objects[/color]
[color=#000000]ConnectionGroup.Member [ @ SSimpleTransform.Translation , @ SSimpleTransform.Rotation , @ SSimpleTransform.Translation]; //Movement type: .Rotation, .Translation, .Scaling...[/b][/color]
[color=#000000]ConnectionGroup.MemberIndex Array_I32 [ 0, 0, 0]; //Don't know, simply write enough "0" to fit the required number of items.[/color]
[color=#000000]ConnectionGroup.MemberMask Array_U32 [ 0, 0, 0]; //Don't know, simply write enough "0" to fit the required number of items.[/color]
[color=#000000]Object.Name "myAnimation"; //The name of your animation[/color]
[color=#000000]};[/color]
[color=#000000]//Here, all the mesh using the ":local_XXX6" as parent will receive Translation and rotation movement type.[/color]
[color=#000000]//All the mesh using the ":local_XXX7" as parent will receive translation movement type.[/color]
[color=#000000]//These "STransform :local" contain the postion of your object mesh (axis postion, rotation)...[/color]
[color=#000000]//If you create a new one you will lose these position info.4. let create the local linked in "ConnectionGroup.Object" from your "ConnectionGroup :local" (if they don't already exist.)
Code:
PolygonGeometry :local_31 . {[/color]
[color=#000000]TGeometry.Shader RenderShader :local_32;[/color]
[color=#000000]TNode.SNode SPolygonGeometry :local_33;[/color]
[color=#000000]TNode.Parent TTransform :local_29;// Find the local writed at this line[/color]
[color=#000000]TNode.BoundingSphere Spheref( 3.086155175e-006, 7.148627788e-007, -9.999999975e-007, 1.000000027e+016 );[/color]
[color=#000000]Object.Name "tool_R9Toy148_Object03_meshShape";[/color]
[color=#000000]};[/color]
[color=#000000]TTransform :local_29 . {[/color]
[color=#000000]TNode.SNode STransform :local_30;//Find this local, it is the one that should be connected in your "ConnectionGroup :local".[/color]
[color=#000000]TNode.Parent TTransform :local_5;[/color]
[color=#000000]Object.Name "tool_R9Toy148_Object03"; //pay attention to this name, to make sure it is not the master TTransform local.[/color]
[color=#000000]};[/color]
[color=#000000]STransform :local_30 . {[/color]
[color=#000000]SSimpleTransform.Rotation Vector3f( 0.000003, 0.000000, 0.000000 );[/color]
[color=#000000]Object.Name "Stool_R9Toy148_Object03";[/color]
[color=#000000]};however, if "Object.Name" of "TTransform :local is "tool_group", that mean that this local is the master one(It move all the mesh at the same time).
If it is the case and that you dont want all your object to move, you will need to create a new S/TTtansform local and connect your TNode.Parent TTransform from your TPolygonGeometry to it. You will also use the "TTransform :local" having "tool_group" as name, the parent of your newly created "TTransform :local".
Code:
TTransform :local_5 . {[/color]
[color=#000000]TNode.SNode STransform :local_6; //[/color]
[color=#000000]TNode.Parent TTransform :local_1;[/color]
[color=#000000]Object.Name "tool_group"; //have "tool_group" as name...[/color]
[color=#000000]};[/color]
[color=#000000]//So let create new local...[/color]
[color=#000000]TTransform :local_XXX12 . {[/color]
[color=#000000]TNode.SNode STransform :local_XXX6;[/color]
[color=#000000]TNode.Parent TTransform :local_5; //use the "TTransform :local" having "tool_group" as name for parent.[/color]
[color=#000000]Object.Name "myAnim1_group";[/color]
[color=#000000]};[/color]
[color=#000000]STransform :local_XXX6 Object.Name "SmyAnim_group1";[/color]
[color=#000000]TPolygonGeometry :local_31 . {[/color]
[color=#000000]TGeometry.Shader RenderShader :local_32;[/color]
[color=#000000]TNode.SNode SPolygonGeometry :local_33;[/color]
[color=#000000]TNode.Parent TTransform :local_XXX12; // so thre we connect the "TTransform :local" we just created.[/color]
[color=#000000]TNode.BoundingSphere Spheref( 3.086155175e-006, 7.148627788e-007, -9.999999975e-007, 1.000000027e+016 );[/color]
[color=#000000]Object.Name "tool_R9Toy148_Object03_meshShape";[/color]
[color=#000000]};For texture animation:
You need link the "TexCoordTransform" paramter to a new local, then use the parent in the new local.
Code:
ShaderTexture :local_46 . {[/color]
[color=#000000]ShaderTexture.Texture Texture2D :local_48;[/color]
[color=#000000]ShaderTexture.TexCoordTransform TTransform :local_tool_R9Toy148_Object04_TexCoord; // This is the line you need to change or create if it dont have it.[/color]
[color=#000000]Object.Name "tool_R9Toy148_Object04_textureShader";[/color]
[color=#000000]};[/color]
[color=#000000]TTransform :local_tool_R9Toy148_Object04_TexCoord TNode.SNode STransform :local_Stool_R9Toy148_Object04_TexCoord;[/color]
[color=#000000]STransform :local_Stool_R9Toy148_Object04_TexCoord Object.Name "Stool_R9Toy148_Object04_TexCoord";5. you need to create the "AnimationClip :local" (sub-animation) linked in your "AnimationScheduler :local".
This local will be linked to a "AnimationLibrary :local" and may possibly contain the "StartTime" parameter.
As I can see, this "StartTime" is simply a delay before to start the animation.
Code:
AnimationClip :local_myAnimation_Start . {[/color]
[color=#000000]AnimationClip.AnimationLibrary AnimationLibrary :local_myAnimation_End;[/color]
[color=#000000]AnimationClip.StartTime F64(0); //Start delay, not using this parameter is the same as using with a value of 0.[/color]
[color=#000000]Object.Name "myAnimation_Start";6. you need to create the "AnimationLibrary :local" linked in your "AnimationClip :local".
This local will contain a "EndTime" parameter, which is actually your animation lenght.
This local will contain a "Curve" parameter, which will contain a :local for each "ConnectionGroup.Member" (movement type) writed in your "ConnectionGroup :local".
Code:
AnimationLibrary :local_myAnimation_End . {[/color]
[color=#000000]AnimationLibrary.EndTime F64(120.105); //Time it's take to execute the movement(24.021F = 1 second).[/color]
[color=#000000]AnimationLibrary.Curve [ SplineVector3f :local_myAnimation_Curve0, SplineVector3f :local_myAnimation_Curve1, SplineVector3f :local_myAnimation_Curve2]; //make sure to write a local for each item of ".Member" from your "ConnectionGroup :local"[/color]
[color=#000000]AnimationLibrary.GroupPort Array_I32 [ 0, 1, 2]; //simply write number in ascending order to match the number of item in the Curve line(start at 0).[/color]
[color=#000000]Object.Name "myAnimation_End";[/color]
[color=#000000]};7. you need to create all the "SplineVector3f :local" linked in your "AnimationLibrary :local".
The "SplineVector3f.KeyValue Array_Vector3f" parameter control the movement value( eg. (0, 120, 0) if used with a rotation type movement normaly mean a rotation of 120 degree on the y axis.
The "SplineVector3f.KeyTangentIn/Out Array_Vector3f" seem to have some kind of "push/pull" effect.
When used for texture animation: if used with a value of 0: (0, 0, 0) , you see the image sliding to each frame (like a slide show).
If using value of 2.00000003e+030: (2.00000003e+030, 2.00000003e+030, 0), the image change with/out the sliding affect = perfect.
Any other value cause a shaking affect.
Whatever value you use, "SplineVector3f.KeyTangentIn" and "SplineVector3f.KeyTangentOut" seem to do the same thing= use the value you want on one of the two and let teh other one with a value of 0.
The "SplineBase.KeyTime Array_F32" Control the timing. (eg. a value of 372.154 mean: when the animation will reach the time of 372.154F)
Note that each line (parameter) of your "SplineVector3f :local" must contain the same number of item.
Each item go together: the first item of "SplineVector3f.KeyValue Array_Vector3f" go with the first item of "SplineBase.KeyTime Array_F32"...
From what I can see, it look that's better to start with a value of 0.
Code:
SplineVector3f :local_myAnimation_Curve0 . {[/color]
[color=#000000]SplineVector3f.KeyValue Array_Vector3f [ (0, 0, 0), (24, 26, 137), (75, 885, 74), (75, 885, 74)];[b] //movement value degree ( I just write random number for this exemple)[/b][/color]
[color=#000000]SplineVector3f.KeyTangentOut Array_Vector3f [ (0, 0, 0), (0, 0, 0), (0, 0, 0), (0, 0, 0)];[/color]
[color=#000000]SplineVector3f.KeyTangentIn Array_Vector3f [ (0, 0, 0), (0, 0, 0), (0, 0, 0), (0, 0, 0)];[/color]
[color=#000000]SplineBase.KeyTime Array_F32 [ 0, 30.027, 60.054, 90.081]; [b]//timing(eg. when timing reach item value 3, use movement degree item value at 3)[/b][/color]
[color=#000000]};[/color]
[color=#000000]SplineVector3f :local_myAnimation_Curve2 . {[/color]
[color=#000000]SplineVector3f.KeyValue Array_Vector3f [ (0, 0, 0), (180, 90, 0), (180, 115, 360), (180, 145, 180)];[/color]
[color=#000000]SplineVector3f.KeyTangentOut Array_Vector3f [ (0, 0, 0), (0, 0, 0), (0, 0, 0), (0, 0, 0)];[/color]
[color=#000000]SplineVector3f.KeyTangentIn Array_Vector3f [ (0, 0, 0), (0, 0, 0), (0, 0, 0), (0, 0, 0)];[/color]
[color=#000000]SplineBase.KeyTime Array_F32 [ 0, 30.027, 60.054, 90.081];[/color]
[color=#000000]};[/color]
[color=#000000]SplineVector3f :local_myAnimation_Curve3 . {[/color]
[color=#000000]SplineVector3f.KeyValue Array_Vector3f [ (0, 0, 0), (2.47, 345.7, 137), (112, 88.5, 774), (1155, 885, 87)];[/color]
[color=#000000]SplineVector3f.KeyTangentOut Array_Vector3f [ (0, 0, 0), (0, 0, 0), (0, 0, 0), (0, 0, 0)];[/color]
[color=#000000]SplineVector3f.KeyTangentIn Array_Vector3f [ (0, 0, 0), (0, 0, 0), (0, 0, 0), (0, 0, 0)];[/color]
[color=#000000]SplineBase.KeyTime Array_F32 [ 0, 30.027, 60.054, 90.081];[/color]
[color=#000000]};. We're done with the scene file, now it's time to move to the script Ac file.
For Room: \Scripts\Luder\RoomXXX\AcRoomXXX.bs
For Toy: \Scripts\Luder\Item\AcToolXXX.bs
You should normaly, have a ".ComponentArray [ ]" inside it you will add the script for using the animation.
First, you will write a AppCharacter, an AppAction and an AppImportSound (only if you need sound effect).
Code:
AppCharacter . {[/color]
[color=#000000].Name "myAnimation"; //write your animation name(from step 3)[/color]
[color=#000000].Pattern "myAnimation"; //write your animation name(from step 3)[/color]
[color=#000000]};[/color]
[color=#000000]AppAction . {[/color]
[color=#000000].Name "myAnimation"; //write your animation name(from step 3)[/color]
[color=#000000].Characters [ "myAnimation" ]; //write your animation name(from step 3)[/color]
[color=#000000].ActionPrefix "Tool38148:" or "Room:"; //By looking at the script at the start of the file, you should figure out what to write.[/color]
[color=#000000]};[/color]
[color=#000000]AppImportSound . {[/color]
[color=#000000].NodeName "Sound_R9Toy148_Let_It_Go";[/color]
[color=#000000].ParentPath "/Primary01/Tools/Tool38148/tool_group";[/color]
[color=#000000].SoundFile "Shared/Effect/R9Toy148_Let_It_Go"; //sound effect file path( the real path here is "/Sounds/Shared/Effect/R9Toy148_Let_It_Go")[/color]
[color=#000000].MixerFlags "SC3D"; // volume mixer "SC3D" or "SCVolume".[/color]
[color=#000000].Category "ToolFX"; //sound categeory (bar that control the different sound volume in the game setting)[/color]
[color=#000000]};9.Only one file remaining, just remember that your "Action" name in this step his the .ActionPrefix + .Name of your .AppAction
For toy:
\Scripts\Shared\Common\TcToolsR9ToyXXX.bs
You simply need to add the .InitActionArray, .ActivityActionArray ( and .ToolSoundActivity if you use sound effect)
Code:
.InitActionArray [ "Tool38148:myAnimation" ];[/color]
[color=#000000].ActivityActionArray [ "Tool38148:myAnimation" ];[/color]
[color=#000000].ToolSoundActivity "Sound_R9Toy148_Let_It_Go";For Room:
\Scripts\Luder\Common\RoomXXX.bs
The .RoomSituation parameter must contain a value higher than 0.
\Scripts\Luder\RoomXXX\AvRoomXXX.bs
You must have a Def [ AvPose . { inside your AvSituation quote.
Code:
.Def [ AvPose . {
};
];than for each animation, you simply need to add a ".Do [ AvPlay . {" inside the AvSituation quote.
Code:
.Do [ AvPlay . {
.Action "Room:myAnimation";
.SoundName "Sound_R9Toy148_Let_It_Go"; //only if you use sound fx.
};
];[To see links please log-in or register here]