Difference between revisions of "DOMPhysicsExtended"

From Virtual World Web Wiki
Jump to: navigation, search
(Documentation for the DOMPhysicsExtended class)
 
(Documentation for the DOMPhysicsExtended class)
 
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
* '''Inherits class: [[DOMObjectExtended]]'''
+
Represents a [[DOMPhysics]] in JavaScript
 +
 
 +
*'''Inherits class: [[DOMObjectExtended]]'''
 
* This is a JavaScript visible object
 
* This is a JavaScript visible object
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMPhysicsExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>===
 
===Remarks <nowiki>[</nowiki>[{{fullurl:DOMPhysicsExtended Remarks|action=edit}} edit]<nowiki>]</nowiki>===
{{:DOMPhysicsExtended Remarks}}
+
{{#ifexist:DOMPhysicsExtended Remarks|{{:DOMPhysicsExtended Remarks}}|}}
  
 
===Properties===
 
===Properties===
:{{CSharp|bool Completed {get; set;} // Via attribution [[DOMPhysics]] }}
+
:{{CSharp|bool Completed {get; set;} // Via attribution on DOMPhysics }}
 
+
::
===Events===
+
::True if the operation has been completed
:{{CSharp|OnComplete(EventHandler<FlexibleEventArgs>)}}
+
  
 
===Methods===
 
===Methods===
:{{CSharp|void Start()}}
+
:{{CSharp|DOMPhysicsExtended OnComplete(JSFlexibleFunction callback)}}
 +
::
 +
::Allows you to bind a callback to this physics commands OnComplete event. Your callback will receive the following parameters:
 +
::  succeeded - The Actor entering the stare
 +
::This method returns the [[DOMPhysicsExtended]] object again so you can chain configuration calls
 +
 
 +
:{{CSharp|DOMPhysicsExtended Start()}}
 +
::
 +
::Asks the physics host to start carrying out the physics operation represented by this object.
  
:{{CSharp|void Stop()}}
+
:{{CSharp|DOMPhysicsExtended Stop()}}
 +
::
 +
::Asks the physics host to stop carrying out the physics operation represented by this object.
  
 
__NOTOC____NOEDITSECTION__
 
__NOTOC____NOEDITSECTION__

Latest revision as of 19:58, 3 April 2018

Represents a DOMPhysics in JavaScript

Remarks [edit]

Properties

bool Completed {get; set;} // Via attribution on DOMPhysics
True if the operation has been completed

Methods

DOMPhysicsExtended OnComplete(JSFlexibleFunction callback)
Allows you to bind a callback to this physics commands OnComplete event. Your callback will receive the following parameters:
succeeded - The Actor entering the stare
This method returns the DOMPhysicsExtended object again so you can chain configuration calls
DOMPhysicsExtended Start()
Asks the physics host to start carrying out the physics operation represented by this object.
DOMPhysicsExtended Stop()
Asks the physics host to stop carrying out the physics operation represented by this object.