Class PlayURBehaviour
Inheritance
Namespace: PlayUR
Assembly: PlayUR.dll
Syntax
public abstract class PlayURBehaviour : MonoBehaviour
Properties
| Improve this Doc View SourceConfiguration
Helper: The current configuration of the plugin. Contains the current experiment, experiment group, and active elements and parameters. However it is recommended to use the CurrentExperiment, CurrentExperimentGroup, CurrentElements and CurrentParameters properties instead.
Declaration
public Configuration Configuration { get; }
Property Value
Type | Description |
---|---|
Configuration |
CurrentExperiment
Currently running experiment.
Declaration
public Experiment CurrentExperiment { get; }
Property Value
Type | Description |
---|---|
Experiment |
CurrentExperimentGroup
Currently running experiment group.
Declaration
public ExperimentGroup CurrentExperimentGroup { get; }
Property Value
Type | Description |
---|---|
ExperimentGroup |
Elements
Gets all enabled Game Elements from the current configuration.
Declaration
public List<Element> Elements { get; }
Property Value
Type | Description |
---|---|
List<Element> | a list of the active Game Elements. |
IsReady
Used to determine if the plugin is ready for normal use (i.e. the user has logged in, and a configuration has been obtained.
Declaration
public bool IsReady { get; }
Property Value
Type | Description |
---|---|
bool |
|
Parameters
Return a list of all parameters defined in the Configuration.
Declaration
public Dictionary<string, string> Parameters { get; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | The parameters in Dictionary format, keys are parameter names, values are the associated values. |
PlayURPlugin
Helper: The singleton instance of the PlayURPlugin.
Declaration
public PlayURPlugin PlayURPlugin { get; }
Property Value
Type | Description |
---|---|
PlayURPlugin |
Methods
| Improve this Doc View SourceOnReady()
Override this method to do something when the plugin is ready. Implementation is that this function is the registered callback to PlayURPlugin.instance.OnReady. This registration takes place in Start().
Declaration
public virtual void OnReady()
Start()
The standard Unity Start callback function. If overriding, must call base.Start() if you wish to use OnReady().
Declaration
public virtual void Start()