Container Action Creation Functions

PRActionCreateGroup(action1, action2, action3, ...)

Description

Creates and returns an action of type PRACTION_TYPE_GROUP. When an oPRAction-derived object instance plays this action, the given actions will all play simultaneously.

Parameters
  • action1 PRAction Struct

The 1st action to play in the group.

  • action2 PRAction Struct

The 2nd action to play in the group.

  • action3 PRAction Struct

The 3rd action to play in the group.

  • ... and so on.
Returns
PRAction Struct

An action that can be played by a PRAction-derived object.

PRActionCreateGroupFromArray(actionArray)

Description

Creates and returns an action of type PRACTION_TYPE_GROUP. When an oPRAction-derived object instance plays this action, the given actions found in the actionArray will all play simultaneously.

Parameters
  • actionArray PRAction Struct Array

An array containing the actions to play in the group.

Returns
PRAction Struct

An action that can be played by a PRAction-derived object.

PRActionCreateRepeat(action, repeatCount)

Description

Creates and returns an action of type PRACTION_TYPE_REPEATER. When an oPRAction-derived object instance plays this action, the given action will play the given number of repeatCount times.

Parameters
  • action PRAction Struct

The action to repeat.

  • repeatCount Int

The number of times to repeat the action.

Returns
PRAction Struct

An action that can be played by a PRAction-derived object.

PRActionCreateRepeatForever(action)

Description

Creates and returns an action of type PRACTION_TYPE_REPEATER. When an oPRAction-derived object instance plays this action, the given action will play repeatedly forever, or until stopped using the PRStopAction instance method.

Parameters
  • action PRAction Struct

The action to repeat forever.

Returns
PRAction Struct

An action that can be played by a PRAction-derived object.

PRActionCreateSequence(action1, action2, action3, ...)

Description

Creates and returns an action of type PRACTION_TYPE_SEQUENCE. When an oPRAction-derived object instance plays this action, the given actions will play one after the other in sequence beginning with the first action specified.

Parameters
  • action1 PRAction Struct

The 1st action to play in the sequence.

  • action2 PRAction Struct

The 2nd action to play in the sequence.

  • action3 PRAction Struct

The 3rd action to play in the sequence.

  • ... and so on.
Returns
PRAction Struct

An action that can be played by a PRAction-derived object.

PRActionCreateSequenceFromArray(actionArray)

Description

Creates and returns an action of type PRACTION_TYPE_SEQUENCE. When an oPRAction-derived object instance plays this action, the given actions found in the actionArray will play one after the other in sequence beginning with the action in the first array element.

Parameters
  • actionArray PRAction Struct Array

An array containing the actions to play in the sequence.

Returns
PRAction Struct

An action that can be played by a PRAction-derived object.


© 2021 Prismatic Realms, Inc. Contact

Green Hosting Badge