UIProgressBar

UIProgressBar Class

Manages a progress bar UI element.

Syntax

[Sansar.Script.Interface]
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

Members

See Also: Inherited members from Sansar.Script.InstanceInterface.

Public Properties

[read-only]
IsValid bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.)

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.

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

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

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

Requirements

Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.