Extends: Reference

Card Gaming Framework global Internal Constants

This class contains constants which are referenced by various classes. This avoids cyclic dependencies.

These constants are not expected to be tweaked by developers who need to be able to upgrade the CGF.

const FocusStyle: Dictionary = {"BOTH":2,"BOTH_INFO_PANELS_ONLY":3,"SCALED":0,"VIEWPORT":1}

The focus style used by the engine

• SCALED means that the cards simply scale up when moused over in the hand
• VIEWPORT means that a larger version of the card appears when mousing over it
• BOTH means SCALED + VIEWPORT

const RunType: Dictionary = {"COST_CHECK":1,"ELSE":2,"NORMAL":0}

The types of ScriptingEngine executions we can have

• NORMAL is executing all tasks, except "is_else" tasks
• COST_CHECK is checking if the tasks which are marked as "is_cost" can be fulfilled, but does not actually execute them
• ELSE executes only tasks which are marked "is_else". This execution only Takes place when a COST_CHECK run discovers it cannot fulfil a task marked as such.

const IndexShiftPriority: Dictionary = {"HIGHER":1,"LOWER":0}

Options for displacing choosing which of the CardContainers sharing the same anchor to displace more.

• LOWER: The CardContainer with the lowest index will be displaced more
• HIGHER: The CardContainer with the highest index will be displaced more Do not mix containers using both of these settings, unless the conflicting container's OverlapShiftDirection is set to "NONE"

const OverlapShiftDirection: Dictionary = {"DOWN":2,"LEFT":3,"NONE":0,"RIGHT":4,"UP":1}

Options for displacing CardContainers sharing the same anchor

• NONE: This CardContainer will never be displaced from its position
• UP: This CardContainer will be displaced upwards. Typically used when this container is using one of the bottom anchors.
• DOWN: This CardContainer will be displaced downwards.Typically used when this container is using one of the top anchors.
• LEFT: This CardContainer will be displaced leftwards. Typically used when this container is using one of the right anchors.
• RIGHT: This CardContainer will be displaced rightwards.Typically used when this container is using one of the left anchors.