SegmentGroupCommand

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Objects >

SegmentGroupCommand

Description

A SegmentGroupCommand object (sometimes simply called a Command) specifies the state of the EST Targets and Monitors for the current command. It also lists the text of the range officer's commands and notes for the ROs.

A SegmentGroupCommand is a sub-object of RangeScripts, and SegmentGroup. In SegmentGroup a SegmentGroupCommand object is in the field DefaultCommand, and the list Commands.

In general, if a field is not listed in the Commands list, then it is pulled from SegmentGroup.DefaultCommand. If it is not listed there, then it is pulled from RangeScripts.DefaultCommand.  See each field for specifics.

Design

Name

Value Type

Description

Command

String

The text of the command the Chief Range Officer gives during this Command.

As a member of SegmentGroup.Commands list: Not required. Defaults to empty string ("").

SegmentGroup.DefaultCommand: Not required and value is ignored if included.

RangeScript.DefaultCommand: Not required and value is ignored if included.

Notes

String

Text to display to the Range Officers during this Command.

As a member of SegmentGroup.Commands list: Not required. Defaults to empty string ("").

SegmentGroup.DefaultCommand: Not required and value is ignored if included.

RangeScript.DefaultCommand: Not required and value is ignored if included.

Fade

Number

Number of seconds to keep Command shown in the EST Monitor. After which the command text fades out.

A value of 0 indicates not to display the text in the EST Monitor.

A value of -1 indicates never to remove the value.

As a member of SegmentGroup.Commands list: Not required. If not included uses value from SegmentGroup.DefaultCommand.

SegmentGroup.DefaultCommand: Not required. If not included uses value from RangeScript.DefaultCommand.

RangeScript.DefaultCommand: Required.

Must be greater than or equal to -1.

Timer

String formatted as a Time.

The Time to set the range timer. Any value greater than 0:00:00.0 will create a count-down timer. Any value that is negative or equal to 0:00:00.0 will create a count-up timer.

As a member of SegmentGroup.Commands list: Not required. Defaults to empty string ("") which will not set the range clock.

SegmentGroup.DefaultCommand: Not required and value is ignored if included.

RangeScript.DefaultCommand: Not required and value is ignored if included.

TimerCommand

String

Command issued to the timer to start, stop, pause, or display the local clock. Must be one of the following:

START

PAUSE

RESUME

STOP

CLOCK

NONE

As a member of SegmentGroup.Commands list: Not required. Defaults to NONE which will not set the range clock.

SegmentGroup.DefaultCommand: Not required and value is ignored if included.

RangeScript.DefaultCommand: Not required and value is ignored if included.

OccuresAt

String formatted as a Time.

This command is automatically issued when the range timer reaches this value.

As a member of SegmentGroup.Commands list: Not required. Defaults to empty string ("") which will not enable any automation.

SegmentGroup.DefaultCommand: Not required and value is ignored if included.

RangeScript.DefaultCommand: Not required and value is ignored if included.

GreenLight

String formatted as a Light Enabled

Indicates if the GreenLight should be on, off, or dimmed. Some ESTs do not have this capability.

As a member of SegmentGroup.Commands list: Not required. If not included uses value from SegmentGroup.DefaultCommand.

SegmentGroup.DefaultCommand: Not required. If not included uses value from RangeScript.DefaultCommand.

RangeScript.DefaultCommand: Required.

RedLight

String formatted as a Light Enabled

Indicates if the RedLight should be on, off, or dimmed. Some ESTs do not have this capability.

As a member of SegmentGroup.Commands list: Not required. If not included uses value from SegmentGroup.DefaultCommand.

SegmentGroup.DefaultCommand: Not required. If not included uses value from RangeScript.DefaultCommand.

RangeScript.DefaultCommand: Required.

TargetLight

String formatted as a Light Enabled

Indicates if the TargetLight should be on, off, or dimmed. Some ESTs do not have this capability.

As a member of SegmentGroup.Commands list: Not required. If not included uses value from SegmentGroup.DefaultCommand.

SegmentGroup.DefaultCommand: Not required. If not included uses value from RangeScript.DefaultCommand.

RangeScript.DefaultCommand: Required.

ShotAttributes

List of strings.

Attributes that are assign to each shot fired during this command. Must be one of the following:

FIRED BEFORE COMMAND START

FIRED AFTER COMMAND STOP

This list does not override the ShotAttributes from the current SegmentGroupSegment, instead they are appended to each other and both are applied.

As a member of SegmentGroup.Commands list: Not required. If not included or null uses value from SegmentGroup.DefaultCommand.

SegmentGroup.DefaultCommand: Not required. If not included or null uses value from RangeScript.DefaultCommand.

RangeScript.DefaultCommand: Required but may be empty list.

Comment

String

Internal documentation comments. All text is ignored by the system.

 


 

Note:

The Reconfigurable Rulebook and functionality will be implemented with the release of Orion Scoring System v. 3.0 (TBA)