Class ConfigActionGroup

A named set of actions that appear together under one heading in an input configuration screen, and that share a conflict scope.

Inheritance
object
ConfigActionGroup
Inherited Members
Namespace: Scylla.Input
Assembly: ScyllaInput.dll
Syntax
public sealed class ConfigActionGroup
Remarks

Groups usually line up with action maps, which is what the map-based constructor is for. They do not have to: a game may want a "Camera" heading gathering actions that live in several maps, or two headings carved out of one large map. Membership is therefore declared rather than assumed.

Membership is what scopes conflict detection, but only across rows: two cells on the same row are alternative bindings for one action and never conflict with each other, regardless of group. Two different rows in the same group always conflict when they share a control, because they are live at the same moment. Two rows in different groups conflict unless those groups were declared mutually exclusive through WithExclusiveGroups(params string[]). See the conflict model described on ConfigLayout for the full three-rule breakdown.

Properties

ActionIDs

Gets the individually named actions belonging to this group. May be empty. Used when a group does not correspond to a whole map.

Declaration
public IReadOnlyList<string> ActionIDs { get; }
Property Value
Type Description
IReadOnlyList<string>

ActionMapIDs

Gets the action maps whose actions belong to this group. May be empty.

Declaration
public IReadOnlyList<string> ActionMapIDs { get; }
Property Value
Type Description
IReadOnlyList<string>

DisplayName

Gets the heading shown above this group's rows.

Declaration
public string DisplayName { get; }
Property Value
Type Description
string

GroupID

Gets the stable identifier used in exclusivity declarations.

Declaration
public string GroupID { get; }
Property Value
Type Description
string