Difference between revisions of "DOMControllerExtended"
From Virtual World Web Wiki
(Documentation for the DOMControllerExtended class) |
(Documentation for the DOMControllerExtended class) |
||
Line 78: | Line 78: | ||
:: | :: | ||
::The speed this controller is moving (in units per second) | ::The speed this controller is moving (in units per second) | ||
+ | |||
+ | :{{CSharp|bool StrafeLocked {get; set;} // Via attribution on DOMController }} | ||
+ | :: | ||
+ | ::True if this avatar is using strafing movement | ||
===Methods=== | ===Methods=== |
Revision as of 12:48, 26 May 2017
Represents a DOMController in JavaScript
- Inherits class: DOMRenderableExtended
- This is a JavaScript visible object
Remarks [edit]
Properties
- DOMControllerExtended ActiveController {get; set;}
- Returns the DOMController that this controller should use to overide control. If none is specified this DOMController controls itself.
- long ActiveControllerID {get; set;} // Via attribution on DOMController
- The ID of an object to be set as the ActiveController (See the ActiveController property)
- DOMObjectExtended AnimationController {get; set;}
- Returns the DOMAnimationController that this controller should use for animation. If none is specified an immediate child DOMAnimationController will be used instead.
- long AnimationControllerID {get; set;} // Via attribution on DOMController
- The ID of an object to be set as the AnimationController (See the AnimationController property)
- int AnimationControllerSlot {get; set;} // Via attribution on DOMController
- Specifies which animation controller slot this avatar should be in. When an animation controller is animating multiple avatars, this number chooses your slot or role in the animation
- int BlendshapeTypeNodeID {get; set;} // Via attribution on DOMController
- The ID of another node in the same type that contains blendshape configuration
- int Direction {get; set;} // Via attribution on DOMController
- The direction this controller is facing (in degrees)
- bool GroundSitting {get; set;} // Via attribution on DOMController
- True if this avatar is sitting on the ground
- bool Grounded {get; set;} // Via attribution on DOMController
- True if this avatar is touching the ground
- bool IsParticipant {get;}
- Returns true if this object is in a persona document.
- bool Jumping {get; set;} // Via attribution on DOMController
- True if this object is jumping
- DOMTransformExtended LookAt {get; set;}
- Returns the DOMTransform object that this controller should try to “look at” if any
- string LookAtBone {get; set;} // Via attribution on DOMController
- The name of a bone in the LookAt object that this avatar should "Look At"
- long LookAtID {get; set;} // Via attribution on DOMController
- The ID of an object to be set as the LookAt target (See the LookAt property)
- ParticipantExtended Participant {get;}
- Returns the Participant object associated with the persona document in which this controller resides.
- bool PositionLocked {get; set;} // Via attribution on DOMController
- True if this avatar is position locked, meaning that it should be restricted from moving by the client application
- int Running {get; set;} // Via attribution on DOMController
- True if this avatar is running
- float Speed {get; set;} // Via attribution on DOMController
- The speed this controller is moving (in units per second)
- bool StrafeLocked {get; set;} // Via attribution on DOMController
- True if this avatar is using strafing movement
Methods
- bool AddIKTarget(DOMTransformExtended target, string goal, JSFlexibleFunction eventCallback = NULL, float positionWeight = 1.0, float positionBlendTime = 0.0, float rotationWeight = 0.0, float rotationBlendTime = 0.0, float timeout = -1.0, JSVector3 positionOffset = NULL)
- bool IsAnimationPlaying(string layerName, string animKey)
- Tests to see if the specified animation is playing
- void LockPosition(bool locked)
- Position locks this object so it can’t move or be controlled to move. Useful for playing animations where locked position is necessary.
- bool RemoveIKTarget(string goal)
- bool SetAnimationInt(string name, int value)
- Sets the specified name and integer value of a property on the first child animation controller. This is super cheesy and should be replaced.
- bool StartAnimation(string layerName, string animKey, bool looping = false, int timeOffset = 0)
- Creates a DOMAnimation node and puts it on the specified DOMAnimationLayer. This function is in the wrong place. Should be on DOMController
- bool StartAnimationWithEventCallback(string layerName, string animKey, JSFlexibleFunction animationEventCallback, bool looping = false, int timeOffset = 0)
- Creates a DOMAnimation node and puts it on the specified DOMAnimationLayer. This function is in the wrong place. Should be on DOMController
- void StartLookAt(DOMTransformExtended target, string boneName)
- Sets the LookAt and BoneName properties in a single update
- bool StopAnimation(string layerName, string animKey)
- Stops an animation from playing.
- bool StopAnimationLayer(string layerName)
- Stops all animations on the specified animation layer from playing.
- void StopLookAt()
- Clears the LookAt and BoneName properties in a single update