SegmentGroupSegment

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Objects >

SegmentGroupSegment

Description

A SegmentGroupSegment object (sometimes simply called a Segment) controls how shots are labeled and scored during the segment of the match. It also specifies what capabilities the athlete has over the EST Target.

A SegmentGroupSegment is a sub-object of SegmentGroup.

Design

Name

Value Type

Description

SegmentName

String

A unique name given to this segment.

As a member of SegmentGroup.Segments list: Required and may not be an empty string ("").

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

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

NumberOfShots

Number.

The expected number of shots to be fired during this segment. The value -1 indicates shots are expected and an unlimited number of shots could be fired (i.e. sighters). The value 0 indicates not shots are expected.

As a member of SegmentGroup.Segments list: Required.

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

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

Must be a value greater than or equal to -1.

StageLabel

String

The stage label that is applied to each shot that is fired during this segment. Stage labels are usually represented by a single character ('P', 'S', 'K'). They are used to map shots to Singulars.

As a member of SegmentGroup.Segments list: Not required, if missing or empty string uses value from SegmentGroup.DefaultSegment.

SegmentGroup.DefaultSegment: Not required, if missing or empty string uses value from RangeScript.DefaultSegment.

RangeScript.DefaultSegment: Required and may not be empty string ("").

TargetDef

String formatted as a Set Name.

The TARGET definition to use to score the shot and to display to the athlete or spectators.

As a member of SegmentGroup.Segments list: Not required, if missing or empty string uses value from SegmentGroup.DefaultSegment.

SegmentGroup.DefaultSegment: Not required, if missing or empty string uses value from RangeScript.DefaultSegment.

RangeScript.DefaultSegment: Required and may not be empty string ("").

AthleteHasControl

List of strings.

List of capabilities the athlete has permission to control on the EST Target. Each value must be one of the following.

TargetLight

TargetLift or a Target Lift Function

ShotPresentation

"TargetLight" allows the athlete to control the illumination of the target light.

"TargetLift" allows the athlete to control the height of the target. See Target Lift Function for how this value interacts and has priority over the attribute TargetHeight.

"ShotPresentation" allows the athlete to control how many and which shots to display within the athlete monitor. It overrides any value set in the segment's Show field.

As a member of SegmentGroup.Segments list: Not required, if missing or null uses value from SegmentGroup.DefaultSegment.

SegmentGroup.DefaultSegment: Not required, if missing or null uses value from RangeScript.DefaultSegment.

RangeScript.DefaultSegment: Required, may be an empty list ([ ]).

NextSegments

List of strings.

List of other SegmentGroupSegments identified by the SegmentName that the athlete has the option to advance to next.

As a member of SegmentGroup.Segments list: Not required, if missing or null uses value from SegmentGroup.DefaultSegment.

SegmentGroup.DefaultSegment: Not required, if missing or null uses value from RangeScript.DefaultSegment.

RangeScript.DefaultSegment: Required, may be an empty list ([ ])

ShotAttributes

List of strings.

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

SIGHTER

STOP

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

As a member of SegmentGroup.Segments list: Not required, if missing or null uses value from SegmentGroup.DefaultSegment.

SegmentGroup.DefaultSegment: Not required, if missing or null uses value from RangeScript.DefaultSegment.

RangeScript.DefaultSegment: Required, may be an empty list ([ ])

TargetHeight

Number

Integer value, measured in millimeters, indicating how high the center of the aiming bull should be moved to. The maximum and minimum values are controlled by the EST Target.

This value is ignored if "TargetLift" is listed in AthleteHasControl. If "TargetLiftDefault" listed in AthleteHasControl then the target is moved to the height listed here, then the athlete has control to move it.

As a member of SegmentGroup.Segments list: Not required, if missing uses value from SegmentGroup.DefaultSegment.

SegmentGroup.DefaultSegment: Not required, if missing uses value from RangeScript.DefaultSegment.

RangeScript.DefaultSegment: Required.

Value must be an increment of 100.

Show

SegmentShow

Indicates what type of shots to display within the Athlete EST Monitor or Spectator EST Display.

As a member of SegmentGroup.Segments list: Not required, if missing uses value from SegmentGroup.DefaultSegment.

SegmentGroup.DefaultSegment: Not required, if missing uses value from RangeScript.DefaultSegment.

RangeScript.DefaultSegment: Not required. If missing defaults to displaying all shots.

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)