Difference between revisions of "Subgraphs"

=== System Explanation ===

While working on Skyrim, BGS ended up using the ''behavior file reference'' functionality of Havok Behavior to break off logical components of the character graph into smaller, easier to understand chunks.  Animation Sub Graphs further leverage this concept by dynamically attaching a behavior file reference to an active character behavior graph thus allowing use of the same graph logic for multiple animations.  This is particularly helpful for modders since Havok does not release their toolset for modifying behavior graphs.  Now modders can utilize one of the standard Fallout 4 graphs to add new content without needing Havok Behavior.  The graph logic contains the animation file names, so they are static, but the animation paths can change.  

The data is set up in the editor using the "Subgraph Data" tab in the NPC race. '''NOTE''': When modding, you should always create a new race and make it "additive" to an existing race.  This will prevent conflicts when loading multiple mods that both add new content to the same race.

* Template allows you to use the same subgraph animation data for a new race that another race used.  This allows you to reskin a race but use the same animations.  '''Note''': Skeleton & Behavior Graph have to be set to the same as the template race as well.  This should all happen automatically if you duplicate a race and rename it.

* MT - used when you didn't have a weapon readied

* Weapon

** Should change when switching weapons and potentially changed when using [[ChangeAnimArchetype - Actor]] or [[ChangeAnimFlavor - Actor]]

* Furniture

* Pipboy (only used for 1st person pipboy animations)

* Linking Only - Only useful for Bethesda internal build process.

Useful only for the player's race, this allows you to specify 1st or 3rd person animations.  Choose 3rd for all non-playable race data.

These keywords need to exist on the actor for this sub graph data to get picked.  Some keywords can be added dynamically (Archetype, Flavor & Injuries) and some are typically added in the editor to the race or actor (AnimSynth, AnimArchetypePlayer).  'Female' is a special actor keyword automatically added based on the combination of Actor's gender & 'opposite gender anims' checkbox. ''Note'': The game will always choose the subgraph data that matches the maximum number of actor keywords.  Matching number of target keywords is the tie breaker.  If two are tied in both those categories, it is undetermined which will get chosen.

The "target" is specific to a certain role.  If the role has a target, that target must match all keywords in the "target keywords" set.  Targets broken down by role:

* Weapon: The weapon being equipped.

* Furniture: The furniture being used.

The behavior graph that is used to provide the logic for this sub graph data.  Bethesda only supports use of behavior graphs shipped as sub graphs to the particular root project on the race.  IE: For any Project in the body data tab, if there is a behavior graph you'd like to use in the Behavior Paths for that project already, you're ok to use it.  All others will not work properly.   

When loading a behavior graph for the sub graph data entry, the animation file names it uses will be searched for in the paths provided here.  The path order is important - it will check the first path before moving onto the next path and so on.

Since the same graph logic is reused, the game needs some extra data to know how to translate the speeds the game wants into what animations play.  There is also data that is need to calculate furniture entries & exits as well as weapon sight lines & fire locations.  This data is generated through a build process that is run through the Creation Kit.  To run the process, after you've added your sub graph entries and have the necessary data, run:

<code>CreationKit.exe -GenerateAnimInfo:SubgraphExample.esp . .\data</code>

=== Notes & Caveats ===

[[Category:Animation]]