SCORE FORMAT COLLECTION

<< Click to Display Table of Contents >>

Navigation:  Support > Reconfigurable Rulebook > Definition Types >

SCORE FORMAT COLLECTION

Description

A SCORE FORMAT COLLECTION defines a set of Score Config. Each Score Config consists of one or more Score Format key value pairs where the key is the name of the Score Format and the value is a Score Format string. Each SCORE FORMAT COLLECTION may be used for any number of COURSE OF FIRE scripts during competitions or practice. Each Score Format name included in the SCORE FORMAT COLLECTION may be used in the COURSE OF FIRE script Event or Singular Definition Objects (under ScoreFormat).

A SCORE FORMAT COLLECTION may contain any number of ScoreConfigs, but each ScoreConfig must contain the same number of Score Format key value pairs. The Score Format keys must be the same across all ScoreConfigs.

 

Definition

Name

Value Type

Description

SetName

String formatted as a Set Name

Unique identifier given to this definition within all SCORE FORMAT COLLECTION objects.

This value is controlled by Orion, users should not add this attribute to their definition files. See Set Names for more information.

Version

String formatted as a Version

The version number for this definition. User must update this value with each new version uploaded to Orion's cloud.

Required.

HierarchicalName

String formatted as a Hierarchical Name

The unique name space and proper name of this definition.

Required. The namespace must be assigned to the users account when uploaded to Orion's cloud [include link].

Type

String formatted as a Type

Identifies that this is a SCORE FORMAT COLLECTION type definition.

Required. Must be the value, "SCORE FORMAT COLLECTION".

Owner

String formatted as an Owner

The Orion Account Owner of this SCORE FORMAT COLLECTION Definition.

Required. Must be users Orion Account value.

Discipline

String formatted as a Discipline

The shooting discipline that uses this SCORE FORMAT COLLECTION

Required.

Description

String

A human readable description of this SCORE FORMAT COLLECTION object.

Not required, but strongly recommended.

ScoreFormats

List of Score Format names

The list of Score Format names that must be used as keys in each ScoreConfig

 

Required

JSONVersion

String formatted as a JSON Version

The JSON Version value for this definition.

 

Not required. Assumed to be 2020-03-31 if not included.

Discontinued

Boolean

True if this EVENT STYLE is no longer in use.

 

Not Required. Defaults to false if not included.

ScoreConfigs

List of Score Config

List of Score Config for use as options. Each Score Config must have a dictionary with keys equal to the values of ScoreFormats

Required and may not be an empty list.

 

Example

{
    "HierarchicalName":"orion:Standard Score Formats",
    "Version" : "1.1",
    "Type": "SCORE FORMAT COLLECTION",
    "Owner" : "OrionAcct000001",
    "Discipline" : "RIFLE",
    "Description" : "Includes the standard Score Format collections for both integer scoring and decimal scoring used with Rifle and Pistol. ",
    //Each ScoreformatSets.Formats need to contain an entry for each FormatName
    "ScoreFormats" : ["Events", "AccumulatedFinals", "Shots"],
    "ScoreConfigs":[
        {
            "ScoreConfigName": "Integer",
            "ScoreFormats" : {
                //Would using the {} format be easier with Python?
                "Events" : "{i} - {x}",
                "AccumulatedFinals" : "{s}",
                "Shots" : "{i}{X}({d})"
            }
        },
        {
            "ScoreConfigName": "Decimal",
            "ScoreFormats" : {
                "Events" : "{d}",
                "AccumulatedFinals" : "{d}",
                "Shots" : "{d}"
            }
        }
    ]
}


 

Note:

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