Support > Reconfigurable Rulebook > Definition Objects

Description

In the Reconfigurable Rulebook Event Composites are defined using the well known Composite Pattern. An Event Composite can either be an Event (that has children), or a Singular that does not have children.

An Event defines a real world event in a marksmanship competition. Includes events, stages, series, and strings. Does not includes individual shots (as these are Singulars).

Collectively, all Events in a COURSE OF FIRE must form an Event Tree. There must be one top level Event, with Event Type "EVENT." There must also be at least one Event with Event Type "STAGE." All other Event Types are optional.

Definition

There are three ways to define Events within a COURSE OF FIRE. These are EventExplicit, EventDerived, and EventExpand. When composing Events, the method used to define it is differentiated by the field Derivation.

Common Fields for all Events

Name	Value Type	Description
EventName	String	A unique name given to this Event. On Derived Events only, string interpolation may be used, e.g. "PR {}" for defining multiple similarly named Events at a time. Required and may not be blank.
EventType	String formatted as Event Type	The type of event. •Must have exactly one Event with Event Type EVENT in each COURSE OF FIRE, and must be the top level event. •Must have one or more Events with Event Type STAGE in each COURSE OF FIRE. Not required, defaults to NONE.
Derivation	String formatted as a Event Derivation	Concrete class identifier for Event. Required.
Calculation	String formatted as Event Calculation	The method to use to calculate the score of this event from the children. Not required, defaults to "SUM" if not included of if it is the wrong format.
CalculationVariables	List of CalculationVariable	Input values to the Calculation method. Not required, defaults to an empty list.
ScoreFormat	String	The name of the Score Format to use when displaying the Event during a match. Must be one of the options defined in the SCORE FORMAT COLLECTION ScoreFormats
StageStyleMapping	EventStageStyleMapping.	On Events that have a EventType == STAGE, the StageStyleMapping determines how the resulting Result COF is mapped to a STAGE STYLE. Required when EventType == STAGE. Should be null otherwise.
EventStyleMapping	EventStageStyleMapping	On Events that have a EventType == EVENT, the EventStyleMapping determines how the resulting Result COF is mapped to a EVENT STYLE. Required when EventType == EVENT. Should be null otherwise.
ResultListFormatDef	String formatted as a Set Name.	The suggested Result List Format definition to use when displaying result lists for this Event. Not required, but recommended.
RankingRuleMapping	Dictionary, key is a string, value is a string formatted as a Set Name.	Key is a ScoreConfigName or the value "DefaultDef". Value is the Ranking Rule Definition to use with this ScoreConfigName. If a ScoreConfigName is not listed, the Ranking Rule Definition specified with "DefaultDef" is used instead.
ExternalToEventTree	boolean	Indicates if this Event is outside of the Event Tree.
Comment	String	Internal documentation comments. All text is ignored by the system.

Fields Specific for Explicit Events

Explicit Events are those where the EventName and Children are explicitly defined.

Name	Value Type	Description
Derivation	String formatted as a Event Derivation	Must be EXPLICIT.
Children	List of strings.	Each string value must be another Event Name defined within the COURSE OF FIRE.

Fields Specific for Derived Events

Derived Events are those where the EventName is explicitly defined, but the Children are derived.

Name	Value Type	Description
Derivation	String formatted as a Event Derivation	Must be DERIVED.
ChildEventName	String with interpolation.	ChildEventNames expanded using ChildValues.
ChildValues	String formatted as a Value Series

Fields Specific for Expand Events

Expand Events represents multiple Events, with the EventName and Children being derived.

Name	Value Type	Description
EventName	String with interpolation.	EventNames expanded using Values.
Derivation	String formatted as a Event Derivation	Must be EXPAND.
ChildEventName	String with interpolation.
Values	String formatted as a Value Series
ChildStringSize	Integer

Note:

The Reconfigurable Rulebook and functionality will be fully implemented in the 3.0 release of Orion Scoring System. Athena and Rezults both 100% implement the Reconfigurable Rulebook.