Difference between revisions of "DOMAnimationController"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMAnimationController class)
(Documentation for the DOMAnimationController class)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
Represents an animation controller that can affect one or more skeletons defined by [[DOMController|DOMControllers]]. A DOMAnimationController node can be placed in the DOM as a direct child of a DOMController in which case it automatically affects that animatable skeleton, or it can be placed somewhere else in the scene and referenced by setting the DOMController's AnimationControllerID property to the ID of this node. This allows multiple characters or objects to be animated by the same animation controller.
+
Represents an animation controller that can affect one or more skeletons defined by [[DOMController]]s. A DOMAnimationController node can be placed in the DOM as a direct child of a DOMController in which case it automatically affects that animatable skeleton, or it can be placed somewhere else in the scene and referenced by setting the DOMController's AnimationControllerID property to the ID of this node. This allows multiple characters or objects to be animated by the same animation controller.
  
 
*'''Inherits class: [[DOMObject]]'''
 
*'''Inherits class: [[DOMObject]]'''
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMAnimationController Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMAnimationController Remarks|action=edit}} edit]<nowiki>]</nowiki>===
{{:DOMAnimationController Remarks}}
+
{{#ifexist:DOMAnimationController Remarks|{{:DOMAnimationController Remarks}}|}}
  
 
===Properties===
 
===Properties===
 +
:{{CSharp|bool AllowJump {get; set;} }}
 +
::
 +
::True if this animation controller allows for jumping (used in conjunction with HasLocomotion)
 +
 
:{{CSharp|bool AnimatorApplyRootMotion {get; set;} }}
 
:{{CSharp|bool AnimatorApplyRootMotion {get; set;} }}
 
::
 
::
Line 14: Line 18:
 
::True if this animation controller has locomotion animations in it
 
::True if this animation controller has locomotion animations in it
  
:{{CSharp|int PaceCount {get; set;} }}
+
:{{CSharp|DOMPhysicsPace MaxPace {get; set;} }}
 
::
 
::
::Keeps track of the number of locomotion states that represent paces (walking, jogging, running, super-running) for example. This is a hacky hint to clients, so they know which forward movement states exist in this controller.
+
::The fastest locomotion state (walking, jogging, running, super-running) this animation controller has
  
 
:{{CSharp|string ResourceName {get; set;} }}
 
:{{CSharp|string ResourceName {get; set;} }}
Line 28: Line 32:
 
===Constructors===
 
===Constructors===
 
:{{CSharp|DOMAnimationController()}}
 
:{{CSharp|DOMAnimationController()}}
 +
::
 +
::Constructs a new DOMAnimationController with default settings
 +
 +
:{{CSharp|DOMAnimationController(DOMObject[] children)}}
 +
::
 +
::Constructs a new DOMAnimationController, adding children at the same time
 +
 +
:{{CSharp|DOMAnimationController(string title, DOMObject[] children)}}
 +
::
 +
::Constructs a new DOMAnimationController, setting a title and adding children at the same time
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Latest revision as of 19:21, 5 February 2019

Represents an animation controller that can affect one or more skeletons defined by DOMControllers. A DOMAnimationController node can be placed in the DOM as a direct child of a DOMController in which case it automatically affects that animatable skeleton, or it can be placed somewhere else in the scene and referenced by setting the DOMController's AnimationControllerID property to the ID of this node. This allows multiple characters or objects to be animated by the same animation controller.

Remarks [edit]

Properties

bool AllowJump {get; set;}
True if this animation controller allows for jumping (used in conjunction with HasLocomotion)
bool AnimatorApplyRootMotion {get; set;}
True if the animations in this animation controller are intended to apply root motion
bool HasLocomotion {get; set;}
True if this animation controller has locomotion animations in it
DOMPhysicsPace MaxPace {get; set;}
The fastest locomotion state (walking, jogging, running, super-running) this animation controller has
string ResourceName {get; set;}
The name of the animation controller prefab in the Unity asset bundle
ResourceValue ResourceUri {get; set;}
The ResourceValue of the Unity animation controller asset bundle

Constructors

DOMAnimationController()
Constructs a new DOMAnimationController with default settings
DOMAnimationController(DOMObject[] children)
Constructs a new DOMAnimationController, adding children at the same time
DOMAnimationController(string title, DOMObject[] children)
Constructs a new DOMAnimationController, setting a title and adding children at the same time