Show / Hide Table of Contents

Class PlayURBehaviour

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
PlayURBehaviour
OnlyShowIfElementIsEnabled
OnlyShowIfIsOwner
PlayURSessionTracker
AnalyticsBasic
AnalyticsCustom
SampleParameterInt
SampleParameterList
SampleParameterText
Namespace: PlayUR
Assembly: PlayUR.dll
Syntax
public abstract class PlayURBehaviour : MonoBehaviour

Properties

| Improve this Doc View Source

Configuration

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
| Improve this Doc View Source

CurrentExperiment

Currently running experiment.

Declaration
public Experiment CurrentExperiment { get; }
Property Value
Type Description
Experiment
| Improve this Doc View Source

CurrentExperimentGroup

Currently running experiment group.

Declaration
public ExperimentGroup CurrentExperimentGroup { get; }
Property Value
Type Description
ExperimentGroup
| Improve this Doc View Source

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

true if the user has logged in, and the configuration has been set. false if the user has not logged in yet, or a configuration could not be found.

| Improve this Doc View Source

PlayURPlugin

Helper: The singleton instance of the PlayURPlugin.

Declaration
public PlayURPlugin PlayURPlugin { get; }
Property Value
Type Description
PlayURPlugin

Methods

| Improve this Doc View Source

OnReady()

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()
| Improve this Doc View Source

Start()

The standard Unity Start callback function. If overriding, must call base.Start() if you wish to use OnReady().

Declaration
public virtual void Start()
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX