UIProgressBar Class
Manages a progress bar UI element.
Syntax
[Sansar.Script.Interface]
public class UIProgressBar : Sansar.Script.InstanceInterface
public class UIProgressBar : Sansar.Script.InstanceInterface
Remarks
Used for progress bars on interactions.
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Members
See Also: Inherited members from Sansar.Script.InstanceInterface.
Public Properties
Public Methods
Cancel ()
Remove a progress bar. |
||
Start (string, float, Sansar.Color)
Start a progress bar. |
||
Start (string, float, Sansar.Color, Action<Sansar.Script.OperationCompleteEvent>)
Start a progress bar. |
||
|
override
|
ToString () : string
A string representation of this object. |
|
Member Details
Cancel Method
Remove a progress bar.Syntax
[Sansar.Script.Interface]
public void Cancel ()Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Id Property
The bar's ID.Syntax
[get: Sansar.Script.Interface]
public int Id { get; }Value
Documentation for this section has not yet been entered.Remarks
This ID is only unique to this user's particular session. It is not globally unique.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Label Property
The bar's current LabelSyntax
[get: Sansar.Script.Interface]
public string Label { get; }Value
Documentation for this section has not yet been entered.Remarks
Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Start Method
Start a progress bar.Syntax
[Sansar.Script.Interface]
public void Start (string label, float durationSeconds, Sansar.Color color)Parameters
- label
- Text of the bar.
- durationSeconds
- Duration.
- color
- Color.
Returns
The internal event id for the completion event.Remarks
Call this with Sansar.Script.ScriptBase.WaitFor``3(Action<``0, ``1, ``2, Action<Sansar.Script.OperationCompleteEvent>>,``0,``1,``2) in a coroutine to block until the event is generated.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
Start Method
Start a progress bar.Syntax
[Sansar.Script.Interface]
public void Start (string label, float durationSeconds, Sansar.Color color, Action<Sansar.Script.OperationCompleteEvent> handler)Parameters
- label
- Text of the bar.
- durationSeconds
- Duration.
- color
- Color.
- handler
- Handler to be called when the event completes.
Returns
The internal event id for the completion event.Remarks
Call this with Sansar.Script.ScriptBase.WaitFor``3(Action<``0, ``1, ``2, Action<Sansar.Script.OperationCompleteEvent>>,``0,``1,``2) in a coroutine to block until the event is generated.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
ToString Method
A string representation of this object.Syntax
[Sansar.Script.Interface]
public override string ToString ()Returns
A string representation of this object.Remarks
The format of this string may change between releases.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
0 Comments