UI Class
Manages the client UI.
Syntax
[Sansar.Script.Interface]
public class UI : Sansar.Script.InstanceInterface
public class UI : Sansar.Script.InstanceInterface
Remarks
The client UI can be used to send messages that appear in a client UI.
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
| HintText | string . The hint text being shown to the user. | |
| [read-only] | IsValid | bool . Whether or not this interface is valid. (Inherited from Sansar.Script.InstanceInterface.) |
| [read-only] | ModalDialog | ModalDialog . The Sansar.Simulation.ModalDialog for this UI. |
Public Methods
AddProgressBar () : UIProgressBar
Add a Sansar.Simulation.UIProgressBar to the ui. |
||
CloseDetailView ()
Close any open world detail view. |
||
GetProgressBars () : IEnumerable<UIProgressBar>
Gets the progress bars that have been added to the ui. |
||
OpenDetailViewForUri (string)
Opens a window showing details for a sansar uri, giving the a user an option to travel to that location. |
||
|
override
|
ToString () : string
A string representation of this object. |
|
Member Details
AddProgressBar Method
Add a Sansar.Simulation.UIProgressBar to the ui.Syntax
[Sansar.Script.Interface]
public UIProgressBar AddProgressBar ()Returns
The newly created Sansar.Simulation.UIProgressBar.Remarks
Currently only one progress bar can be added to the screen, if one has already been added, cancel it before adding a new oneRequirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
CloseDetailView Method
Close any open world detail view.Syntax
[Sansar.Script.Interface]
public void CloseDetailView ()Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
GetProgressBars Method
Gets the progress bars that have been added to the ui.Syntax
[Sansar.Script.Interface]
public IEnumerable<UIProgressBar> GetProgressBars ()Returns
An IEnumarable collection of progress bar objects.Remarks
Documentation for this section has not yet been entered.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
HintText Property
The hint text being shown to the user.Syntax
[Sansar.Script.Interface]
public string HintText { get; set; }Value
The hint text.Remarks
Limited to 80 characters.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
ModalDialog Property
The Sansar.Simulation.ModalDialog for this UI.Syntax
[get: Sansar.Script.Interface]
public ModalDialog ModalDialog { get; }Value
The Sansar.Simulation.ModalDialog for this UI.Remarks
See ModalDialog.Show(string, string, string, Sansar.Script.ScriptBase.OperationComplete) for usage details.Requirements
Namespace: Sansar.Simulation
Assembly: Sansar.Simulation (in Sansar.Simulation.dll)
Assembly Versions: 1.1.0.0
OpenDetailViewForUri Method
Opens a window showing details for a sansar uri, giving the a user an option to travel to that location.Syntax
Parameters
- sansarUri
- The location to open the detail panel for.
Remarks
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