Preset Definitions

Guides Preset Definitions

Support me on Patreon and get exclusive access to plugin features: https://www.patreon.com/jayjaywon
The below table captures the scope of each preset type for Person atoms. Please let me know if you spot any inaccuracies or missing differences.
A similar summary for non-person atoms can be found here: https://hub.virtamate.com/resources/preset-definitions-non-person-atoms.3578/

Look
(Legacy)
Pose
(Legacy)
Preset
(Legacy)
General
Preset
App
Preset
Clothing
Preset
Pose
Preset
Hair
Preset
Morph
Preset
Skin
Preset
Breast
Preset
Glute
Preset
Plugin
Preset
Animation
Preset
Atom name
✅
✅
Root Node Position
✅
✅
Pose​
Option​
Node Positions
✅
✅
Pose​
✅
Node State & Physics
✅
✅
Pose &​
Physical
✅
Bone Positions
✅
✅
Option
Scale
✅
✅
App​
✅
Clothing
✅
✅
App​
✅
✅
Hair
✅
✅
App​
✅
✅
Morphs (Appearance)
✅
✅
App​
✅
Option​
Morphs (Pose)
✅
✅
Physical​
Option
Option​
Skin (Textures and Materials
for Skin 1&2, Tongue,
Teeth & Mouth)
✅
✅
App​
✅
✅
Skin (Eyelashes, Lacrimals,
Sclera, Iris)
✅
✅
App​
✅
F Breast Physics
✅
✅
App​
✅
✅
F Glute Physics
✅
✅
App​
✅
✅
M Pectoral Physics
✅
✅
App​
✅
Misc Physics
✅
✅
App​
✅
Collision Triggers
✅
✅
Pose​
Plugins
✅
Saving: App
Loading: App & Physical​
✅
Plugin Parameters
See
note 3​
See
note 3​
✅
See
note 3​
✅
Head Audio
✅
✅
Hand Control
✅
✅
Auto Behaviours (Lip Sync)
✅
✅
Physical​
✅
Auto Behaviours
(Other)
✅
✅
App​
✅
Eye Target
✅
✅
Scene Animation
(Mocap)
✅
✅
Built in Animations
✅

Notes:
  1. Legacy Presets
    Prior to VAM v1.17 there were only three types of presets (Look, Pose and Preset) and these remain as the 'legacy' preset functions:
    1590068793849.png

    In v1.17 a more refined set of 9 Presets was introduced to allow more granular control. For the most part it is recommended these be used instead of the 'legacy' presets:
    1590069148254.png

    v1.20 introduced PluginPresets and v1.20.77 included Animation Presets (which are presets for the canned person Animator animations).
  2. General Preset options
    The General Preset has three toggle options for Appearance, Pose and Physical. For the most part these can be independently selected to determine which data items are included in the presets. However, in order to include Node State & Physics data items in a General Preset - both the Pose and Physical toggles must be selected.
  3. Plugin parameters & Legacy presets
    Plugin authors can determine which data items are stored in each of the 3 legacy preset types. Most commonly this is done by setting the storeType attribute of a JSONStorable object as follows:
C#:
_offsetZ = new JSONStorableFloat("Offset Z", 0f, -maxoffset, +maxoffset);
RegisterFloat(_offsetZ);
_offsetZ.storeType = JSONStorableParam.StoreType.Full;

The storeType can be set to Appearance, Physical, Full or Any which will result in the attribute being stored as follows:​
JSONStorableParam.StoreTypeLook
(Legacy)
Pose
(Legacy)
Preset
(Legacy)
Appearance​
✅
✅
Physical​
✅
✅
Full​
✅
Any​
✅
✅
✅
The default storeType (should the plugin author not specify) is Appearance. Therefore a common problem is that plugin settings are saved and restored with Save/Load Look - which is often not intended. If the plugin author does not want registered JSONStorables to be included in legacy Looks or Poses, then the storeType should be set to Full. With the increased prevalence of non-legacy presets this is less of a problematic issue, but many of the problems people experience with legacy presets and plugins are due to the plugin author (jncluding myself!) not correctly setting the storeType attribute.​
The alternative method for plugin authors to store data is by overriding the GetJSON() and RestoreFromJSON() methods. These methods have Appearance and Physical boolean parameters to allow the plugin author to support similar functionality for legacy preset saving/restoring of plugin data (or not).​
JayJayWon Patreon Link 2 (white).png
Author
JayJayWon
Views
36,806
Favorites
1
First release
Last update
Rating
5.00 star(s) 6 ratings

More resources from JayJayWon

Latest updates

  1. General Preset Plugins update

    Updated General Preset entries for Plugins & Plugin parameters to more accurately reflect...
  2. Animation & Pose Presets

    A couple for refinements: Added Animation Presets (introduced in 1.20.77) Refined Pose Presets...
  3. Update to reflect VAM v1.20 changes

    In VAM version 1.20, a few changes were made to the presets system: Plugin Presets were...

Latest reviews

A priceless table
Upvote 0
I remember figuring this out by creating presets of all types for single scene and watching their JSON differences :) Now we have this good tutorial, thank you very much!
Upvote 0
Thanks for the info! Very nice and readable tables as well.
Upvote 0
This is some high quality documentation, thank you!
Upvote 0
D
Thanks for info
Upvote 0
very helpful and concise overview of the definitions/differences between presets.
Upvote 0
Back
Top Bottom