Click or drag to resize

ScriptReference Class

The ScriptReference class holds references to user callbacks that should be called when the event this ScriptReference refers to occurs. The arguments to the callbacks are of type (params object[] args).
Inheritance Hierarchy

Namespace:  Demo3D.Visuals
Assembly:  Demo3D.Core (in Demo3D.Core.dll) Version: 18.03.00
Syntax
C#
Copy
public class ScriptReference : ITaskCreator

The ScriptReference type exposes the following members.

Constructors
  NameDescription
Public methodScriptReference
Construct a new ScriptReference object.
Top
Properties
  NameDescription
Public propertyIsNull
Will a JScript function be called or not when the event occurs.
Protected propertyListenerCount
Public propertyName
The JScript function to call on the Script for this visual.
Top
Methods
  NameDescription
Public methodAddFunctionListener
Add a function that will be called when this script reference is invoked. The target visual is prepended to the script reference's original signature such that an event like OnBlocked would expect a function like this to be passed: function (target : Visual, sender : Visual, load : Visual) The functions are cleared upon each reset, removing the need for cleanup. The function list is not persisted upon model save.
Public methodClear
Remove the reference to the JScript function (set Name to an empty string).
Public methodRemoveFunctionListeners
Remove function listeners for a given target Visual.
Public methodToString
The JScript function to be called and whether there are any native listeners.
(Overrides ObjectToString.)
Top
Fields
  NameDescription
Public fieldStatic memberEmpty
An empty ScriptReference.
Protected fieldwaitForEventDelegates
Top
See Also