Show / Hide Table of Contents

Class PlayURSettings

Inheritance
object
Object
ScriptableObject
PlayURSettings
Inherited Members
ScriptableObject.SetDirty()
ScriptableObject.CreateInstance(string)
ScriptableObject.CreateInstance(Type)
ScriptableObject.CreateInstance<T>()
Namespace: PlayUR
Assembly: PlayUR.dll
Syntax
public class PlayURSettings : ScriptableObject

Fields

| Improve this Doc View Source

ResourcePath

Declaration
public const string ResourcePath = "PlayURSettings"
Field Value
Type Description
string
| Improve this Doc View Source

SettingsPath

Declaration
public const string SettingsPath = "Assets/PlayURPlugin/Resources/PlayURSettings.asset"
Field Value
Type Description
string
| Improve this Doc View Source

defaultHighScoreTablePrefab

The prefab to use that represents the highscore table. You can link this to the pre-made prefab in the PlayUR/HighScores folder, or create your own.

Declaration
public GameObject defaultHighScoreTablePrefab
Field Value
Type Description
GameObject
| Improve this Doc View Source

defaultPopupPrefab

The prefab to use that represents a dialog popup. You can link this to the pre-made prefab in the PlayUR folder, or create your own.

Declaration
public GameObject defaultPopupPrefab
Field Value
Type Description
GameObject
| Improve this Doc View Source

defaultSurveyPopupPrefab

The prefab to use that represents a survey popup window. You can link this to the pre-made prefab in the PlayUR/Survey folder, or create your own.

Declaration
public GameObject defaultSurveyPopupPrefab
Field Value
Type Description
GameObject
| Improve this Doc View Source

defaultSurveyRowPrefab

The prefab to use that represents a survey row item. You can link this to the pre-made prefab in the PlayUR/Survey folder, or create your own.

Declaration
public GameObject defaultSurveyRowPrefab
Field Value
Type Description
GameObject
| Improve this Doc View Source

desktopExperiment

The experiment to choose if useSpecificExperimentForDesktopBuild is true.

Declaration
public Experiment desktopExperiment
Field Value
Type Description
Experiment
| Improve this Doc View Source

editorElementOverrides

A set of element overrides that apply to the editor only. This allows you to test the game with different elements in the editor, without using the PlayUR back-end.

Declaration
public List<ElementOverride> editorElementOverrides
Field Value
Type Description
List<ElementOverride>
| Improve this Doc View Source

editorParameterOverrides

A set of parameter overrides that apply to the editor only. This allows you to test the game with different parameters in the editor, without using the PlayUR back-end.

Declaration
public List<ParameterOverride> editorParameterOverrides
Field Value
Type Description
List<ParameterOverride>
| Improve this Doc View Source

experimentToTestInEditor

For use in-editor only, this allows us to test the game with a specific Experiment.

Declaration
public Experiment experimentToTestInEditor
Field Value
Type Description
Experiment
| Improve this Doc View Source

forceMTurkIDInEditor

For use in-editor only, this allows us to test the game with a given Amazon Mechanical Turk ID.

Declaration
public string forceMTurkIDInEditor
Field Value
Type Description
string
| Improve this Doc View Source

forceToUseSpecificExperiment

For use in-editor only, this allows us to test the game with the Experiment defined in experimentToTestInEditor.

Declaration
public bool forceToUseSpecificExperiment
Field Value
Type Description
bool
| Improve this Doc View Source

forceToUseSpecificGroup

For use in-editor only, this allows us to test the game with the ExperimentGroup defined in groupToTestInEditor.

Declaration
public bool forceToUseSpecificGroup
Field Value
Type Description
bool
| Improve this Doc View Source

fullScreenMode

Should the app start in full screen, start windowed, or remember previous run?

Declaration
public PlayURSettings.FullScreenStartUpMode fullScreenMode
Field Value
Type Description
PlayURSettings.FullScreenStartUpMode
| Improve this Doc View Source

groupToTestInEditor

For use in-editor only, this allows us to test the game with a specific ExperimentGroup.

Declaration
public ExperimentGroup groupToTestInEditor
Field Value
Type Description
ExperimentGroup
| Improve this Doc View Source

logLevel

The minimum level to log to the console.

Declaration
public PlayURPlugin.LogLevel logLevel
Field Value
Type Description
PlayURPlugin.LogLevel
| Improve this Doc View Source

mTurkCompletionMessage

Declaration
[TextArea(3, 3)]
public string mTurkCompletionMessage
Field Value
Type Description
string
| Improve this Doc View Source

mTurkLogo

The sprite asset representing the Amazon Mechanical Turk Logo. You can link this to the logo in the PlayUR/Murk folder.

Declaration
public Sprite mTurkLogo
Field Value
Type Description
Sprite
| Improve this Doc View Source

mTurkStartMessage

Declaration
[TextArea(3, 3)]
public string mTurkStartMessage
Field Value
Type Description
string
| Improve this Doc View Source

minimumLogLevelToStore

The minimum log level to store in the PlayUR Platform. This is useful if you want to ignore certain log messages.

Declaration
public PlayURPlugin.LogLevel minimumLogLevelToStore
Field Value
Type Description
PlayURPlugin.LogLevel
| Improve this Doc View Source

mobileExperiment

The experiment to choose if useSpecificExperimentForMobileBuild is true.

Declaration
public Experiment mobileExperiment
Field Value
Type Description
Experiment
| Improve this Doc View Source

standardSessionTracking

this automagically creates a session handler (using PlayURSessionTracker), otherwise if false need to manually called StartSession etc

Declaration
public bool standardSessionTracking
Field Value
Type Description
bool
| Improve this Doc View Source

useSpecificExperimentForDesktopBuild

Override the PlayUR Platform's automatic choosing of an experiment on desktop builds by forcing the use of desktopExperiment

Declaration
public bool useSpecificExperimentForDesktopBuild
Field Value
Type Description
bool
| Improve this Doc View Source

useSpecificExperimentForMobileBuild

Override the PlayUR Platform's automatic choosing of an experiment on mobile builds by forcing the use of mobileExperiment

Declaration
public bool useSpecificExperimentForMobileBuild
Field Value
Type Description
bool

Properties

| Improve this Doc View Source

GameID

Declaration
public int GameID { get; }
Property Value
Type Description
int
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX