DirectOutputR1
DirectOutput framework R1 for virtual pinball cabinets.
Go to:
Overview 
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
Built in Toys

AnalogToy

Summary

Deprecated:
The use of this toy is depreceated. Use the new AnalogAlphaToy instead.

Implementation of a generic analog toy. Implements IToy.

Sample XML

A configuration section for AnalogToy might resemble the following structure:

<AnalogToy>
<Name>Name of AnalogToy</Name>
<OutputName>Name of Output</OutputName>
</AnalogToy>

Properties

AnalogToy has the following 2 configurable properties:

Name

The name of the item.

OutputName

Name of the Output for the GenericAnalogToy.

Contactor

Summary

Deprecated:
The use of this toy is depreceated.

Contactor toy. Basicaly just a more descriptive name for a GenericDigitalToy. Implements IToy, inherits GenericDigitalToy

Sample XML

A configuration section for Contactor might resemble the following structure:

<Contactor>
<Name>Name of Contactor</Name>
<OutputName>Name of Output</OutputName>
</Contactor>

Properties

Contactor has the following 2 configurable properties:

Name

The name of the item.

OutputName

Name of the Output for the GenericDigitalToy

DigitalToy

Summary

Deprecated:
The use of this toy is depreceated.

Implementation of a generic digital toy. Implements IToy.

Sample XML

A configuration section for DigitalToy might resemble the following structure:

<DigitalToy>
<Name>Name of DigitalToy</Name>
<OutputName>Name of Output</OutputName>
</DigitalToy>

Properties

DigitalToy has the following 2 configurable properties:

Name

The name of the item.

OutputName

Name of the Output for the GenericDigitalToy

GearMotor

Summary

Deprecated:
The use of this toy is depreceated.

GearMotor toy is just a simple wrapper around the Motor toy.

Sample XML

A configuration section for GearMotor might resemble the following structure:

<GearMotor>
<Name>Name of GearMotor</Name>
<OutputName>Name of Output</OutputName>
<MaxRunTimeMs>300000</MaxRunTimeMs>
<MinPower>10</MinPower>
<MaxPower>255</MaxPower>
<KickstartPower>128</KickstartPower>
<KickstartDurationMs>100</KickstartDurationMs>
</GearMotor>

Properties

GearMotor has the following 7 configurable properties:

KickstartDurationMs

The kickstart duration in milliseconds.

KickstartPower

The kickstart power for the motor.

MaxPower

The maximum power for the motor.

MaxRunTimeMs

The max run time in milliseconds.

MinPower

The minimal power for the motor.

Name

The name of the item.

OutputName

Name of the Output for the GenericAnalogToy.

Lamp

Summary

Deprecated:
The use of this toy is depreceated. Use the AnalogAlphaToy instead.

Lamp toy.
Inherits from T:DirectOutput.Cab.Toys.Basic.AnalogToy, implements T:DirectOutput.Cab.Toys.IToy.

Sample XML

A configuration section for Lamp might resemble the following structure:

<Name>Name of Lamp</Name>
<OutputName>Name of Output</OutputName>
</Lamp>

Properties

Lamp has the following 2 configurable properties:

Name

The name of the item.

OutputName

Name of the Output for the GenericAnalogToy.

Motor

Summary

Deprecated:
The use of this toy is depreceated. A new version of this toy will be available later.

Motor toy supporting max. and min. power, max. runtime and kickstart settings.
Inherits from GenericAnalogToy, implements IToy.

Sample XML

A configuration section for Motor might resemble the following structure:

<Motor>
<Name>Name of Motor</Name>
<OutputName>Name of Output</OutputName>
<MaxRunTimeMs>300000</MaxRunTimeMs>
<MinPower>10</MinPower>
<MaxPower>255</MaxPower>
<KickstartPower>128</KickstartPower>
<KickstartDurationMs>100</KickstartDurationMs>
</Motor>

Properties

Motor has the following 7 configurable properties:

KickstartDurationMs

The kickstart duration in milliseconds.

KickstartPower

The kickstart power for the motor.

MaxPower

The maximum power for the motor.

MaxRunTimeMs

The max run time in milliseconds.

MinPower

The minimal power for the motor.

Name

The name of the item.

OutputName

Name of the Output for the GenericAnalogToy.

RGBLed

Summary

Deprecated:
The use of this toy is depreceated. Use the new RGBAToy instead.

RGB led toy controlls a multicolor led. Implement IToy, inherits Toy.

Sample XML

A configuration section for RGBLed might resemble the following structure:

<RGBLed>
<Name>Name of RGBLed</Name>
<OutputNameRed>OutputNameRed string</OutputNameRed>
<OutputNameGreen>OutputNameGreen string</OutputNameGreen>
<OutputNameBlue>OutputNameBlue string</OutputNameBlue>
</RGBLed>

Properties

RGBLed has the following 4 configurable properties:

Name

The name of the item.

OutputNameBlue

Name of the IOutput for blue.

OutputNameGreen

Name of the IOutput for green.

OutputNameRed

Name of the IOutput for red.

Shaker

Summary

Deprecated:
The use of this toy is depreceated.

Shaker toy.
This is just a simple wrapper around the motor toy.
Inherits from GenericAnalogToy, implements IToy.

Sample XML

A configuration section for Shaker might resemble the following structure:

<Shaker>
<Name>Name of Shaker</Name>
<OutputName>Name of Output</OutputName>
<MaxRunTimeMs>300000</MaxRunTimeMs>
<MinPower>10</MinPower>
<MaxPower>255</MaxPower>
<KickstartPower>128</KickstartPower>
<KickstartDurationMs>100</KickstartDurationMs>
</Shaker>

Properties

Shaker has the following 7 configurable properties:

KickstartDurationMs

The kickstart duration in milliseconds.

KickstartPower

The kickstart power for the motor.

MaxPower

The maximum power for the motor.

MaxRunTimeMs

The max run time in milliseconds.

MinPower

The minimal power for the motor.

Name

The name of the item.

OutputName

Name of the Output for the GenericAnalogToy.

AnalogAlphaToy

Summary

This toy handles analog values (0-255) in a layer structure including alpha value (0=completely transparent, 255=fully opaque) and outputs the belended result of the layers on a single output.

Sample XML

A configuration section for AnalogAlphaToy might resemble the following structure:

<AnalogAlphaToy>
<Name>Name of AnalogAlphaToy</Name>
<OutputName>Name of Output</OutputName>
</AnalogAlphaToy>

Properties

AnalogAlphaToy has the following 2 configurable properties:

Name

The name of the item.

OutputName

The name of the output.

RGBAToy

Summary

Thie RGBAToy controls RGB leds and other gadgets displaying RGB colors.

The RGBAToy has multilayer support with alpha channels. This allows the effects targeting RGBAToys to send their data to different layers. Values in a layer do also have a alpha/transparency channel which will allow us to blend the colors/values in the various layers (e.g. if a bottom layer is blue and top is a semi transparent red, you will get some mix of both or if one of the two blinks you get changing colors).
The following picture might give you a clearer idea how the layers with their alpha channels work:

LayersRGBA.png
RGBA Layers

Sample XML

A configuration section for RGBAToy might resemble the following structure:

<RGBAToy>
<Name>Name of RGBAToy</Name>
<OutputNameRed>OutputNameRed string</OutputNameRed>
<OutputNameGreen>OutputNameGreen string</OutputNameGreen>
<OutputNameBlue>OutputNameBlue string</OutputNameBlue>
</RGBAToy>

Properties

RGBAToy has the following 4 configurable properties:

Name

The name of the item.

OutputNameBlue

Name of the IOutput for blue.

OutputNameGreen

Name of the IOutput for green.

OutputNameRed

Name of the IOutput for red.

LedWizEquivalent

Summary

The LEDWizEquivalent toy is only used by the framework when ini files are used for the configuration to determine which outputs should be controled by the columns in the ini files.
Do not target this type of toy with any effects.

Sample XML

A configuration section for LedWizEquivalent might resemble the following structure:

<LedWizEquivalent>
<Name>Name of LedWizEquivalent</Name>
<Outputs>
<LedWizEquivalentOutput>
<OutputName>Name of Output</OutputName>
<LedWizEquivalentOutputNumber>0</LedWizEquivalentOutputNumber>
</LedWizEquivalentOutput>
<LedWizEquivalentOutput>
<OutputName>Name of Output</OutputName>
<LedWizEquivalentOutputNumber>0</LedWizEquivalentOutputNumber>
</LedWizEquivalentOutput>
<LedWizEquivalentOutput>
<OutputName>Name of Output</OutputName>
<LedWizEquivalentOutputNumber>0</LedWizEquivalentOutputNumber>
</LedWizEquivalentOutput>
</Outputs>
<LedWizNumber>-1</LedWizNumber>
</LedWizEquivalent>

Properties

LedWizEquivalent has the following 3 configurable properties:

LedWizNumber

The number of the virtual LedWiz resp. ini file to be matched with the LedWizEquivalentToy.

Name

The name of the item.

Outputs

The outputs of the LedWizEquivalent toy.

Nested Properties

The following nested propteries exist for Outputs:

  • LedWizEquivalentOutputNumber
    The number of the LedWizEquivalentOutput.
  • OutputName
    The name of the IOutput object beeing controlled by the LedWizEquivalenOutput.