bmlTUX

bmlTUX

  • Documentation
  • Install
  • Publication
  • Help
  • BioMotionLab
  • GitHub

›Documentation

Getting Started

  • Getting Started
  • Publication
  • Requirements
  • Overview
  • Installation

Tutorials

    Making your first experiment

    • Part 1: Tutorial Overview
    • Part 2: Creating a new Experiment
    • Part 3: Designing an Experiment
    • Part 4: Writing Runner Scripts
    • Part 5: Defining Blocks

Documentation

  • Creating an Experiment
  • Accessing GameObjects and Scripts in your Scene
  • Output
  • Setting Up Your Experiment's Behavior
  • Trial Class
  • Block Class
  • Experiment Class
  • Settings

Help

  • Troubleshooting
  • About Coroutines and IEnumerators

Advanced

  • Advanced Options
  • Recording Continuous Data
  • Using Standalone VR Headsets
  • Logging
  • Building to an Application
  • Customizing Further
  • Extras

Experiment Class

To Define custom behavior experiment, you need to create a new script and have it inherit from the Experimentclass.

Automatically generating Experiment Scripts

To define the behavior that occurs during a trial, you need to create a script that inherits from the Experiment type". The toolkit can automatically generate an Experiment script for you using a template from the "Script Helper Tool" located in the main "BML" menu.

Manually creating a Experiment Scripts

You can also create this script manually.

Similar to manually creating Blocks and Trials you’ll need to import the appropriate namespace and implement missing members

using BML_ExperimentToolkit.Scripts.ExperimentParts

public class MyExperiment : Experiment {  }  

As a rule of thumb, it’s a good idea to follow the following structure:

  1. PreMethod()

    • Initialize your experiment (calibration, etc.)
  2. PreCoroutine()

    • Show instructions, welcome screen.
    • Wait for user to do something before Experiment starts.
    • Remember to yield return. (see coroutine section in this guide)
  3. MainCoroutine()

    • No customization allowed (runs Blocks automatically)
  4. PostCoroutine()

    • Wait for user to do something after Experiment.
    • Thank you screen
    • Remember to yield return. (see coroutine section in this guide)
  5. PostMethod()

    • Finalize your experiment (confirm calibration still valid, etc.)
← Block ClassSettings →
  • Automatically generating Experiment Scripts
  • Manually creating a Experiment Scripts
bmlTUX
bmlTUX
DocumentationDownload
Facebook Open Source
Copyright © 2022 BioMotionLab (A.O. Bebko & N.F. Troje)