Class XareusManager
This is the facade of the Xareus framework.
Inheritance
XareusManager
Assembly: Xareus.Unity.dll
Syntax
public class XareusManager : MonoBehaviour
Fields
Instance
Declaration
public static XareusManager Instance
Field Value
runScenario
If true, the UFManager will launch the scenario engine when every module is ready.
Declaration
[Tooltip("If activated, the Manager will automatically start and run the scenario. Disable if you handle the scenario in another script")]
public bool runScenario
Field Value
scenarioUpdateTime
The max update time (in ms) of the scenario. Used if useScenarioUpdateRate is true
Declaration
[Tooltip("Maximum time (in ms) between two updates of the scenario engine if the manager is set to handle it")]
public float scenarioUpdateTime
Field Value
useScenarioUpdateTime
If true, the Xareus Manager will update the scenario engine at an almost regular rate
scenarioUpdateTime
Declaration
[Tooltip("If activated, the Manager will automatically update the scenario. Enable if you need the scenario to update on events other than realizations")]
[Obsolete("Use runScenario instead.")]
[HideInInspector]
public bool useScenarioUpdateTime
Field Value
Properties
IsApplicationStopping
Property that tells if the application is stopping (useful for OnDestroy)
Declaration
public static bool IsApplicationStopping { get; }
Property Value
Ready
Are the Xareus Manager and all its modules ready ?
Declaration
public bool Ready { get; }
Property Value
RelationEngine
Declaration
public IRelationEngine RelationEngine { get; }
Property Value
ScenarioDone
True if the scenario is done (i.e. we reached a final place on the main net)
Declaration
public bool ScenarioDone { get; }
Property Value
ScenarioEngine
Declaration
public IScenarioEngine ScenarioEngine { get; }
Property Value
instance
Declaration
[Obsolete("Use GetInstance instead.")]
public static XareusManager instance { get; }
Property Value
ufIRelationEngine
Declaration
[Obsolete("Use RelationEngine instead.")]
public IRelationEngine ufIRelationEngine { get; }
Property Value
ufIScenarioEngine
Declaration
[Obsolete("Use ScenarioEngine instead.")]
public IScenarioEngine ufIScenarioEngine { get; }
Property Value
Methods
AreAllModulesReady()
Declaration
[Obsolete("Use Ready instead.")]
public bool AreAllModulesReady()
Returns
Dispose()
Declaration
Dispose(bool)
Declaration
protected virtual void Dispose(bool disposing)
Parameters
| Type |
Name |
Description |
| bool |
disposing |
|
ExecuteRealizationIfPossible(XURealization, Action<XURealization>)
Execute a realization if possible (isRunnable)
Declaration
public bool ExecuteRealizationIfPossible(XURealization xuRealization, Action<XURealization> callback = null)
Parameters
Returns
GetInstance(Action<XareusManager>)
Returns the only instance of XareusManager once the framework is ready to be used.
Declaration
public static void GetInstance(Action<XareusManager> resultCallback)
Parameters
NextStep()
Executes a new step in the scenario engine
Declaration
OnApplicationQuit()
Know when the application is stopping
Declaration
protected void OnApplicationQuit()
ProcessScenarioOutcome(bool)
Deals with the outcome of the processing of a next step of the scenario.
This is:
intends to execute the realizations generated by the effectors of the scenario in Xareus.Unity.XareusManager.ExecuteRealizations(System.Collections.Generic.List<Xareus.Relations.Unity.XURealization>),
Declaration
public void ProcessScenarioOutcome(bool stillProgressing)
Parameters
| Type |
Name |
Description |
| bool |
stillProgressing |
true whether the scenario goes on; false otherwise
|