Reyhard/Sandbox/WeaponAnimDocP1 – User

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[https\:\/\/community\.bistudio\.com\/wiki\/(.*) (.*)\]" to "$2")
m (plop)
Tag: Replaced
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{TOC|side}}
[[Category:Sandbox]]
=Weapon animations - Animation workspace and prefab setup=
Moved to [[Arma Reforger:Weapon Animation/Setup]]
 
==Introduction==
 
'''Previous part '''- [https://confluence.bistudio.com/display/~phammac/Weapon+animations Weapon animations - Main Page]
 
This part of the tutorial covers the basics of setting up the animation workspace. You might expect to find information on how to create an animation workspace using one of the existing workspaces as a base. This means that this tutorial will not go into depth on creating new custom graphs, creating new nodes, and so on. In any case, following these instructions, you should be able to have a fully animated weapon in the game.{{Feature|informative|If you '''don't have any experience with Workbench''' yet, it is recommended to '''go through [[Arma_Reforger:Car_Modding|modded car tutorial]]''' to familiarize with some of the concepts present in the '''Workbench''' and general car configuration.}}{{Messagebox|Sources files for this tutorial can be found on
[https://github.com/BohemiaInteractive/Arma-Reforger-Samples/tree/main/SampleMod_NewCar '''Arma Reforger Samples Github repository''']|📥|orange}}
==Animation Editor==
===Preparing animation workspace===
 
====Creating animation workspace{{Icon|checked}}{{Icon|unchecked}}{{Icon|warning}}<ref name="note_table_override">Following assets are always overridden and cannot be fully replaced</ref>====
 
Before going any further, it is recommended to make yourself familiar with [[Arma Reforger:Animation Editor|Animation Editor documentation]]
 
First step in creating animation for weapons is preparing new '''animation workspace '''for asset that is being worked on. To do so, navigate to '''File→ New Workspace '''in top bar or use '''Ctrl+N '''shortcut. Once that is pressed, '''Create New Workspace '''window where it is necessary to fill location where new workspace will be created.
 
In Reforger, workspaces files for multiple similar assets are placed in asset folder one level higher than the asset is located in - f.e. '''Assets/Weapons/Rifles/Workspaces. '''In this tutorial, '''sampleweapon_01.aw '''workspace was created in '''Assets/Weapons/Rifles/Workspaces '''inside '''SampleMod_NewWeapon''' addon.
 
Vanilla Reforger assets are using '''name of the weapon '''as '''name of various animation files'''. For instance:
 
* [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74.aw ak74.aw] - Animation Workspace for AK74
 
*[https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74.ast ak74.ast] - Animation Template for AK74
*[https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74.agr ak74.agr] - Animation Graph File
*[https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74.agf ak74.agf] - Animation Graph
*[https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74_weapon.asi ak74_weapon.asi] - Animation Instance - Weapon part
*[https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74_player.asi ak74_player.asi] - Animation Instance - Character part
 
Once location & name of the file are confirmed, an empty '''sampleweapon_01.aw&nbsp; '''workspace should be automatically opened in '''Animation Editor'''.
 
==== Creating animation instance template (or reusing existing)====
 
'''Recommended read''': [[Arma Reforger:Animation Editor: Templates and Instances Tutorial|Animation Editor: Templates and Instances Tutorial]]
 
Next thing on the list will be configuration of '''Animation Template.''' That file contains [[Arma Reforger:Animation Editor#Anim Set|template animation set]] - '''animation groups, columns and rows '''which are then used by all '''Animation Instances '''in current '''Animation Workspace. '''
 
Now, there are few possibilities when it comes configuring '''Animation Template - '''it is possible to '''use existing template''', create '''duplicate of it '''or '''create new template from scratch'''. Both have its pros and cons and it all depends on various factors. If for instance new weapon is yet another variant of AK74, it might be possible to reuse existing animation template without any problems.
 
=====Creating new template=====
 
*{{Icon|unchecked}} All entries in animation template has to be set from scratch
*{{Icon|checked}} New animation groups & rows can be added or deleted
*{{Icon|warning}} Need to be manually updated in case there is some change in vanilla date
 
 
 
[[Image:image-2022-12-6_14-19-12.png?version=1&modificationDate=1673341140000&api=v2&effects=border-simple,blur-borderImage9.png|top|link=Special:FilePath/image-2022-12-6_14-19-12.png%3Fversion=1&modificationDate=1673341140000&api=v2&effects=border-simple,blur-borderImage9.png]]
 
To create new template, click with '''Right Mouse Button '''on '''Animation Template '''line in '''Workspace '''window and then select '''New Template... '''option from the menu. After that, you will be asked where new file should be created.
 
=====Using existing template=====
 
*{{Icon|checked}} Minimal amount of work required to get it working
*{{Icon|unchecked}} Cannot be modified - it is not possible to add new groups or rows. Might be problematic if weapon is quite non standard
*{{Icon|warning}} Creates dependency on vanilla content - if it gets updated it can break your animation workspace but sometimes it might help you updating your content to latest standards
 
 
 
[[Image:image-2022-12-6_14-18-9.png?version=1&modificationDate=1673341140000&api=v2&effects=border-simple,blur-borderImage13.png|top|link=Special:FilePath/image-2022-12-6_14-18-9.png%3Fversion=1&modificationDate=1673341140000&api=v2&effects=border-simple,blur-borderImage13.png]]
 
To use existing Animation Template, click with Right Mouse Button on Animation Template line in Workspace window and then pick '''Assign Existing Template... '''option from the context menu. After picking this option, you will be asked to locate '''Animation Template '''file (''files using .ast extension'')
 
=====Using duplicated template=====
 
*{{Icon|checked}} Relatively easy to set up but requires few more steps compared to using existing Animation Template
*{{Icon|checked}} New animation groups & rows can be added or deleted
*{{Icon|warning}} Need to be manually updated in case there is some change in vanilla date
 
In this tutorial, a '''duplicated animation template is used''', since '''Sample New Weapon '''is going to use logic similar to already existing in-game weapon - AK74. To do so, follow below steps:# Navigate to '''Animation Template '''that you want to duplicated. '''Animation Templates '''are using .ast extension. In this case [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74.ast ak74.ast] was used
#Use [[Arma Reforger:Data Modding Basics#Using .22Override in....22 function|Override in addon]] functionality on that file
#Click on overridden file ([enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74.ast ak74.ast]) located in target addon (''SampleMod_NewWeapon'') and selected '''Show In Explorer '''option
#Remove .meta file located next to overridden file. In this case ''ak74.ast.meta ''file was removed
#Rename overridden file. In this case ''ak74.ast ''was renamed to ''sampleweapon_01.ast''
# Go back to '''Workbench''', find ''sampleweapon_01.ast ''in '''Resource Browser '''and click on it with '''Right Mouse Button'''
#Select '''Register '''option from the context menu
 
 
 
 
 
This flow should be improved in future versions of the Workbench and regular [[Arma_Reforger:Data_Modding_Basics#Using_.22Duplicate_to....22_function Duplicate to addon]] functionality should be available. '''Below is video showing improved flow '''{{Icon|warning}}
 
 
 
 
After those steps are completed, it is possible to use this template in '''sampleweapon_01.aw '''workspace. To do so, follow the instructions mentioned in '''using existing template paragraph '''and select '''sampleweapon_01.ast '''when asked for existing template.
 
 
 
 
====Creating animation instance for player & weapon====
 
Once animation template is configured, it is right time to move to preparing '''Animation Instances'''. As mentioned in [[Arma_Reforger:Animation_Editor#Workspace Animation Editor]] documentation, '''Animation Instances&nbsp; '''areunique sets of animations which share same logic.&nbsp;
 
 
Weapons are using two animation instances - one for '''player '''and one for '''weapon.''' '''Player animation instance '''is applied to character which is holding the weapon and&nbsp;'''weapon animation instance&nbsp;'''is applied to the weapon itself. When character is holding a weapon, both of those sets are played simultaneously, therefore it is quite important to keep both animations with same length so they stay synchronized. Some more info about power instances can be found on [[Arma_Reforger:Animation_Editor:_Templates_and_Instances_Tutorial|Animation Editor: Templates and Instances Tutorial]] page (it is a recommended read nevertheless!)
 
Please note that not all animations have to be synchronized between instances but those are '''exceptions'''!
 
 
Creating new animation instances is fairly straightforward and involves the following actions:
 
 
*Click with '''Right Mouse Button '''on '''Animation Instances&nbsp;'''field in&nbsp;'''Workspaces&nbsp;'''window
*Select '''New Animation Instance... '''option from the context menu
*Select new animation instance '''name & location '''and then confirm with '''Ok '''button
**It is recommended to use _''player & _weapon ''suffixes for animation instances to keep data readable (it is not mandatory though)<br />
As it was mentioned before, weapon requires two animation sets and in case of sample weapon, following animation instances were created:* '''sampleweapon_01_player.asi '''- animation instance containing character related animations
*'''sampleweapon_01_weapon.asi '''- animation instance containing weapon related animations
 
 
 
Both sets of animations are empty at this stage, and we will come back to fill them in as soon as we have some animations ready to use.
 
 
 
 
====Setting animation graph====
 
Animation Graph consist of '''Graph (.agr) '''and '''Graph File (.agf)'''. '''Graph '''itself contains all '''Variables''', '''Commands '''and '''IK Chains''' that would be available to all animations graph plus link to '''Graph File(s)'''.
 
'''Graph File '''contain '''Sheets '''and those sheets contain actual '''animation graph '''with [[Arma_Reforger:Animation_Editor:_Nodes|Animation Nodes]].
 
Similar as with animation template, there are few possibilities when it comes to graph creation and again, same as with '''Animation Template, '''there are some pros and cons of such solution. If you intend to create a weapon that is similar to one of the existing weapons, then duplicating the animation graph is the suggested approach - unless the weapon you are preparing doesn't require any tweaks in the graph compared to the vanilla data.
 
Of course, if weapon is sort of '''unique '''(let's say bolt action rifle or some clip loaded rifles) then '''new graph might be necessary '''- in such scenario though it would be still wise to use existing weapon graph as reference.
 
 
=====Creating new graph =====
 
[[Image:image-2023-1-6_12-44-58.png?version=1&modificationDate=1673341140000&api=v2&effects=drop-shadowImage22.png|top|link=Special:FilePath/image-2023-1-6_12-44-58.png%3Fversion=1&modificationDate=1673341140000&api=v2&effects=drop-shadowImage22.png]]
 
To create new graph, click with '''Right Mouse Button '''on '''Graph '''line in '''Workspace '''window and then select '''New Graph... '''option from the menu. After that, you will be asked where new file should be created.
 
 
 
 
=====Using existing graph=====
 
[[Image:image-2023-1-6_13-15-42.png?version=1&modificationDate=1673341140000&api=v2&effects=drop-shadowImage23.png|top|link=Special:FilePath/image-2023-1-6_13-15-42.png%3Fversion=1&modificationDate=1673341140000&api=v2&effects=drop-shadowImage23.png]]
 
To create new graph, click with '''Right Mouse Button '''on '''Graph '''line in '''Workspace '''window and then select '''Assign Existing Graph... '''option from the menu. After picking this option, you will be asked to locate '''Graph '''file (''files using .agr extension'')
 
 
===== Duplicating existing graph =====
Process of duplicating '''Graph '''is exactly same as with '''Animation Template '''described before. Similar as with animation template, '''duplication of existing graph was chosen - '''mainly to save time required to define '''variables '''and mandatory '''commands'''. Even if you are doing some custom weapon In this case, [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74.agr ak74.agr] was picked to be duplicated into '''sampleweapon_01.agr'''.
 
 
Once duplication is completed and new graph is assigned to '''Graph '''property, it will be necessary to remove reference to old '''Graph File''' and this can be done by clicking with '''Right Mouse Button '''on '''Files '''entry ([https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Assets/Weapons/Rifles/workspaces/ak74.agf ak74.agf] in this case'') in '''Graph '''section of the Workspace and then selecting '''Remove '''option from the context menu.''
 
 
 
 
 
 
====Creating Graph File====
 
[[Image:image-2023-1-6_15-0-41.png?version=1&modificationDate=1673341140000&api=v2&effects=drop-shadowImage25.png|top|link=Special:FilePath/image-2023-1-6_15-0-41.png%3Fversion=1&modificationDate=1673341140000&api=v2&effects=drop-shadowImage25.png]]
 
Process of creating '''Graph File '''is almost exactly the same as with graph or template. Creating new '''Graph File '''is done through context menu which is available after clicking with '''Right Mouse Button '''on '''Files '''property in '''Graph '''section. Over there, you can either select''' Create Graph File...''' or '''Add Existing Graph File... '''options
 
 
 
 
 
 
[[Image:image-2023-1-6_15-54-40.png?version=1&modificationDate=1673341139000&api=v2&effects=border-simple,blur-borderImage26.png|top|link=Special:FilePath/image-2023-1-6_15-54-40.png%3Fversion=1&modificationDate=1673341139000&api=v2&effects=border-simple,blur-borderImage26.png]]
 
In case of creating new '''Graph File''', it is necessary to '''create new sheet - '''this can be done by clicking on '''Graph File '''with Right Mouse Button and then selecting&nbsp;'''New Sheet... '''option from the context menu. After that, a new pop will appear asking for sheet name. In this case, it is recommend to use "Master" for main sheet
 
 
=====Setting graph file =====
 
'''Duplication '''approach can be also used to create a '''Graph File '''and since it is in many cases the '''easiest and fastest way''', this solution was used to configure '''Sample Weapon '''animation workspace.
 
Perhaps it is worth mentioning here, that it is also possible to copy and paste animation nodes between Animation Graphs. To do so, open second instance of '''Animation Editor '''and then open '''Animation Workspace '''of your choice. Once it is loaded, select all nodes in '''Animation Graph '''window with mouse by holding&nbsp;'''Left Mouse Button&nbsp;''' which you want to copy paste, press '''Ctrl+C '''to copy those nodes''', '''select again '''Animation Editor '''containing your weapon, click once with '''Left Mouse Button''' in '''Animation Graph '''inside of&nbsp;that '''Animation Editor '''and finally, press '''Ctrl+V '''to paste all those nodes.
 
 
====Setting up preview models====
 
It might be also quite handy to set '''Preview Models '''in current animation workspace - this will allow to quickly verify if animations are playing correctly and see if interpolations between nodes are working as intended in graph debug mode. Only '''one preview model '''can be active in''' Anim Editor Preview '''window''', '''so it will be necessary to set two sets of preview models - one for debugging of '''weapon animation instance '''and second for debug of '''player animation instance.'''
 
=====Weapon preview models=====
 
Beginning with setting preview model for weapon, following steps has to be performed to add:* Click with '''Right Mouse Button on Preview Models '''line in '''Workspace '''window and then select '''Add Preview Model... '''option.&nbsp; After that a proper model (.xob) has to be selected. In this case [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Rifles/SampleWeapon_01/SampleWeapon_01.xob SampleWeapon_01.xob] was selected.
 
 
 
[[Image:image-2023-1-6_16-14-21.png?version=1&modificationDate=1673341139000&api=v2&effects=drop-shadowImage28.png|top|link=Special:FilePath/image-2023-1-6_16-14-21.png%3Fversion=1&modificationDate=1673341139000&api=v2&effects=drop-shadowImage28.png]]
 
'''Tip''': It is possible to disable background ground model in '''Anim Editor Preview '''window by clicking on '''Options '''in top right corner of the view port and then unchecking '''Ground property '''in '''Scene settings '''tab.
 
Next, it might be nice to have (but not essential) to add magazine to the weapon by adding child model, to do so, click with '''Right Mouse Button''' on '''entry '''in '''Preview Models '''list (''f.e. [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Rifles/SampleWeapon_01/SampleWeapon_01.xob SampleWeapon_01.xob]), ''then select from context menu option '''Add Child Model...&nbsp; '''and finally, pick model of the magazine ([https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Magazines/SampleWeapon_01/Magazine_65x39c_SampleWeapon_01_30rnd.xob Magazine_65x39c_SampleWeapon_01_30rnd.xob]) from the list.
 
 
By default, child model will be created at 0,0,0 and most likely such state in desired. It is possible to attach such child model to some bone in parent bone by changing '''Bone '''parameter in '''Properties '''window. In case of the magazine, it is possible to snap it to '''slot_magazine '''bone, which should result in model nicely sitting in magazine well.
 
 
'''Tip''': Magazine model visibility can be toggled clicking on '''Enabled '''property in '''Properties '''window when magazine in '''Preview Models '''list is selected or by clicking on little '''eye icon '''which is visible when mouse is hovering above '''child preview model'''.
 
 
=====Character preview model =====
 
Adding of character preview is using basically same principle as weapon but this time there will be two child models attached to it. Starting with character model itself, click with '''Right Mouse Button''' on '''Preview Models''' field and then select '''Add Preview Model... '''option. After that, you can pick one of the characters models in xob model. Vanilla data contains two models with some equipment merged in:* [enfusion://ResourceManager/~ArmaReforger:Assets/Characters/Animation/AnimTestChar_USSR_01.xob AnimTestChar_USSR_01.xob ] - character with USSR uniform
*[enfusion://ResourceManager/~ArmaReforger:Assets/Characters/Animation/AnimTestChar_US_01.xob AnimTestChar_US_01.xob] -&nbsp; character with US Army uniform
 
 
 
Once character model is present in Preview Models list, it is possible to add two child models:* Weapon ([https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Rifles/SampleWeapon_01/SampleWeapon_01.xob SampleWeapon_01.xob]) attached to '''Right Hand Prop'''
*Magazine ([https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Magazines/SampleWeapon_01/Magazine_65x39c_SampleWeapon_01_30rnd.xob Magazine_65x39c_SampleWeapon_01_30rnd.xob]) attached to '''Left Hand Prop - '''this should allow for previewing reload magazine animations.
 
 
 
Currently active preview models can be either switched in two ways:* Through context menu which appears after clicking on it with '''Right Mouse Button''' entry in&nbsp;'''Preview Models&nbsp;'''list and then selecting&nbsp;'''Set as current''' option
*By double clicking on it
 
Active preview model is marked with '''bolded text.'''
 
 
Above set of preview models should be enough to preview all necessary weapon animations (both character and weapon itself) once '''Animation Workspace '''is filled with actual animations.
 
===Assigning animation workspace to prefab===
 
If everything went fine, the new weapon animation workspace should be ready to be plugged into the weapon.
 
[[Image:image-2023-1-9_11-37-12.png?version=1&modificationDate=1673341139000&api=v2&effects=drop-shadowImage32.png|top|link=Special:FilePath/image-2023-1-9_11-37-12.png%3Fversion=1&modificationDate=1673341139000&api=v2&effects=drop-shadowImage32.png]]Most of the weapon animation configuration is located in '''WeaponAnimationComponent. '''Unless weapon prefab is duplicate of some existing weapon, such component might not exist in a prefab which just inherits from [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~ArmaReforger:Prefabs/Weapons/Core/Rifle_Base.et Rifle_Base.et] prefab. In this case, it will be necessary to add such component to the prefab first. This can be done in few steps:* Load weapon prefab ([https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Prefabs/Weapons/Rifles/SampleWeapon_01_base.et SampleWeapon_01_base.et]) in World Editor - either by using '''Edit Prefab '''button in '''Resource Manager '''or by drag and dropping weapon prefab into World Editor view port
*Locate '''WeaponComponent '''in '''Object Properties '''window of the weapon
*Click on '''WeaponComponent '''with '''Right Mouse Button '''and select '''Add child component '''option from the context menu
*Select '''WeaponAnimationComponent '''from the list of components<br />
After that, '''WeaponAnimationComponent '''should be ready for further configuration. If component
 
====Setting weapon animation instance====
 
First, let's begin with general weapon animations and weapon graph & animation instance. Those two things are controlled by following parameters which can be found in '''WeaponAnimationComponentn'''* '''Anim Graph '''→&nbsp; This parameter expects '''animation graph '''used in animation workspace. In this case [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Rifles/Workspaces/sampleweapon_01.agr sampleweapon_01.agr] was used
*'''Anim Instance '''→ This parameter expects '''animation instance '''of the '''weapon'''. Over here [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Rifles/Workspaces/sampleweapon_01_weapon.asi sampleweapon_01_weapon.asi] should be assigned
 
It is also necessary to switch those two parameters to on, to ensure proper working of the component* '''Always Active '''
*'''Bind With Injection'''
 
====Setting player animation instance====
 
Next, we can move to character animations configuration and to do so, click on '''set class '''button next to '''Anim Injection '''property. This will add new class to the component where you can configure following options:* '''Anim Graph '''→&nbsp; Same as before, this parameter expects '''animation graph '''used in animation workspace. In this case [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Rifles/Workspaces/sampleweapon_01.agr sampleweapon_01.agr] was used again
*'''Animation Instance '''→This parameter expects '''animation instance '''of the '''character. '''Over here [https://enfusionengine.com/api/redirect?to=enfusion://ResourceManager/~SampleMod_NewWeapon:Assets/Weapons/Rifles/Workspaces/sampleweapon_01_player.asi sampleweapon_01_player.asi] should be assigned
*'''Binding Name '''→ Binding name in root graph. Type here '''Weapon'''
 
That's it for now! Now we are going to leave the '''Animation Editor '''for a while and move on to the '''creation of the actual animations'''.
==Continuation==
 
'''Next part '''- &nbsp;[https://confluence.bistudio.com/display/~phammac/Weapon+animations+-+Basic+animation+creation Weapon animations - Basic animation creation]

Latest revision as of 11:22, 20 October 2023

Moved to Arma Reforger:Weapon Animation/Setup

Retrieved from "https://community.bistudio.com/wiki?title=User:Reyhard/Sandbox/WeaponAnimDocP1&oldid=347730"