Divinity Engine Wiki - User contributions [en]

File:Weapons REF A.zip

2018-02-22T13:33:22Z

JoykaDeReyst: JoykaDeReyst uploaded a new version of File:Weapons REF A.zip

File:Weapons REF A.zip

2018-02-19T14:39:33Z

JoykaDeReyst: JoykaDeReyst uploaded a new version of File:Weapons REF A.zip

File:Weapons REF A.zip

2018-02-16T15:17:03Z

JoykaDeReyst: JoykaDeReyst uploaded a new version of File:Weapons REF A.zip

Modding: Maya Exporter

2018-02-08T13:11:50Z

JoykaDeReyst: /* Setting up Physics in Maya for the MLE */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 
This is also overriden by the Export Variable Setup Make vertex Coloured 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

==== Animation Quality ====
This dropdown list lets you define different compression setting for animation export. 
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and the variable this button adds to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Vertex Coloured is specifically for meshes that have vertex colours, but won't be cloth simmed. 
Only used by MLE to determine inclusion of vertex colours during export. 
Works on current selection. 

Make Proxy Mesh is specifically for meshes that are going to be used as emitter proxies in effect. The MLE automatically changes the export settings for these objects if this setting is found. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene. 

 

===Setting up Physics in Maya for the MLE===

To set up physics we use the bullet.mll plugin. This plugin should come shipped with every install of maya. 
If the plugin is active you should have a bullet shelf tab. If it isn't active go to Top Menu -> Window -> Settings/Preferences -> Plug-in Manager 
Look for bullet.mll in the list and set it to loaded and auto load.

[[File:bulletActive.png|none]]
 
[[File:bulletShelf.png|none]]

The bullet shelf works on the current selection. To turn a mesh in a physics mesh click the third button in the shelf '''Create a passive Rigid Body Object. 
This will attach a BulletRigidBodyShape to your object. This is what we will edit via the attribute editor. 

The important settings are ''Body type'' and ''Collider Shape Type.''

[[File:staticphysics.png|none]]

For a physics object that can not move the Body type should be set to Static body

[[File:kinematicphysics.png|none]]

For a physics object that can move the Body type should be set to Kinematic RigidBody

'''!!!Important: Don't ever use Dynamic Rigid Body as a body type. This is reserved for ragdolls only!!!'''

Currently supported shape types are:
*Box/Box2D (Plane)
*Sphere
*Capsule
*Convex Hull
*Mesh (Static Only)
*Cylinder

The best supported shape type is hull, but feel free to experiment with the other shape types to see how they work. 
 
To visualize the rigid body shapes look for the bullet solver shape in the outline and check it's ''Solver Display -> Collision Shape'' 
this will draw a wireframe representation of what the bullet plugin thinks your physics mesh looks like. 

[[File:BulletSolverVisualize.png|none]]

'''Note:''' Physics are an approximation of reality you can't have the worlds most complex shapes and expect calculations to go well. Keep it simple first and foremost.

Modding: Maya Exporter

2018-02-08T13:11:22Z

JoykaDeReyst: /* Setting up Physics in Maya for the MLE */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 
This is also overriden by the Export Variable Setup Make vertex Coloured 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

==== Animation Quality ====
This dropdown list lets you define different compression setting for animation export. 
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and the variable this button adds to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Vertex Coloured is specifically for meshes that have vertex colours, but won't be cloth simmed. 
Only used by MLE to determine inclusion of vertex colours during export. 
Works on current selection. 

Make Proxy Mesh is specifically for meshes that are going to be used as emitter proxies in effect. The MLE automatically changes the export settings for these objects if this setting is found. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene. 

 

===Setting up Physics in Maya for the MLE===

To set up physics we use the bullet.mll plugin. This plugin should come shipped with every install of maya. 
If the plugin is active you should have a bullet shelf tab. If it isn't active go to Top Menu -> Window -> Settings/Preferences -> Plug-in Manager 
Look for bullet.mll in the list and set it to loaded and auto load.

[[File:bulletActive.png|none]]
 
[[File:bulletShelf.png|none]]

The bullet shelf works on the current selection. To turn a mesh in a physics mesh click the third button in the shelf '''Create a passive Rigid Body Object. 
This will attach a BulletRigidBodyShape to your object. This is what we will edit via the attribute editor. 

The important settings are ''Body type'' and ''Collider Shape Type.''

[[File:staticphysics.png|none]]

For a physics object that can not move the Body type should be set to Static body

[[File:kinematicphysics.png|none]]

For a physics object that can move the Body type should be set to Kinematic RigidBody

'''!!!Important: Don't ever use Dynamic Rigid Body as a body type. This is reserved for ragdolls only!!!'''

Currently supported shape types are:
*Box/Box2D (Plane)
*Sphere
*Capsule
*Convex Hull
*Mesh (Static Only)
*Cylinder

The best supported shape type is hull, but feel free to experiment with the other shape types to see how they work. 
To visualize the rigid body shapes look for the bullet solver shape in the outline and check it's ''Solver Display -> Collision Shape'' 
this will draw a wireframe representation of what the bullet plugin thinks your physics mesh looks like. 

[[File:BulletSolverVisualize.png|none]]

'''Note:''' Physics are an approximation of reality you can't have the worlds most complex shapes and expect calculations to go well. Keep it simple first and foremost.

Modding: Maya Exporter

2018-02-08T13:11:04Z

JoykaDeReyst: /* Setting up Physics in Maya for the MLE */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 
This is also overriden by the Export Variable Setup Make vertex Coloured 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

==== Animation Quality ====
This dropdown list lets you define different compression setting for animation export. 
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and the variable this button adds to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Vertex Coloured is specifically for meshes that have vertex colours, but won't be cloth simmed. 
Only used by MLE to determine inclusion of vertex colours during export. 
Works on current selection. 

Make Proxy Mesh is specifically for meshes that are going to be used as emitter proxies in effect. The MLE automatically changes the export settings for these objects if this setting is found. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene. 

 

===Setting up Physics in Maya for the MLE===

To set up physics we use the bullet.mll plugin. This plugin should come shipped with every install of maya. 
If the plugin is active you should have a bullet shelf tab. If it isn't active go to Top Menu -> Window -> Settings/Preferences -> Plug-in Manager 
Look for bullet.mll in the list and set it to loaded and auto load.

[[File:bulletActive.png|none]]
 
[[File:bulletShelf.png|none]]

The bullet shelf works on the current selection. To turn a mesh in a physics mesh click the third button in the shelf '''Create a passive Rigid Body Object. 
This will attach a BulletRigidBodyShape to your object. This is what we will edit via the attribute editor. 

The important settings are ''Body type'' and ''Collider Shape Type.''

[[File:staticphysics.png|none]]

For a physics object that can not move the Body type should be set to Static body

[[File:kinematicphysics.png|none]]

For a physics object that can move the Body type should be set to Kinematic RigidBody

'''!!!Important: Don't ever use Dynamic Rigid Body as a body type. This is reserved for rigid bodies only!!!'''

Currently supported shape types are:
*Box/Box2D (Plane)
*Sphere
*Capsule
*Convex Hull
*Mesh (Static Only)
*Cylinder

The best supported shape type is hull, but feel free to experiment with the other shape types to see how they work. 
To visualize the rigid body shapes look for the bullet solver shape in the outline and check it's ''Solver Display -> Collision Shape'' 
this will draw a wireframe representation of what the bullet plugin thinks your physics mesh looks like. 

[[File:BulletSolverVisualize.png|none]]

'''Note:''' Physics are an approximation of reality you can't have the worlds most complex shapes and expect calculations to go well. Keep it simple first and foremost.

Modding: Maya Exporter

2018-02-08T13:10:36Z

JoykaDeReyst: /* Setting up Physics in Maya for the MLE */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 
This is also overriden by the Export Variable Setup Make vertex Coloured 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

==== Animation Quality ====
This dropdown list lets you define different compression setting for animation export. 
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and the variable this button adds to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Vertex Coloured is specifically for meshes that have vertex colours, but won't be cloth simmed. 
Only used by MLE to determine inclusion of vertex colours during export. 
Works on current selection. 

Make Proxy Mesh is specifically for meshes that are going to be used as emitter proxies in effect. The MLE automatically changes the export settings for these objects if this setting is found. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene. 

 

===Setting up Physics in Maya for the MLE===

To set up physics we use the bullet.mll plugin. This plugin should come shipped with every install of maya. 
If the plugin is active you should have a bullet shelf tab. If it isn't active go to Top Menu -> Window -> Settings/Preferences -> Plug-in Manager 
Look for bullet.mll in the list and set it to loaded and auto load.

[[File:bulletActive.png|none]]
 
[[File:bulletShelf.png|none]]

The bullet shelf works on the current selection. To turn a mesh in a physics mesh click the third button in the shelf '''Create a passive Rigid Body Object. 
This will attach a BulletRigidBodyShape to your object. This is what we will edit via the attribute editor. 

The important settings are ''Body type'' and ''Collider Shape Type.''

[[File:staticphysics.png|none]]

For a physics object that can not move the Body type should be set to Static body

[[File:kinematicphysics.png|none]]

For a physics object that can move the Body type should be set to Kinematic RigidBody

'''!!!Important: Don't ever use Dynamic Rigid Body as a body type. This is reserved for rigid bodies only!!!'''

Currently supported shape types are:
*Box/Box2D (Plane)
*Sphere
*Capsule
*Convex Hull
*Mesh (Static Only)
*Cylinder

The best supported shape type is hull, but feel free to experiment with the other shape types to see how they work. 
To visualize the rigid body shapes look for the bullet solver shape in the outline and check it's ''Solver Display -> Collision Shape'' 
this will draw a wireframe representation of what the bullet plugin thinks your physics mesh looks like. 

[[File:BulletSolverVisualize.png|none]]

'''Note:''' Physics are an approximation of reality you can't have the worlds most comples shape and expect calculations to go well. Keep it simple first and foremost.

File:BulletSolverVisualize.png

2018-02-08T13:08:29Z

JoykaDeReyst:

File:Kinematicphysics.png

2018-02-08T13:07:54Z

JoykaDeReyst:

File:Staticphysics.png

2018-02-08T13:07:42Z

JoykaDeReyst:

File:BulletShelf.png

2018-02-08T13:07:26Z

JoykaDeReyst:

File:BulletActive.png

2018-02-08T13:07:14Z

JoykaDeReyst:

Modding: Maya Exporter

2018-02-08T12:54:10Z

JoykaDeReyst: /* Components */

Modding: Maya Exporter

2018-02-08T12:53:53Z

JoykaDeReyst: /* Components */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 
This is also overriden by the Export Variable Setup Make vertex Coloured 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

==== Animation Quality ===
This dropdown list lets you define different compression setting for animation export. 
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and the variable this button adds to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Vertex Coloured is specifically for meshes that have vertex colours, but won't be cloth simmed. 
Only used by MLE to determine inclusion of vertex colours during export. 
Works on current selection. 

Make Proxy Mesh is specifically for meshes that are going to be used as emitter proxies in effect. The MLE automatically changes the export settings for these objects if this setting is found. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene. 

 

===Setting up Physics in Maya for the MLE===

Modding: Maya Exporter

2018-02-08T12:53:13Z

JoykaDeReyst: /* Export Variables Setup */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup
# Export Physics Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 
This is also overriden by the Export Variable Setup Make vertex Coloured 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

==== Animation Quality ===
This dropdown list lets you define different compression setting for animation export. 
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and the variable this button adds to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Vertex Coloured is specifically for meshes that have vertex colours, but won't be cloth simmed. 
Only used by MLE to determine inclusion of vertex colours during export. 
Works on current selection. 

Make Proxy Mesh is specifically for meshes that are going to be used as emitter proxies in effect. The MLE automatically changes the export settings for these objects if this setting is found. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene. 

 

=== Export Physics Setup ===
[[File:MayaExporter_Physics.png | none]]
 Physics variable setup window 

 
The bullet plugin in maya has a few known issues with exporting. 
Rather than allowing artists to set up their own bullet variables two export variables have been made to replace them. 
With these Variables the MLE will set up the bullet variables so scaling issues can be avoided during physics exports. 
Both buttons work on current selection. 

Kinematic Physics Mesh is for objects that can be moved during gameplay like barrels or characters. 
Static Physics Mesh is for everything else that cannot be moved and serves as such scenery.

Modding: Maya Exporter

2018-02-08T12:52:59Z

JoykaDeReyst: /* Export Variables Setup */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup
# Export Physics Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 
This is also overriden by the Export Variable Setup Make vertex Coloured 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

==== Animation Quality ===
This dropdown list lets you define different compression setting for animation export. 
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and the variable this button adds to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Vertex Coloured is specifically for meshes that have vertex colours, but won't be cloth simmed. 
Only used by MLE to determine inclusion of vertex colours during export. 
Works on current selection.

Make Proxy Mesh is specifically for meshes that are going to be used as emitter proxies in effect. The MLE automatically changes the export settings for these objects if this setting is found. 
Works on current selection.

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene.

 

=== Export Physics Setup ===
[[File:MayaExporter_Physics.png | none]]
 Physics variable setup window 

 
The bullet plugin in maya has a few known issues with exporting. 
Rather than allowing artists to set up their own bullet variables two export variables have been made to replace them. 
With these Variables the MLE will set up the bullet variables so scaling issues can be avoided during physics exports. 
Both buttons work on current selection. 

Kinematic Physics Mesh is for objects that can be moved during gameplay like barrels or characters. 
Static Physics Mesh is for everything else that cannot be moved and serves as such scenery.

File:MayaExporter Variables.png

2018-02-08T12:49:06Z

JoykaDeReyst: JoykaDeReyst uploaded a new version of File:MayaExporter Variables.png

Modding: Maya Exporter

2018-02-08T12:48:31Z

JoykaDeReyst: /* Advanced Export Settings */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup
# Export Physics Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 
This is also overriden by the Export Variable Setup Make vertex Coloured 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is off by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

==== Animation Quality ===
This dropdown list lets you define different compression setting for animation export. 
The following settings are available:
*'''Default Quality:''' The default setting used for most animation exports.
*'''Medium Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down, but increases export time allot.
*'''High Quality:''' Increases how often the animation is analysed before creating final export data. Should bring general jitter down to a minimum, but increases export time allot.
*'''Low Rotation Tolerance:''' A setting that reduces the amount of rotation jitter. Good for Character Creation poses that are looked at in greater detail.
*'''Snappy Tolerance:''' A setting that allows an animator export an animation with pose to pose jumps with no limb jitter. Applies to for example the blitz attack.

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and a variable to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene.

 
=== Export Physics Setup ===
[[File:MayaExporter_Physics.png | none]]
 Physics variable setup window 

 
The bullet plugin in maya has a few known issues with exporting. 
Rather than allowing artists to set up their own bullet variables two export variables have been made to replace them. 
With these Variables the MLE will set up the bullet variables so scaling issues can be avoided during physics exports. 
Both buttons work on current selection. 

Kinematic Physics Mesh is for objects that can be moved during gameplay like barrels or characters. 
Static Physics Mesh is for everything else that cannot be moved and serves as such scenery.

File:MayaExporter Advanced.png

2018-02-08T12:40:59Z

JoykaDeReyst: JoykaDeReyst uploaded a new version of File:MayaExporter Advanced.png

Modding: Maya Exporter

2018-02-08T12:40:00Z

JoykaDeReyst: /* Animation Manager */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup
# Export Physics Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses. 
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is on by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and a variable to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene.

 
=== Export Physics Setup ===
[[File:MayaExporter_Physics.png | none]]
 Physics variable setup window 

 
The bullet plugin in maya has a few known issues with exporting. 
Rather than allowing artists to set up their own bullet variables two export variables have been made to replace them. 
With these Variables the MLE will set up the bullet variables so scaling issues can be avoided during physics exports. 
Both buttons work on current selection. 

Kinematic Physics Mesh is for objects that can be moved during gameplay like barrels or characters. 
Static Physics Mesh is for everything else that cannot be moved and serves as such scenery.

Modding: Maya Exporter

2018-02-08T12:39:48Z

JoykaDeReyst: /* Components */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup
# Export Physics Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses.< br\>
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is on by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and a variable to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene.

 
=== Export Physics Setup ===
[[File:MayaExporter_Physics.png | none]]
 Physics variable setup window 

 
The bullet plugin in maya has a few known issues with exporting. 
Rather than allowing artists to set up their own bullet variables two export variables have been made to replace them. 
With these Variables the MLE will set up the bullet variables so scaling issues can be avoided during physics exports. 
Both buttons work on current selection. 

Kinematic Physics Mesh is for objects that can be moved during gameplay like barrels or characters. 
Static Physics Mesh is for everything else that cannot be moved and serves as such scenery.

Modding: Maya Exporter

2018-02-08T12:39:26Z

JoykaDeReyst: /* Animation Manager */

[[File:MayaExporter_StepByStep.png|center]]
 The exporter tool window in Maya 2015

 
== Description ==

The Maya exporter tool lets you export visuals, physics and animations from Maya to the editor (in the required file format).
It is a set of scripts to add an extra tab to your Maya window.
{| class="wikitable"
|-
|For more information on how to install the exporter tool, look here: [[Setup:_Maya_Exporter | Maya Setup Guide]]
|-
|}
{| class="wikitable"
|-
|[[File:Warningred.png|32px]] These tools are designed for Maya 2015 on Windows.
|-
|}

 
== Components ==
This article references the image at the top of the page

The Maya exporter tool consists of the following components:
# Animation Manager
# Multi Layer Exporter
# Modify Path
# Export Variables Setup
# Export Physics Setup

 
=== Animation Manager ===
[[File:MayaExporter_Animation.png | none]]
 The animation manager 

 
This script works together with the export tool Multi Layer Exporter to help organize and name your animations for export. 
By default the exporter will export the frame range an animation file is saved with and name it the same as the source file, 
but with the Animation manager script it’s possible to add data to your file for the Multi Layer Exporter to read.
 

This is particularly useful for animations that need to be played out in a start, loop, stop sequence such as Knockdown Status or Various skill activation animations. 
The animation Manager expects a rig with Dummy_Root as the first bone in the hierarchy. There is support for Root bones named Dummy_*LayerName*
 

Already present entries are found when selecting the root dummy with the data present. 
New entries can be made with the new button on the bottom.
 

Obsolete entries can be removed with the delete button while the entry is selected. 
Double clicking any of the fields of an entry allows to edit the data within the field.

The posebank value is used to differentiate between animations that should be played out and animations that are a set a of set of sequential poses.
This is mostly used for death banks which are used to provide a set of death poses. Character animation sets have an animation slot for death banks

 

=== Multi Layer Exporter ===
[[File:MayaExporter_MLE.png | none]]
 The multi layer exporter 

 
The Multi Layer Exporter is the workhorse of this script package. 
It is responsible for exporting models, physics and animations to their correct formats.
 

Most cases will only show the top left hand panel with the layers currently available in the scene. 
Layers that shouldn’t be exported can be hidden from this list with the Exclude_ prefix. 
A Layer should contain the relevant model and its matching physics. 
 

Physics are expected to have the _Phys suffix 
Rig Bones are expected to have _Bone or Bone_ in their name
 

The layer name determines the exported file name: 
*{LayerName}.lsm (lsm is a custom extension we use to recognize your custom granny files. If you have a .gr2 file, you can simply rename it to .lsm)
*{LayerName}_Phys.bullet
 

The _Base suffix tells the MLE that the layer contains a character rig. 
This is particularly useful for exporting models that are supposed to be used in a visual set and need their rig exported separately in one piece. 
 

The Right Hand panel becomes available when the animation checkbox is checked. 
When this is checked the MLE will look for a folder in the same location as your currently open maya file with the same name as your currently open maya file. 
If it finds such a folder it will list all the maya files available in the folder. 
When exporting, animations are put within a folder with the name of the base file.
 

Alternatively when opening the MLE in a file within a folder with a name similar to one of the maya files neighbouring it MLE will recognize the file as an animation file and show Animation Manager data instead. 
These files won’t allow model or physics exports.
 

The bottom History Panel keeps track of where you have exported already. 
The paths created are dependent on the provided data path. 
Found mods within the data path and whether or not you have browsed for new paths with the browse button on the botton left.
 

On start up the MLE searches through the data path for available mods and lists them in the target project dropdown list. 
If your currently open maya file is in a path containing the currently selected mod’s name it will copy the structure of your assets in the export path. 
If the source doesn’t match up exports are done within the base folder of the mod.
 

The actual export button is on the bottom left. 
The delete and clear all button are for the path history panel.
 

The visual checkbox enables model export doesn’t include objects with a _Phys suffix in their name. 
The Physics checkbox enables physics export when checked alone only objects with a _Phys suffix in their name are exported. 
The Animation Checkbox enables animation exporting if you’re working from a base file. Is on by default if the file you are in is recognized as an animation file.
 

Make sure to have all model pivots centered on 0,0,0 the exporter does not do this for you.

 

=== Advanced Export Settings ===
[[File:MayaExporter_Advanced.png | none]]
 The advanced export settings 

 
==== Edit Export Settings ====
Allows you to change the granny preset during export. 
Most likely you’ll never need this in a mod export. 

==== Single Character Export ====
Tells the MLE to select the entire rig hierarchy rather than just what is skinned to a model. 
This checkbox can be overridden to be always active in a file with the Export Variables Setup Make Single Object button. 
This is active by default for a Base Layer export. 

==== Export Vertex Colour ====
Tells the MLE to include vertex colour in the export of the selected layers. 
This overridden with the Export Variable Setup Make Cloth Simmed since cloth simulation requires vertex colours to be present. 

==== Create Debug Log ====
This checkbox is for when the Express Export variable is off. 
It tries to catch any export errors occurring and write them in a debug log which is shows after export. 

==== Express Export ====
This checkbox is on by default it tells the MLE the export the files in the current maya instance. 
Turn this off if you have a large amount of models to export. With this variable off the MLE will use maya standalone batch mode to export models more quickly. 
Maya standalone is used by default for exporting Animations from a base file. 

 

=== Modify Path ===
[[File:MayaExporter_Path.png | none]]
 Data path editor 

 
The Multi Layer Exporter has been specifically modified to use a file hidden within your default maya script path to find the Divinity Engine data path. 
The Modify Path script allows you to set up and modify the path saved. 
The MLE will throw a warning when this isn’t done before its first launch.

 
=== Export Variables Setup ===
[[File:MayaExporter_Variables.png | none]]
 Variable setup window 

 
The Divinity Engine has a few extra functions that can be activated via variables attached to the model data. 
The Multi Layer Exporter also reads these variables to ensure everything that needs to be present in the export file is present. 

Make Unskinned Animated is to allow objects which are rigidly animated or include dummies that need to be interacted with be fully recognized as such. 
Apply this Variable if the object needs effects attached needs to function like a bed or chair or is an object with dummy driven animations like a door. 
Works on current selection. 

Make Cloth Simmed is specifically for character Models with elements that need cloth sim applied. 
The object needs to have vertex colour applied and a variable to indicate it needs to be treated as a simulated object. 
Works on current selection. 

Make Single Object is specifically for the MLE to override the Single Character Export checkbox and include every bone within a detected rig in the export with every single export. 
Works on every dummy root and Dummy_*LayerName* objects it finds within the scene.

 
=== Export Physics Setup ===
[[File:MayaExporter_Physics.png | none]]
 Physics variable setup window 

 
The bullet plugin in maya has a few known issues with exporting. 
Rather than allowing artists to set up their own bullet variables two export variables have been made to replace them. 
With these Variables the MLE will set up the bullet variables so scaling issues can be avoided during physics exports. 
Both buttons work on current selection. 

Kinematic Physics Mesh is for objects that can be moved during gameplay like barrels or characters. 
Static Physics Mesh is for everything else that cannot be moved and serves as such scenery.

File:MayaExporter Animation.png

2018-02-08T12:35:44Z

JoykaDeReyst: JoykaDeReyst uploaded a new version of File:MayaExporter Animation.png

File:Bear Example.zip

2018-02-08T12:34:17Z

JoykaDeReyst: JoykaDeReyst uploaded a new version of File:Bear Example.zip

File:Door Example.zip

2018-02-08T12:09:44Z

JoykaDeReyst: JoykaDeReyst uploaded a new version of File:Door Example.zip

Panels

2018-02-07T14:32:03Z

JoykaDeReyst:

[[File:LarianLogo_Icon.png|32px]] <big>[[Atmosphere panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Animation resource panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Animation set resource panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Arena level settings panel]] (Coming Soon)</big>
 
[[File:CombatGroupPanel_Icon.png|32px]] <big>[[Combat group panel]]</big>
 
[[File:ContentBrowser_Icon.png|32px]] <big>[[Content browser]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Level settings window]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Project settings window]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Publish project window]]</big>
 
[[File:RootTemplatePanel_Icon.png|32px]] <big>[[Root template panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Sidebar]]</big>
 
* [[File:LarianLogo_Icon.png|32px]] <big>[[:Category:Use_Actions|Use Actions]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Visual resource panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Visual set resource panel]]</big>
 
[[File:WorldMapRendererPanel_Icon.png|32px]] <big>[[World map renderer panel]]</big>
 
[[File:WorkAtmospherePanel_Icon.png|32px]] <big>[[Work atmosphere panel]]</big>
 
[[File:WorldOutliner_Icon.png|32px]] <big>[[World outliner]]</big>

Visual resource panel

2018-02-07T14:30:55Z

JoykaDeReyst: /* 7. Cloths Tab */

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. 
The properties will only be applied to models that are exported with Vertex Painting and the attribute UserDefinedProperty with value cloth=1. 
Read [[Modding:_Maya_Exporter|The Maya Exporter Guide]] to sknow how to apply the cloth sim attribute. 
 
'''Warning''': Cloth simmed objects need to have 2 bones skinned to them. Use a 0.01 influence for helmet feathers on the chin bone after skinning them to the head bone. 
'''Tip:''' Long closed skirts don't look very good with cloth sim. Always make sure to have extra cuts 
 
These are the cloth properties available:
*'''Stiffness: ''' How much the cloth can stretch.
*'''Bending: ''' How much the cloth can bend.
*'''Iterations: ''' How often the cloth calcuations are redone before being considered final.
*'''PoseMatching:''' How close it it sticks to the default skin position. (Used for feather on helmets)
*'''Margin:''' How large the collision model is for the cloth.
*'''kg/m2:''' How heavy the cloth is for the simulation. (Isn't used during non still animations)

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to have an automatic wind simulated on the cloth model. To have these variables matter for your cloth make sure to check '''Atmospheric Wind'''. 
Models that use these variables are ''the burning witch'' and ''gheist'' models.

These are the variables available for defining what the simulated wind is like:
*'''Atmospheric wind:''' Turn on the have to have the cloth automatically simulate and use these variables.
*'''Lift:''' ???
*'''Drag:''' ???
*'''Frontal Wind Speed:''' The speed with which the wind is blowing for this cloth.
*'''Frontal Wind Variance:''' changes the noise range of the wind.
*'''Frontal Wind Frequency:''' changes how fast the cloth jumps back and fort within the variance.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:29:38Z

JoykaDeReyst: /* 7. Cloths Tab */

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. 
The properties will only be applied to models that are exported with Vertex Painting and the attribute UserDefinedProperty with value cloth=1. 
Read [[Modding:_Maya_Exporter|The Maya Exporter Guide]] to sknow how to apply the cloth sim attribute. 
 
'''Warning''': Cloth simmed objects need to have 2 bones skinned to them. 
'''Tip:''' Long closed skirts don't look very good with cloth sim. Always make sure to have extra cuts 
 
These are the cloth properties available:
*'''Stiffness: ''' How much the cloth can stretch.
*'''Bending: ''' How much the cloth can bend.
*'''Iterations: ''' How often the cloth calcuations are redone before being considered final.
*'''PoseMatching:''' How close it it sticks to the default skin position. (Used for feather on helmets)
*'''Margin:''' How large the collision model is for the cloth.
*'''kg/m2:''' How heavy the cloth is for the simulation. (Isn't used during non still animations)

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to have an automatic wind simulated on the cloth model. To have these variables matter for your cloth make sure to check '''Atmospheric Wind'''. 
Models that use these variables are ''the burning witch'' and ''gheist'' models.

These are the variables available for defining what the simulated wind is like:
*'''Atmospheric wind:''' Turn on the have to have the cloth automatically simulate and use these variables.
*'''Lift:''' ???
*'''Drag:''' ???
*'''Frontal Wind Speed:''' The speed with which the wind is blowing for this cloth.
*'''Frontal Wind Variance:''' changes the noise range of the wind.
*'''Frontal Wind Frequency:''' changes how fast the cloth jumps back and fort within the variance.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:28:11Z

JoykaDeReyst: /* 7. Cloths Tab */

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. 
The properties will only be applied to models that are exported with Vertex Painting and the attribute UserDefinedProperty with value cloth=1. 
Read [[Modding:_Maya_Exporter|The Maya Exporter Guide]] to sknow how to apply the cloth sim attribute. 
'''Warning''': Cloth simmed objects need to have 2 bones skinned to them. 
'''Tip:''' Long closed skirts don't look very good with cloth sim. Always make sure to have extra cuts

These are the cloth properties available:
*'''Stiffness: ''' How much the cloth can stretch.
*'''Bending: ''' How much the cloth can bend.
*'''Iterations: ''' How often the cloth calcuations are redone before being considered final.
*'''PoseMatching:''' How close it it sticks to the default skin position. (Used for feather on helmets)
*'''Margin:''' How large the collision model is for the cloth.
*'''kg/m2:''' How heavy the cloth is for the simulation. (Isn't used during non still animations)

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to have an automatic wind simulated on the cloth model. To have these variables matter for your cloth make sure to check '''Atmospheric Wind'''. 
Models that use these variables are ''the burning witch'' and ''gheist'' models.

These are the variables available for defining what the simulated wind is like:
*'''Atmospheric wind:''' Turn on the have to have the cloth automatically simulate and use these variables.
*'''Lift:''' ???
*'''Drag:''' ???
*'''Frontal Wind Speed:''' The speed with which the wind is blowing for this cloth.
*'''Frontal Wind Variance:''' changes the noise range of the wind.
*'''Frontal Wind Frequency:''' changes how fast the cloth jumps back and fort within the variance.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:26:12Z

JoykaDeReyst:

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. 
The properties will only be applied to models that are exported with Vertex Painting and the UserDefinedProperty cloth=1. 
'''Warning''': Cloth simmed objects need to have 2 bones skinned to them. 
'''Tip:''' Long closed skirts don't look very good with cloth sim. Always make sure to have extra cuts

These are the cloth properties available:
*'''Stiffness: ''' How much the cloth can stretch.
*'''Bending: ''' How much the cloth can bend.
*'''Iterations: ''' How often the cloth calcuations are redone before being considered final.
*'''PoseMatching:''' How close it it sticks to the default skin position. (Used for feather on helmets)
*'''Margin:''' How large the collision model is for the cloth.
*'''kg/m2:''' How heavy the cloth is for the simulation. (Isn't used during non still animations)

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to have an automatic wind simulated on the cloth model. To have these variables matter for your cloth make sure to check '''Atmospheric Wind'''. 
Models that use these variables are ''the burning witch'' and ''gheist'' models.

These are the variables available for defining what the simulated wind is like:
*'''Atmospheric wind:''' Turn on the have to have the cloth automatically simulate and use these variables.
*'''Lift:''' ???
*'''Drag:''' ???
*'''Frontal Wind Speed:''' The speed with which the wind is blowing for this cloth.
*'''Frontal Wind Variance:''' changes the noise range of the wind.
*'''Frontal Wind Frequency:''' changes how fast the cloth jumps back and fort within the variance.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:25:56Z

JoykaDeReyst: /* 8. Cloths Wind Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. 
The properties will only be applied to models that are exported with Vertex Painting and the UserDefinedProperty cloth=1. 
'''Warning''': Cloth simmed objects need to have 2 bones skinned to them. 
'''Tip:''' Long closed skirts don't look very good with cloth sim. Always make sure to have extra cuts

These are the cloth properties available:
*'''Stiffness: ''' How much the cloth can stretch.
*'''Bending: ''' How much the cloth can bend.
*'''Iterations: ''' How often the cloth calcuations are redone before being considered final.
*'''PoseMatching:''' How close it it sticks to the default skin position. (Used for feather on helmets)
*'''Margin:''' How large the collision model is for the cloth.
*'''kg/m2:''' How heavy the cloth is for the simulation. (Isn't used during non still animations)

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to have an automatic wind simulated on the cloth model. To have these variables matter for your cloth make sure to check '''Atmospheric Wind'''. 
Models that use these variables are ''the burning witch'' and ''gheist'' models.

These are the variables available for defining what the simulated wind is like:
*'''Atmospheric wind:''' Turn on the have to have the cloth automatically simulate and use these variables.
*'''Lift:''' ???
*'''Drag:''' ???
*'''Frontal Wind Speed:''' The speed with which the wind is blowing for this cloth.
*'''Frontal Wind Variance:''' changes the noise range of the wind.
*'''Frontal Wind Frequency:''' changes how fast the cloth jumps back and fort within the variance.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:24:58Z

JoykaDeReyst: /* 7. Cloths Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. 
The properties will only be applied to models that are exported with Vertex Painting and the UserDefinedProperty cloth=1. 
'''Warning''': Cloth simmed objects need to have 2 bones skinned to them. 
'''Tip:''' Long closed skirts don't look very good with cloth sim. Always make sure to have extra cuts

These are the cloth properties available:
*'''Stiffness: ''' How much the cloth can stretch.
*'''Bending: ''' How much the cloth can bend.
*'''Iterations: ''' How often the cloth calcuations are redone before being considered final.
*'''PoseMatching:''' How close it it sticks to the default skin position. (Used for feather on helmets)
*'''Margin:''' How large the collision model is for the cloth.
*'''kg/m2:''' How heavy the cloth is for the simulation. (Isn't used during non still animations)

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to have an automatic wind simulated on the cloth model. To have these variables matter for your cloth make sure to check '''Atmospheric Wind'''. 
Models that use these variables are ''the burning witch'' and ''gheist'' models.

These are the variables available for defining what the simulated wind is like:
*'''Atmospheric wind:''' Turn on the have the cloth automatically simulate and use these variables
*'''Lift:''' ???
*'''Drag:''' ???
*'''Frontal Wind Speed:''' The speed with which the wind is blowing for this cloth.
*'''Frontal Wind Variance:''' changes the noise range of the wind.
*'''Frontal Wind Frequency:''' changes how fast the cloth jumps back and fort within the variance.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:22:00Z

JoykaDeReyst: /* 8. Cloths Wind Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

These are the cloth properties available:
*'''Stiffness: ''' How much the cloth can stretch.
*'''Bending: ''' How much the cloth can bend.
*'''Iterations: ''' How often the cloth calcuations are redone before being considered final.
*'''PoseMatching:''' How close it it sticks to the default skin position. (Used for feather on helmets)
*'''Margin:''' How large the collision model is for the cloth.
*'''kg/m2:''' How heavy the cloth is for the simulation

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to have an automatic wind simulated on the cloth model. To have these variables matter for your cloth make sure to check '''Atmospheric Wind'''. 
Models that use these variables are ''the burning witch'' and ''gheist'' models.

These are the variables available for defining what the simulated wind is like:
*'''Atmospheric wind:''' Turn on the have the cloth automatically simulate and use these variables
*'''Lift:''' ???
*'''Drag:''' ???
*'''Frontal Wind Speed:''' The speed with which the wind is blowing for this cloth.
*'''Frontal Wind Variance:''' changes the noise range of the wind.
*'''Frontal Wind Frequency:''' changes how fast the cloth jumps back and fort within the variance.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:10:46Z

JoykaDeReyst: /* 7. Cloths Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

These are the cloth properties available:
*'''Stiffness: ''' How much the cloth can stretch.
*'''Bending: ''' How much the cloth can bend.
*'''Iterations: ''' How often the cloth calcuations are redone before being considered final.
*'''PoseMatching:''' How close it it sticks to the default skin position. (Used for feather on helmets)
*'''Margin:''' How large the collision model is for the cloth.
*'''kg/m2:''' How heavy the cloth is for the simulation

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to set all the wind properties of each model within your visual. Wind properties simulate the external properties that affects the cloth properties. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:06:28Z

JoykaDeReyst: /* 7. Cloths Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

The are the cloth properties available:
*'''Stiffness:
*'''Bending:
*'''Iterations: How often the cloth calcuations are redone before being considered final.'''
*'''PoseMatching:'''
*'''Margin:'''
*'''kg/m2:''' How heavy the cloth is for the simulation

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to set all the wind properties of each model within your visual. Wind properties simulate the external properties that affects the cloth properties. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T14:06:19Z

JoykaDeReyst: /* 7. Cloths Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

The are the cloth properties available:
*'''Stiffness:
*'''Bending:
*'''Iterations: How often the cloth calcuations are redone before being considered final.'''
*'''PoseMatching:'''
*'''Margin:'''
*'''kg/m2: How heavy the cloth is for the simulation'''

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to set all the wind properties of each model within your visual. Wind properties simulate the external properties that affects the cloth properties. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T13:56:25Z

JoykaDeReyst: /* 3. Default Animations Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

'''TIP:''' If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allowing you the freedom to plug this default animation set in any other visual that has a rig compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to set all the wind properties of each model within your visual. Wind properties simulate the external properties that affects the cloth properties. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T13:55:26Z

JoykaDeReyst: /* 2. Animation Waterfall Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set ''Animals_Shark_ABC_Ghost'' and when it doesn't find what it needs it will continue its search in the animation set ''Animals_Shark_ABC_Default''. 
This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. 
You can assign an animation set by selecting an animation set resource (red running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

TIP: If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allow you the freedom to plug this default animation set in any other visual that is compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to set all the wind properties of each model within your visual. Wind properties simulate the external properties that affects the cloth properties. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T13:54:02Z

JoykaDeReyst: /* 1. Materials Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

'''TIP:''' Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

'''IMPORTANT:''' Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set Animals_Shark_ABC_Ghost and when it doesn't find what it needs it will continue its search in the animation set Animals_Shark_ABC_Default. This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. You can assign an animation set by selecting an animation set resource (pink running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

TIP: If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allow you the freedom to plug this default animation set in any other visual that is compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to set all the wind properties of each model within your visual. Wind properties simulate the external properties that affects the cloth properties. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T13:53:44Z

JoykaDeReyst: /* 1. Materials Tab */

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button. 
Without a material the model will use a default checkers material.

TIP: Try to keep the amount of models as low as possible. The more models you have the more likely you create to encounter material sorting issues when special shaders are applied through status effects. Less models is also less render calls when this visual is used in game.

IMPORTANT: Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set Animals_Shark_ABC_Ghost and when it doesn't find what it needs it will continue its search in the animation set Animals_Shark_ABC_Default. This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. You can assign an animation set by selecting an animation set resource (pink running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

TIP: If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allow you the freedom to plug this default animation set in any other visual that is compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to set all the wind properties of each model within your visual. Wind properties simulate the external properties that affects the cloth properties. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Visual resource panel

2018-02-07T13:51:29Z

JoykaDeReyst:

(Page in Progress!)

A Visual Resource is recognised by the yellow little teapot in the Content Browser. To open it, double click the visual resource of your interest.

[[File:Visuals open.jpg|1280px|frameless]]

==1. Materials Tab==
Here you find the list of each seperate object that was exported in your GR2 file. Each object will need a material in order to properly show in game. You can assign a material by selecting a material resource (purple sphere) and click on the '<-' button.

TIP: Try to keep the amount of models as low as possible. The more models you have the more likeliness you create to encounter material sorting issues when special shaders are applied through status effects.

IMPORTANT: Each skinned object is capped in the engine to a limit of 128 bones! This means if you have a character with a rig that has more than 128 bones that you will need to cut the mesh into 2 different models in your 3rd party modeling tool. For your own convenience, look for a place to cut your mesh where possible seams in texture and shaders are hardly visible.

[[File:Visuals tab1.jpg|1280px|frameless]]

==2. Animation Waterfall Tab==
This tab lets you assign different Animation sets and arrange them in a top to down priority list. The game engine will waterfall down through all the animation sets to find the animation it needs. In the example below, the game engine will first look for its animation in the animation set Animals_Shark_ABC_Ghost and when it doesn't find what it needs it will continue its search in the animation set Animals_Shark_ABC_Default. This means that the animations assigned in a higher prioritized animation set will ALWAYS override the animations that are assigned in lower prioritized animations sets. You can assign an animation set by selecting an animation set resource (pink running men) and click on the '<-' button. Adding animation set is done by assigning it to the blanc slot, this will automatically adopt the animation set name and create a new blanc slot underneath it. By click-dragging the slots you can rearrange the priority order.

[[File:Visuals tab2.jpg|1280px|frameless]]

==3. Default Animations Tab==
This tab is literally the same as having an animation set resource with the only fundamental difference that the animation set is embedded and exclusively for this visual ONLY.

TIP: If you have no particular reason to embed the animation list into your visual, I would advise to avoid resorting to use this tab since you can just create an animation set resource instead and plug it in the waterfall like shown in the screenshot above. This will result in the same while allow you the freedom to plug this default animation set in any other visual that is compatible with those animations as well.

[[File:Visuals tab3.jpg|1280px|frameless]]

==4. Resolved Animations Tab==

[[File:Visuals tab4.jpg|1280px|frameless]]

==5. Script Overrides Tab==
In this tab you can list all the animation sets that can be called upon through script. When you assign an animation set in this tab you should come up with a Simple Name for that set, a name that will be used in the script calls. When script calls this simple name than this animation set will overrides any other animation set currently set as default OR set in the animation waterfall. This also means, that if an animation is requested by the game engine while its NOT filled in the script overridden animation set, then nothing will be played. There is no fallback!

We have [[Standard_Character_Animations|a list]] of available simple animation names and the races for which these animations have been made.

[[File:Visuals tab5.jpg|1280px|frameless]]

==6. Attachments Tab==
Here you get an overview of all the bones the visual resource has and gives you the ability to attach visual effects and items to them. These attached visual effects are not depending on animation and will spawn when the visual is set on stage. It will also continuously play if the attached visual effect is set to looping, otherwise it will play once. At this point only visual effects resources can be attached, nothing else!

[[File:Visuals tab6.jpg|1280px|frameless]]

==7. Cloths Tab==
This tab allows you to set all the cloth properties of each model within your visual. Cloth properties simulate the fabric properties of cloth. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab7.jpg|1280px|frameless]]

==8. Cloths Wind Tab==
This tab allows you to set all the wind properties of each model within your visual. Wind properties simulate the external properties that affects the cloth properties. The properties will only be applied to models that are exported with Vertex Painting.

[[File:Visuals tab8.jpg|1280px|frameless]]

__________________ 
Back to [[Panels]]

Panels

2018-02-07T13:41:03Z

JoykaDeReyst:

[[File:LarianLogo_Icon.png|32px]] <big>[[Atmosphere panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Animation resource panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Animation set resource panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Arena level settings panel]] (Coming Soon)</big>
 
[[File:CombatGroupPanel_Icon.png|32px]] <big>[[Combat group panel]]</big>
 
[[File:ContentBrowser_Icon.png|32px]] <big>[[Content browser]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Level settings window]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Project settings window]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Publish project window]]</big>
 
[[File:RootTemplatePanel_Icon.png|32px]] <big>[[Root template panel]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Sidebar]]</big>
 
* [[File:LarianLogo_Icon.png|32px]] <big>[[:Category:Use_Actions|Use Actions]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Visual resource panel]] (Work In Progress)</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Visual set resource panel]]</big>
 
[[File:WorldMapRendererPanel_Icon.png|32px]] <big>[[World map renderer panel]]</big>
 
[[File:WorkAtmospherePanel_Icon.png|32px]] <big>[[Work atmosphere panel]]</big>
 
[[File:WorldOutliner_Icon.png|32px]] <big>[[World outliner]]</big>

Animation set resource panel

2018-02-07T13:40:30Z

JoykaDeReyst:

An Animation Set Resource is recognized by the 3 red running men in the Content Browser. Double click it to open the Animation Set.

==1) Overview==
An animation set is the collection of simple names a character or item can have. Note that this list is a preset list but does not restrict the character to ONLY that list. In other words the functionality of a character or an item lies in code, and does not depend on this list, the list is merely a selection of simple names you wish to be exposed to.

[[File:Animset 1.jpg|1280px|frameless]]

==2) Put it on the tab==
An animation set has a minumum of 3 tabs it starts with by default, to those 3 you can add one more tab for each weapon animation set, sitting and laying down. These additional sets are copies of the default tab which allows you to fill in different looking animations for each equipped weapon, or for when your character is sitting or laying down. All tabs automatically fall back to the Default tab if a requested animation is not found. 
To add an animation simply select the animation you would like in the Content Browser and press the "<-" button next to the animation simple name slot.

[[File:Animset 2.jpg|1280px|frameless]]

Here's a overview of all possible tabs when activated: 
* '''Default:''' contains a list of all default animations a character can do. The default tab is also the animation set that is being played when a character is in peace mode.
* '''Custom:''' contains a blank list that is editable by the user so customised simple names can be added to a character. These animations can then be called upon by scripts.
* '''Skills:''' contains a fixed list of simple names required for skills without weapon requirements. Skill with weapon requirements are listed in their respective weapon tab.
 
* '''Sitting:''' contains a list of animations slots available for sitting.
* '''Lying:''' contains a list of animations slots available for lying.
 
* '''Shield (SH):''' contains a list of animations slots available for when a character is wielding a shield.
* '''Small Weapons (SML):''' contains a list of animations slots available for when a character is wielding a dagger or other small arms.
* '''Pole Arms (POLE):''' contains a list of animations slots available for when a character is wielding a spear or other long reach pole weapons.
* '''Unarmed (UA):''' contains a list of animations slots available for when a character has no weapons and is unarmed in the combat state.
* '''CrossBow (XB):''' contains a list of animations slots available for when a character is wielding a crossbow.
* '''Two Handed Sword (2HS):''' contains a list of animations slots available for when a character is wielding a two handed sword.
* '''Dual Wield Small (DWSML):''' contains a list of animations slots available for when a character is wielding a pair of daggers or other small arms.
* '''Staves (ST):''' contains a list of animations slots available for when a character is wielding a staff or other similar magical staves.
* '''One Handed (1H):''' contains a list of animations slots available for when a character is wielding a one handed weapon that isn't a sword, usually bludgeoning arms.
* '''Two Handed (2H):''' contains a list of animations slots available for when a character is wielding a two handed weapon that isn't a sword, usually bludgeoning arms.
* '''Bow (BOW):''' contains a list of animations slots available for when a character is wielding a bow.
* '''Dual Wield (DW):''' contains a list of animations slots available for when a character is wielding a pair of one handed weapons.
* '''Wand (WD):''' contains a list of animations slots available for when a character is wielding a wand or other magical small arms.
* '''Dual Wield Wands (DWWD):''' contains a list of animations slots available for when a character is wielding a pair of magical wands.
* '''Shield & Wand (SHWD):''' contains a list of animations slots available for when a character is wielding a shield and a magical wand.

==3) Animation Set type==

The animation set type determines which tabs and slots are made by default in the animation set. 
The following presets are available: 

* '''<none>:''' Resets the naimation set panel to an empty state
* '''player:''' Creates a default, custom and skill tab with all default animation slots available. Allows you to add extr animaiton tabs.
* '''character:''' Does the same as the player preset
* '''animal:''' Creates a simplified animation set for an animal that can't enter combat. Doesn't allow additional tabs to be added and only has a '''Default''' and '''Custom''' tab.
* '''item:''' Created an animaiton set tailored for items. Doesn't allow additional tabs to be added and only has a '''Default''' and '''Custom''' tab.

==4) Animation slots==
Every animation set contains a set of animation slots. These have specific functions in game terms and differ between the animation set types. 
Here we'll explain a character set and an item set it's animation slots and how custom animation slots are used.

===Item Animation Slots===

Items do have animations depending on wether they can be interacted with or destroyed. Some of the slots can only be called via scripts like the custom slots. 
Here are the animation slots available for an item: 
* '''Idle:''' If the item isn't just static but idly animates between action you can use this slot
* '''Open/Close:''' If the item can be opened and closed use these slots to define how it animates.
* '''Destruction:''' If the item can be destroyed this contains it's destroy animation. Most items have a seperate exploding mesh that use this slot.
* '''Attack:''' If the item can join combat an attack this slot can contain the animation it uses when attacking.
* '''Custom 1,2,3:''' If the item has unique scripts animations top play you can use these slots or creat a custom named in the custom tab for clarity.
* '''Spawn:''' If the item is created by a summon like skill it will use the spawn animation slot

===Character Animation Slots===

Characters have a wide variety of actions they can take. For clarity and brevity's sake I'll be grouping quite some of the slots. 
You can assume numbered slots are randomly picked between when the action associated with them occurs. 

These are the animation slots available for characters: 
*'''attack:''' When the character attacks these animation slots are used. There are seperate variations for ground and cleave attacks.
*'''knockdown:''' When the chracter get's knocked down the game will try to cycle through these animation slots.
*'''barf:''' Used for some status states
*'''die:''' When a character dies the game will pick an appropriate slot from these animation slots depending on the death type.
*'''deathpose_physical:''' Takes a posebank as input animation and allows there character to start dead in a level.
*'''hit:''' When a character gets attacked and it connects the game will pick one of these depending on the attack done.
*'''block,dodge:''' When a character gets attack and it doens't connect the game will pick one of these animations depending on the miss reason.
*'''idle:''' When a character is left alone it will eventually start idling.
*'''walk:''' Slow movement animation.
*'''run:''' Fast movement animation
*'''sneak:''' Sneak movement animation
*'''still:''' Default animation state
*'''wings:''' Movement animation when a character has wings
*'''cower:''' When a haracter can't join combat and can't escape it will cower.
*'''sheath/unsheath:''' When a character changes combat state from peacefull to combat and vice versa
*'''spawn:''' When a character is summon via a skill (or script)
*'''resurect:''' When a character gets revived
*'''use:''' Various actions for interacting with items in the environment
*'''emotion:''' Various animations for use in dialog
*'''climb:'''Animations needed to allow a character to climb up and down ladders.
*'''skill_prepare_<x>_start:''' When a character starts preparing a skill
*'''skill_prepare_<x>_loop:''' When a character has started preparing a skill but the target isn't decided yet
*'''skill_cast_<x>_cast:''' When a character executes a skill
*'''skill_attack_<x>_cast:''' same as skill_cast_<x>_cast but for weapon skills

__________________ 
Back to [[Panels]]

Animation set resource panel

2018-02-07T13:38:51Z

JoykaDeReyst: /* Item Animation Slots */

(Page in Progress!)

An Animation Set Resource is recognized by the 3 red running men in the Content Browser. Double click it to open the Animation Set.

==1) Overview==
An animation set is the collection of simple names a character or item can have. Note that this list is a preset list but does not restrict the character to ONLY that list. In other words the functionality of a character or an item lies in code, and does not depend on this list, the list is merely a selection of simple names you wish to be exposed to.

[[File:Animset 1.jpg|1280px|frameless]]

==2) Put it on the tab==
An animation set has a minumum of 3 tabs it starts with by default, to those 3 you can add one more tab for each weapon animation set, sitting and laying down. These additional sets are copies of the default tab which allows you to fill in different looking animations for each equipped weapon, or for when your character is sitting or laying down. All tabs automatically fall back to the Default tab if a requested animation is not found. 
To add an animation simply select the animation you would like in the Content Browser and press the "<-" button next to the animation simple name slot.

[[File:Animset 2.jpg|1280px|frameless]]

Here's a overview of all possible tabs when activated: 
* '''Default:''' contains a list of all default animations a character can do. The default tab is also the animation set that is being played when a character is in peace mode.
* '''Custom:''' contains a blank list that is editable by the user so customised simple names can be added to a character. These animations can then be called upon by scripts.
* '''Skills:''' contains a fixed list of simple names required for skills without weapon requirements. Skill with weapon requirements are listed in their respective weapon tab.
 
* '''Sitting:''' contains a list of animations slots available for sitting.
* '''Lying:''' contains a list of animations slots available for lying.
 
* '''Shield (SH):''' contains a list of animations slots available for when a character is wielding a shield.
* '''Small Weapons (SML):''' contains a list of animations slots available for when a character is wielding a dagger or other small arms.
* '''Pole Arms (POLE):''' contains a list of animations slots available for when a character is wielding a spear or other long reach pole weapons.
* '''Unarmed (UA):''' contains a list of animations slots available for when a character has no weapons and is unarmed in the combat state.
* '''CrossBow (XB):''' contains a list of animations slots available for when a character is wielding a crossbow.
* '''Two Handed Sword (2HS):''' contains a list of animations slots available for when a character is wielding a two handed sword.
* '''Dual Wield Small (DWSML):''' contains a list of animations slots available for when a character is wielding a pair of daggers or other small arms.
* '''Staves (ST):''' contains a list of animations slots available for when a character is wielding a staff or other similar magical staves.
* '''One Handed (1H):''' contains a list of animations slots available for when a character is wielding a one handed weapon that isn't a sword, usually bludgeoning arms.
* '''Two Handed (2H):''' contains a list of animations slots available for when a character is wielding a two handed weapon that isn't a sword, usually bludgeoning arms.
* '''Bow (BOW):''' contains a list of animations slots available for when a character is wielding a bow.
* '''Dual Wield (DW):''' contains a list of animations slots available for when a character is wielding a pair of one handed weapons.
* '''Wand (WD):''' contains a list of animations slots available for when a character is wielding a wand or other magical small arms.
* '''Dual Wield Wands (DWWD):''' contains a list of animations slots available for when a character is wielding a pair of magical wands.
* '''Shield & Wand (SHWD):''' contains a list of animations slots available for when a character is wielding a shield and a magical wand.

==3) Animation Set type==

The animation set type determines which tabs and slots are made by default in the animation set. 
The following presets are available: 

* '''<none>:''' Resets the naimation set panel to an empty state
* '''player:''' Creates a default, custom and skill tab with all default animation slots available. Allows you to add extr animaiton tabs.
* '''character:''' Does the same as the player preset
* '''animal:''' Creates a simplified animation set for an animal that can't enter combat. Doesn't allow additional tabs to be added and only has a '''Default''' and '''Custom''' tab.
* '''item:''' Created an animaiton set tailored for items. Doesn't allow additional tabs to be added and only has a '''Default''' and '''Custom''' tab.

==4) Animation slots==
Every animation set contains a set of animation slots. These have specific functions in game terms and differ between the animation set types. 
Here we'll explain a character set and an item set it's animation slots and how custom animation slots are used.

===Item Animation Slots===

Items do have animations depending on wether they can be interacted with or destroyed. Some of the slots can only be called via scripts like the custom slots. 
Here are the animation slots available for an item: 
* '''Idle:''' If the item isn't just static but idly animates between action you can use this slot
* '''Open/Close:''' If the item can be opened and closed use these slots to define how it animates.
* '''Destruction:''' If the item can be destroyed this contains it's destroy animation. Most items have a seperate exploding mesh that use this slot.
* '''Attack:''' If the item can join combat an attack this slot can contain the animation it uses when attacking.
* '''Custom 1,2,3:''' If the item has unique scripts animations top play you can use these slots or creat a custom named in the custom tab for clarity.
* '''Spawn:''' If the item is created by a summon like skill it will use the spawn animation slot

===Character Animation Slots===

Characters have a wide variety of actions they can take. For clarity and brevity's sake I'll be grouping quite some of the slots. 
You can assume numbered slots are randomly picked between when the action associated with them occurs. 

These are the animation slots available for characters: 
*'''attack:''' When the character attacks these animation slots are used. There are seperate variations for ground and cleave attacks.
*'''knockdown:''' When the chracter get's knocked down the game will try to cycle through these animation slots.
*'''barf:''' Used for some status states
*'''die:''' When a character dies the game will pick an appropriate slot from these animation slots depending on the death type.
*'''deathpose_physical:''' Takes a posebank as input animation and allows there character to start dead in a level.
*'''hit:''' When a character gets attacked and it connects the game will pick one of these depending on the attack done.
*'''block,dodge:''' When a character gets attack and it doens't connect the game will pick one of these animations depending on the miss reason.
*'''idle:''' When a character is left alone it will eventually start idling.
*'''walk:''' Slow movement animation.
*'''run:''' Fast movement animation
*'''sneak:''' Sneak movement animation
*'''still:''' Default animation state
*'''wings:''' Movement animation when a character has wings
*'''cower:''' When a haracter can't join combat and can't escape it will cower.
*'''sheath/unsheath:''' When a character changes combat state from peacefull to combat and vice versa
*'''spawn:''' When a character is summon via a skill (or script)
*'''resurect:''' When a character gets revived
*'''use:''' Various actions for interacting with items in the environment
*'''emotion:''' Various animations for use in dialog
*'''climb:'''Animations needed to allow a character to climb up and down ladders.
*'''skill_prepare_<x>_start:''' When a character starts preparing a skill
*'''skill_prepare_<x>_loop:''' When a character has started preparing a skill but the target isn't decided yet
*'''skill_cast_<x>_cast:''' When a character executes a skill
*'''skill_attack_<x>_cast:''' same as skill_cast_<x>_cast but for weapon skills

__________________ 
Back to [[Panels]]

Animation set resource panel

2018-02-07T13:38:26Z

JoykaDeReyst: /* Character Animation Slots */

(Page in Progress!)

An Animation Set Resource is recognized by the 3 red running men in the Content Browser. Double click it to open the Animation Set.

==1) Overview==
An animation set is the collection of simple names a character or item can have. Note that this list is a preset list but does not restrict the character to ONLY that list. In other words the functionality of a character or an item lies in code, and does not depend on this list, the list is merely a selection of simple names you wish to be exposed to.

[[File:Animset 1.jpg|1280px|frameless]]

==2) Put it on the tab==
An animation set has a minumum of 3 tabs it starts with by default, to those 3 you can add one more tab for each weapon animation set, sitting and laying down. These additional sets are copies of the default tab which allows you to fill in different looking animations for each equipped weapon, or for when your character is sitting or laying down. All tabs automatically fall back to the Default tab if a requested animation is not found. 
To add an animation simply select the animation you would like in the Content Browser and press the "<-" button next to the animation simple name slot.

[[File:Animset 2.jpg|1280px|frameless]]

Here's a overview of all possible tabs when activated: 
* '''Default:''' contains a list of all default animations a character can do. The default tab is also the animation set that is being played when a character is in peace mode.
* '''Custom:''' contains a blank list that is editable by the user so customised simple names can be added to a character. These animations can then be called upon by scripts.
* '''Skills:''' contains a fixed list of simple names required for skills without weapon requirements. Skill with weapon requirements are listed in their respective weapon tab.
 
* '''Sitting:''' contains a list of animations slots available for sitting.
* '''Lying:''' contains a list of animations slots available for lying.
 
* '''Shield (SH):''' contains a list of animations slots available for when a character is wielding a shield.
* '''Small Weapons (SML):''' contains a list of animations slots available for when a character is wielding a dagger or other small arms.
* '''Pole Arms (POLE):''' contains a list of animations slots available for when a character is wielding a spear or other long reach pole weapons.
* '''Unarmed (UA):''' contains a list of animations slots available for when a character has no weapons and is unarmed in the combat state.
* '''CrossBow (XB):''' contains a list of animations slots available for when a character is wielding a crossbow.
* '''Two Handed Sword (2HS):''' contains a list of animations slots available for when a character is wielding a two handed sword.
* '''Dual Wield Small (DWSML):''' contains a list of animations slots available for when a character is wielding a pair of daggers or other small arms.
* '''Staves (ST):''' contains a list of animations slots available for when a character is wielding a staff or other similar magical staves.
* '''One Handed (1H):''' contains a list of animations slots available for when a character is wielding a one handed weapon that isn't a sword, usually bludgeoning arms.
* '''Two Handed (2H):''' contains a list of animations slots available for when a character is wielding a two handed weapon that isn't a sword, usually bludgeoning arms.
* '''Bow (BOW):''' contains a list of animations slots available for when a character is wielding a bow.
* '''Dual Wield (DW):''' contains a list of animations slots available for when a character is wielding a pair of one handed weapons.
* '''Wand (WD):''' contains a list of animations slots available for when a character is wielding a wand or other magical small arms.
* '''Dual Wield Wands (DWWD):''' contains a list of animations slots available for when a character is wielding a pair of magical wands.
* '''Shield & Wand (SHWD):''' contains a list of animations slots available for when a character is wielding a shield and a magical wand.

==3) Animation Set type==

The animation set type determines which tabs and slots are made by default in the animation set. 
The following presets are available: 

* '''<none>:''' Resets the naimation set panel to an empty state
* '''player:''' Creates a default, custom and skill tab with all default animation slots available. Allows you to add extr animaiton tabs.
* '''character:''' Does the same as the player preset
* '''animal:''' Creates a simplified animation set for an animal that can't enter combat. Doesn't allow additional tabs to be added and only has a '''Default''' and '''Custom''' tab.
* '''item:''' Created an animaiton set tailored for items. Doesn't allow additional tabs to be added and only has a '''Default''' and '''Custom''' tab.

==4) Animation slots==
Every animation set contains a set of animation slots. These have specific functions in game terms and differ between the animation set types. 
Here we'll explain a character set and an item set it's animation slots and how custom animation slots are used.

===Item Animation Slots===

Items do have animations depending on wether they can be interacted with or destroyed. Some of the slots can only be called via scripts like the custom slots. 
Here are the animation slots available for an item: 
* '''Idle:''' If the item isn't just static but idly animates between action you can use this slot
* '''Open/Close:''' If the item can be opened and closed use these slots to define how it animates.
* '''Destruction:''' If the item can be destroyed this contains it's destroy animation. Most animations have a seperate exploding mesh that use this slot.
* '''Attack:''' If the item can join combat an attack this slot can contain the animation it uses when attacking.
* '''Custom 1,2,3:''' If the item has unique scripts animations top play you can use these slots or creat a custom named in the custom tab for clarity.
* '''Spawn:''' If the item is created by a summon like skill it will use the spawn animation slot

===Character Animation Slots===

Characters have a wide variety of actions they can take. For clarity and brevity's sake I'll be grouping quite some of the slots. 
You can assume numbered slots are randomly picked between when the action associated with them occurs. 

These are the animation slots available for characters: 
*'''attack:''' When the character attacks these animation slots are used. There are seperate variations for ground and cleave attacks.
*'''knockdown:''' When the chracter get's knocked down the game will try to cycle through these animation slots.
*'''barf:''' Used for some status states
*'''die:''' When a character dies the game will pick an appropriate slot from these animation slots depending on the death type.
*'''deathpose_physical:''' Takes a posebank as input animation and allows there character to start dead in a level.
*'''hit:''' When a character gets attacked and it connects the game will pick one of these depending on the attack done.
*'''block,dodge:''' When a character gets attack and it doens't connect the game will pick one of these animations depending on the miss reason.
*'''idle:''' When a character is left alone it will eventually start idling.
*'''walk:''' Slow movement animation.
*'''run:''' Fast movement animation
*'''sneak:''' Sneak movement animation
*'''still:''' Default animation state
*'''wings:''' Movement animation when a character has wings
*'''cower:''' When a haracter can't join combat and can't escape it will cower.
*'''sheath/unsheath:''' When a character changes combat state from peacefull to combat and vice versa
*'''spawn:''' When a character is summon via a skill (or script)
*'''resurect:''' When a character gets revived
*'''use:''' Various actions for interacting with items in the environment
*'''emotion:''' Various animations for use in dialog
*'''climb:'''Animations needed to allow a character to climb up and down ladders.
*'''skill_prepare_<x>_start:''' When a character starts preparing a skill
*'''skill_prepare_<x>_loop:''' When a character has started preparing a skill but the target isn't decided yet
*'''skill_cast_<x>_cast:''' When a character executes a skill
*'''skill_attack_<x>_cast:''' same as skill_cast_<x>_cast but for weapon skills

__________________ 
Back to [[Panels]]

Animation set resource panel

2018-02-07T13:15:58Z

JoykaDeReyst:

(Page in Progress!)

An Animation Set Resource is recognized by the 3 red running men in the Content Browser. Double click it to open the Animation Set.

==1) Overview==
An animation set is the collection of simple names a character or item can have. Note that this list is a preset list but does not restrict the character to ONLY that list. In other words the functionality of a character or an item lies in code, and does not depend on this list, the list is merely a selection of simple names you wish to be exposed to.

[[File:Animset 1.jpg|1280px|frameless]]

==2) Put it on the tab==
An animation set has a minumum of 3 tabs it starts with by default, to those 3 you can add one more tab for each weapon animation set, sitting and laying down. These additional sets are copies of the default tab which allows you to fill in different looking animations for each equipped weapon, or for when your character is sitting or laying down. All tabs automatically fall back to the Default tab if a requested animation is not found. 
To add an animation simply select the animation you would like in the Content Browser and press the "<-" button next to the animation simple name slot.

[[File:Animset 2.jpg|1280px|frameless]]

Here's a overview of all possible tabs when activated: 
* '''Default:''' contains a list of all default animations a character can do. The default tab is also the animation set that is being played when a character is in peace mode.
* '''Custom:''' contains a blank list that is editable by the user so customised simple names can be added to a character. These animations can then be called upon by scripts.
* '''Skills:''' contains a fixed list of simple names required for skills without weapon requirements. Skill with weapon requirements are listed in their respective weapon tab.
 
* '''Sitting:''' contains a list of animations slots available for sitting.
* '''Lying:''' contains a list of animations slots available for lying.
 
* '''Shield (SH):''' contains a list of animations slots available for when a character is wielding a shield.
* '''Small Weapons (SML):''' contains a list of animations slots available for when a character is wielding a dagger or other small arms.
* '''Pole Arms (POLE):''' contains a list of animations slots available for when a character is wielding a spear or other long reach pole weapons.
* '''Unarmed (UA):''' contains a list of animations slots available for when a character has no weapons and is unarmed in the combat state.
* '''CrossBow (XB):''' contains a list of animations slots available for when a character is wielding a crossbow.
* '''Two Handed Sword (2HS):''' contains a list of animations slots available for when a character is wielding a two handed sword.
* '''Dual Wield Small (DWSML):''' contains a list of animations slots available for when a character is wielding a pair of daggers or other small arms.
* '''Staves (ST):''' contains a list of animations slots available for when a character is wielding a staff or other similar magical staves.
* '''One Handed (1H):''' contains a list of animations slots available for when a character is wielding a one handed weapon that isn't a sword, usually bludgeoning arms.
* '''Two Handed (2H):''' contains a list of animations slots available for when a character is wielding a two handed weapon that isn't a sword, usually bludgeoning arms.
* '''Bow (BOW):''' contains a list of animations slots available for when a character is wielding a bow.
* '''Dual Wield (DW):''' contains a list of animations slots available for when a character is wielding a pair of one handed weapons.
* '''Wand (WD):''' contains a list of animations slots available for when a character is wielding a wand or other magical small arms.
* '''Dual Wield Wands (DWWD):''' contains a list of animations slots available for when a character is wielding a pair of magical wands.
* '''Shield & Wand (SHWD):''' contains a list of animations slots available for when a character is wielding a shield and a magical wand.

==3) Animation Set type==

The animation set type determines which tabs and slots are made by default in the animation set. 
The following presets are available: 

* '''<none>:''' Resets the naimation set panel to an empty state
* '''player:''' Creates a default, custom and skill tab with all default animation slots available. Allows you to add extr animaiton tabs.
* '''character:''' Does the same as the player preset
* '''animal:''' Creates a simplified animation set for an animal that can't enter combat. Doesn't allow additional tabs to be added and only has a '''Default''' and '''Custom''' tab.
* '''item:''' Created an animaiton set tailored for items. Doesn't allow additional tabs to be added and only has a '''Default''' and '''Custom''' tab.

==4) Animation slots==
Every animation set contains a set of animation slots. These have specific functions in game terms and differ between the animation set types. 
Here we'll explain a character set and an item set it's animation slots and how custom animation slots are used.

===Item Animation Slots===

Items do have animations depending on wether they can be interacted with or destroyed. Some of the slots can only be called via scripts like the custom slots. 
Here are the animation slots available for an item: 
* '''Idle:''' If the item isn't just static but idly animates between action you can use this slot
* '''Open/Close:''' If the item can be opened and closed use these slots to define how it animates.
* '''Destruction:''' If the item can be destroyed this contains it's destroy animation. Most animations have a seperate exploding mesh that use this slot.
* '''Attack:''' If the item can join combat an attack this slot can contain the animation it uses when attacking.
* '''Custom 1,2,3:''' If the item has unique scripts animations top play you can use these slots or creat a custom named in the custom tab for clarity.
* '''Spawn:''' If the item is created by a summon like skill it will use the spawn animation slot

===Character Animation Slots===

__________________ 
Back to [[Panels]]

Animation resource panel

2018-02-07T12:47:51Z

JoykaDeReyst: /* The Animation Resource Panel aka Animation Previewer */

==The Animation Resource Panel aka Animation Previewer==

An Animation Resource is recognized by the orange running man in the Content Browser. To open the animation and access its meta data there are 2 ways you can do this. Both have the same outcome and technically it should not matter how you open it, but for each way has it's own advantage and disadvantage. This is illustrated in bullet A) and B) on this page.

Note that the previewer always forces itself to be highest on top. This might have the unwanted side effect that if you open another panel of any sort that this will be ordered behind the animation resource panel. This could unfortunately lead to the confusing situation where it might look that a certain panel didn't open, but simply is located BEHIND your animation resource panel.

===A) Shortcut to mushrooms.===
Double click the orange running man in your Content Browser and the animation resource panel will open in front of you. The animation previewer will now show that single animation file and all it's properties and Metadata. However the animation preview will ONLY be able to preview your animation on top of your visual if you have set a visual resource in the Preview Visual Resource ID property of your animation file. If you haven't set this, your time line will empty and your preview window will be blank. If that is the case, close the previewer, set the correct visual resource in the Sidebar and reopen the animation.

[[File:Animprev 2.jpg|1280px|frameless]]

===B) I’d say we were taking the long way around...===
You can also access your animation previewer by going through the Visual Resource that contains either the animation itself or the Animation Set Resource. To do this, 
1 - double click your Visual Resource 
2 - press Edit in the animation waterfall / or open the Default Animation tab 
3 - press Text Keys button of the animation set 
The Animation Previewer is now open and will show the entire list of all animations plugged into the animation set of your selected Visual Resource. This has the advantage you can cycle through them more quicky and that you don't need to have each animation with a predefined Preview Visual Resource ID in its properties.

[[File:Animprev 1.jpg|1280px|frameless]]

==The Animation Previewer==

Now lets go over the vital components of the Animation Previewer.

===The Preview window===
In this window your model will show and playback the selected animation. At the top shelve of the window you'll find an assort of buttons that manipulates the playback.
*<<Rotate>> : Lets you rotate your model. Alternatively your mouse buttons let you do similar navigation. Mouse click plus drag rotates the model, mouse wheel zooms in on it.
*Show Skeleton: Shows a stickfigure representation of your bone structure.
*Re-Center: Puts your model back in the center.
*WireFrame: renders your model in the wireframe of its mesh.
*Continuous: Playsback your animation continuously and indefinitally, regardless from the fact your animation is looping or not.
*Reset: Resets your preview window.
*Visual Picked: Lets your pick a different visual for your model representation, on the condition that the mesh is skinned to the same rig!

===The Animation List===
This is a list of all the animation you can preview, this list either shows a single animation or multiple animations depending on how you accessed the Animation Previewer. More on this in section A) and B) above.

===The Animation Properties===
These are the same properties as listed in the Sidebar information when you select the animation resource in the Resource Browser. A quick run through:
*'''Filename:'''
*'''GUID:''' It's unique identifier in the engine. Each time you add a resource a new GUID is assigned to the resource, and it is never the same.
*'''Name:''' The name you gave it when you imported your resource. This can be modified at any time.
*'''Type ID:''' the type you selected when you imported your resource.

*'''Active:'''
*'''Animation Name:'''
*'''Custom 1:'''
*'''Custom 2:'''
*'''Display Name:'''
*Duration:''' the total length of your animation in seconds.
*'''Initial Offset:'''
*'''Looping:''' whether or not the engine needs to loop your animation.
*'''Package Name:''' the package you selected when you imported your resource
*'''Pose Bank:''' whether your animation data is an actual animation or a collection of poses. Poses banks are currently used to put corpses in various predefined poses. An animation flagged as pose bank never animates!
*'''Preview Visual Resource ID:''' predefine which visual should be use to preview this animation.
*'''Source File:''' the file and path you've selected when you imported your resource. TIP: you can change the source file if you want to update/replace your animation to a different source so you may keep the GUID set to the original resource. This is important if your GUID is already used at places and want to maintain this link.
*'''Source File Short Name:'''
*'''Text Keys:'''

===Animation Time line===
This is the track that displays the length of the animation. The most important function of this element is to place text keys timed on your animation. To add a textkey simply right click on the track and pick a textkey from one of the presets. You can always start with the closest preset of what you need and customize it, by no means is this list a complete list of the possibilities, but merely a selection of what we perceive as most frequently used.
*blendout
*cast
*combat_comment
*dissolve
*hit
*hit_off
*hold
*loot
*move_start
*move_stop
*prepare
*pull
*relax
*shoot
*switch
*switch_off
*teleport
*vampirism
*attach
*effect
*footstep_left
*footstep_right
*sound
*swoosh
*ragdoll
*cast_shadows
*receive_decals

===Text keys and their functions===

There are different types of textkeys and each of them have their own function. Their properties will also change depending on which type you select. The color coded you see for each is how you will see them in the engine as well.

Default text driven keys:
These are the most basic of all text keys. Their function lies in sending a text based cue to code, and that text line is defined in it's name. Only text keys send their name as text cue to code! 
How the common text driven keys are used:
*'''cast:''' Works together with skill data to indicate when the impact effects should be played. Can also help delay cast effects to later in the animation.
*'''move_start:''' Works together with skill data to indicate when a rush skill should start to move a character.
*'''move_stop:''' Works together with skill data to indicate when a rush skill should stop moving a character.
*'''hold, pull, relax and shoot:''' Works together with the animation of a bow weapon to indicate how and when certain parts of it's weapon animation should play during a character it's skill and attack animaitons with a bow.
*'''switch:''' Indicates when a weapon is pulled out or stowed away during the draw and stow animations.
*'''teleport:''' Works together with skill data to indicate when a character should teleport to another place during a teleport skill
*'''vampirism:''' Works together with skill data to indicate when a source suck skill animation gets the source point.

Sound keys:
Signals the playback of a sound event. Which sound event is defined in the Sound Resource ID property.

Effects keys:
Plays an effect on top of your animation. You define:
*the bone where it needs to play on
*which effect resource needs to be played,
*whether it needs to follow the bone all the time (Hard Attach=True) or just spawn at the bone's current location and remain there (Hard Attach=False).

Footstep keys keys:
Signal when a creatures makes a footstep by sending it's properties to code. These are then checked with the Footstep Collection data in the creature's root template.
*'''Foot ID:''' This ID is matched with the '''Footstep Property List''' in a character root template that defines which foot bone and foot step effects it is matched to.
*'''Play Hearing Effect: '''Allow code to let this footstep play a matching '''Hearing Effect''' defined by a root template it's '''Footstep Property List'''.
*'''Play Slide Effect:''' Allow code to let this footstep play a matching '''Smear Effect''' defined by a root template it's '''Footstep Property List'''.
*'''Play Sound:''' Allow code to let this footstep play a matching sound defined by a root template it's '''Footstep Weight''' and '''Sound Init Event Name'''.
*'''Play Step Effect:''' Allow code to let this footstep play a matching '''Footstep''' defined by a root template it's '''Footstep Property List'''.

Attach keys:
Attaches a bones within the hierarchy of your current rig (on which the selected animation is played upon) to any other bone of that same hierarchy. When the rig itself is parented to another rig the parent rig will account as part of the hierarchy as well! This is useful when you would want to attach a bow string to follow the hand of the archer. The following parameters needs to be set in order have this working:
*Attach Bone: the target bone
*Bone: the bone subject for attachment
*Detach Bones: Sets attach (False) or Detach (True) in order set or break an attachment.

HandSound keys:
Signals the playback of a sound event tied to a specific weapon slot: Mainhand or Offhand. Which sound event is defined in the Sound Resource ID property.

WeaponEffect keys:
Triggers an effect on your weapon when performing a particular animation, for example a swoosh (motiontrail) effect when slashing your sword.
*Effect Type: Slash (Used by all weapons except bow and staff), ElementalAttack (Used by Staves i.e. a staff weapon), Motion (...)
*Weapon: Mainhand/Offhand

Genome keys:
No active function yet.

Attack keys:
Flags where in the animation an attack is being made. At this point damage will be applied to the target. Additionally you define a direction from where the attack comes. This is done from the perspective of the attacker.

Ragdoll keys:
Allows you to transition your animation into the ragdoll physics system. This is mainly used for when a creature dies. The settings by which this done is set within the properties.
*Angular velocity Modifier:
*Duration Hard Limit:
*Duration Soft Limit:
*Hit Impulse Threshold:
*Leash Softness:
*Linear velocity Modifier:

VisualCullFlag keys:
Sets a True/False state to 4 types of visual culling to an object during that animation. Those types are: Cast Shadow, Receive Decal, Reflecting, Shadow Proxy.

__________________ 
Back to [[Panels]]

Animation set resource panel

2018-02-07T12:41:51Z

JoykaDeReyst:

My first...

2018-02-07T11:04:39Z

JoykaDeReyst: /* Full elements */

== Mods ==

[[File:Adventure_Icon.png|48px]] <big>[[My first: Adventure| Adventure]]</big>
 
[[File:Add-on_Icon.png|48px]] <big>[[My first: Add-on| Add-on]]</big>
 

== Base elements ==
Everything in the divinity engine needs one or more base elements. See these elements as building blocks for the final object. 
There are generally two big building blocks: resources and root templates. 
Resources are base elements that represent a specific type of data, such as a texture, or a model. 
Root templates are built up of resources. They represent a base template of a certain object you can place, such as a character or a chair. 

Take for example a chair. A chair needs:
* A visual model resource
* Texture resource
* A physics model resource
* A root template grouping all the resources into the specific chair you want.

{| class="wikitable"
|-
|More info on how resources work can be found here: [[Resources explanation]]
|-
|}

{| class="wikitable"
|-
|More info on how templates work can be found here: [[Templates explanation]]
|-
|}

[[File:CreateResource_C.png|32px]] <big>[[My first: Resource | Resource]] (Coming Soon)</big>
 
[[File:CreateRootTemplate_C.png|32px]] <big>[[My first: Root template | Root template]]</big>
 

== Full elements ==
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Item | Item]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Character | Character]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Animation | Animation]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Part 1: creating a terrain object|Terrain]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[Part 1: creating a new skill|Skill]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Recipe|Recipe]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Character creation class | Character creation class]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Character creation origin | Character creation origin]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Character creation race | Character creation race]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Custom portrait | Custom portrait]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Teleporter | Teleporter]]</big>
 
[[File:LarianLogo_Icon.png|32px]] <big>[[My first: Behaviour Script | (Behaviour) Script]] (charScript, itemScript, gameScript)</big>

Animation resource panel

2018-02-07T11:04:15Z

JoykaDeReyst: /* Text keys and their functions */

==The Animation Resource Panel aka Animation Previewer==
(Page in Progress!)

An Animation Resource is recognized by the orange running man in the Content Browser. To open the animation and access its meta data there are 2 ways you can do this. Both have the same outcome and technically it should not matter how you open it, but for each way has it's own advantage and disadvantage. This is illustrated in bullet A) and B) on this page.

Note that the previewer always forces itself to be highest on top. This might have the unwanted side effect that if you open another panel of any sort that this will be ordered behind the animation resource panel. This could unfortunately lead to the confusing situation where it might look that a certain panel didn't open, but simply is located BEHIND your animation resource panel.

===A) Shortcut to mushrooms.===
Double click the orange running man in your Content Browser and the animation resource panel will open in front of you. The animation previewer will now show that single animation file and all it's properties and Metadata. However the animation preview will ONLY be able to preview your animation on top of your visual if you have set a visual resource in the Preview Visual Resource ID property of your animation file. If you haven't set this, your time line will empty and your preview window will be blank. If that is the case, close the previewer, set the correct visual resource in the Sidebar and reopen the animation.

[[File:Animprev 2.jpg|1280px|frameless]]

===B) I’d say we were taking the long way around...===
You can also access your animation previewer by going through the Visual Resource that contains either the animation itself or the Animation Set Resource. To do this, 
1 - double click your Visual Resource 
2 - press Edit in the animation waterfall / or open the Default Animation tab 
3 - press Text Keys button of the animation set 
The Animation Previewer is now open and will show the entire list of all animations plugged into the animation set of your selected Visual Resource. This has the advantage you can cycle through them more quicky and that you don't need to have each animation with a predefined Preview Visual Resource ID in its properties.

[[File:Animprev 1.jpg|1280px|frameless]]

==The Animation Previewer==

Now lets go over the vital components of the Animation Previewer.

===The Preview window===
In this window your model will show and playback the selected animation. At the top shelve of the window you'll find an assort of buttons that manipulates the playback.
*<<Rotate>> : Lets you rotate your model. Alternatively your mouse buttons let you do similar navigation. Mouse click plus drag rotates the model, mouse wheel zooms in on it.
*Show Skeleton: Shows a stickfigure representation of your bone structure.
*Re-Center: Puts your model back in the center.
*WireFrame: renders your model in the wireframe of its mesh.
*Continuous: Playsback your animation continuously and indefinitally, regardless from the fact your animation is looping or not.
*Reset: Resets your preview window.
*Visual Picked: Lets your pick a different visual for your model representation, on the condition that the mesh is skinned to the same rig!

===The Animation List===
This is a list of all the animation you can preview, this list either shows a single animation or multiple animations depending on how you accessed the Animation Previewer. More on this in section A) and B) above.

===The Animation Properties===
These are the same properties as listed in the Sidebar information when you select the animation resource in the Resource Browser. A quick run through:
*'''Filename:'''
*'''GUID:''' It's unique identifier in the engine. Each time you add a resource a new GUID is assigned to the resource, and it is never the same.
*'''Name:''' The name you gave it when you imported your resource. This can be modified at any time.
*'''Type ID:''' the type you selected when you imported your resource.

*'''Active:'''
*'''Animation Name:'''
*'''Custom 1:'''
*'''Custom 2:'''
*'''Display Name:'''
*Duration:''' the total length of your animation in seconds.
*'''Initial Offset:'''
*'''Looping:''' whether or not the engine needs to loop your animation.
*'''Package Name:''' the package you selected when you imported your resource
*'''Pose Bank:''' whether your animation data is an actual animation or a collection of poses. Poses banks are currently used to put corpses in various predefined poses. An animation flagged as pose bank never animates!
*'''Preview Visual Resource ID:''' predefine which visual should be use to preview this animation.
*'''Source File:''' the file and path you've selected when you imported your resource. TIP: you can change the source file if you want to update/replace your animation to a different source so you may keep the GUID set to the original resource. This is important if your GUID is already used at places and want to maintain this link.
*'''Source File Short Name:'''
*'''Text Keys:'''

===Animation Time line===
This is the track that displays the length of the animation. The most important function of this element is to place text keys timed on your animation. To add a textkey simply right click on the track and pick a textkey from one of the presets. You can always start with the closest preset of what you need and customize it, by no means is this list a complete list of the possibilities, but merely a selection of what we perceive as most frequently used.
*blendout
*cast
*combat_comment
*dissolve
*hit
*hit_off
*hold
*loot
*move_start
*move_stop
*prepare
*pull
*relax
*shoot
*switch
*switch_off
*teleport
*vampirism
*attach
*effect
*footstep_left
*footstep_right
*sound
*swoosh
*ragdoll
*cast_shadows
*receive_decals

===Text keys and their functions===

There are different types of textkeys and each of them have their own function. Their properties will also change depending on which type you select. The color coded you see for each is how you will see them in the engine as well.

Default text driven keys:
These are the most basic of all text keys. Their function lies in sending a text based cue to code, and that text line is defined in it's name. Only text keys send their name as text cue to code! 
How the common text driven keys are used:
*'''cast:''' Works together with skill data to indicate when the impact effects should be played. Can also help delay cast effects to later in the animation.
*'''move_start:''' Works together with skill data to indicate when a rush skill should start to move a character.
*'''move_stop:''' Works together with skill data to indicate when a rush skill should stop moving a character.
*'''hold, pull, relax and shoot:''' Works together with the animation of a bow weapon to indicate how and when certain parts of it's weapon animation should play during a character it's skill and attack animaitons with a bow.
*'''switch:''' Indicates when a weapon is pulled out or stowed away during the draw and stow animations.
*'''teleport:''' Works together with skill data to indicate when a character should teleport to another place during a teleport skill
*'''vampirism:''' Works together with skill data to indicate when a source suck skill animation gets the source point.

Sound keys:
Signals the playback of a sound event. Which sound event is defined in the Sound Resource ID property.

Effects keys:
Plays an effect on top of your animation. You define:
*the bone where it needs to play on
*which effect resource needs to be played,
*whether it needs to follow the bone all the time (Hard Attach=True) or just spawn at the bone's current location and remain there (Hard Attach=False).

Footstep keys keys:
Signal when a creatures makes a footstep by sending it's properties to code. These are then checked with the Footstep Collection data in the creature's root template.
*'''Foot ID:''' This ID is matched with the '''Footstep Property List''' in a character root template that defines which foot bone and foot step effects it is matched to.
*'''Play Hearing Effect: '''Allow code to let this footstep play a matching '''Hearing Effect''' defined by a root template it's '''Footstep Property List'''.
*'''Play Slide Effect:''' Allow code to let this footstep play a matching '''Smear Effect''' defined by a root template it's '''Footstep Property List'''.
*'''Play Sound:''' Allow code to let this footstep play a matching sound defined by a root template it's '''Footstep Weight''' and '''Sound Init Event Name'''.
*'''Play Step Effect:''' Allow code to let this footstep play a matching '''Footstep''' defined by a root template it's '''Footstep Property List'''.

Attach keys:
Attaches a bones within the hierarchy of your current rig (on which the selected animation is played upon) to any other bone of that same hierarchy. When the rig itself is parented to another rig the parent rig will account as part of the hierarchy as well! This is useful when you would want to attach a bow string to follow the hand of the archer. The following parameters needs to be set in order have this working:
*Attach Bone: the target bone
*Bone: the bone subject for attachment
*Detach Bones: Sets attach (False) or Detach (True) in order set or break an attachment.

HandSound keys:
Signals the playback of a sound event tied to a specific weapon slot: Mainhand or Offhand. Which sound event is defined in the Sound Resource ID property.

WeaponEffect keys:
Triggers an effect on your weapon when performing a particular animation, for example a swoosh (motiontrail) effect when slashing your sword.
*Effect Type: Slash (Used by all weapons except bow and staff), ElementalAttack (Used by Staves i.e. a staff weapon), Motion (...)
*Weapon: Mainhand/Offhand

Genome keys:
No active function yet.

Attack keys:
Flags where in the animation an attack is being made. At this point damage will be applied to the target. Additionally you define a direction from where the attack comes. This is done from the perspective of the attacker.

Ragdoll keys:
Allows you to transition your animation into the ragdoll physics system. This is mainly used for when a creature dies. The settings by which this done is set within the properties.
*Angular velocity Modifier:
*Duration Hard Limit:
*Duration Soft Limit:
*Hit Impulse Threshold:
*Leash Softness:
*Linear velocity Modifier:

VisualCullFlag keys:
Sets a True/False state to 4 types of visual culling to an object during that animation. Those types are: Cast Shadow, Receive Decal, Reflecting, Shadow Proxy.

__________________ 
Back to [[Panels]]