swiftlys2/docs/api/ai/
API Reference › Menu

MenuActionId

Struct
Namespace: SwiftlyS2.Shared.Menu · Assembly: SwiftlyS2.CS2.dll
public readonly record struct MenuActionId : IEquatable<MenuActionId>

Identifies a menu action within a configuration scope.

The scope maps directly onto a section of the global menu configuration file, and the name onto a key within that section.

View source

Constructors

MenuActionId(string, string)

Identifies a menu action within a configuration scope.

public MenuActionId(string Scope, string Name)
Parameters
  • ScopestringThe owning scope. This is either a menu id, or CoreScope for the built-in traversal actions every menu inherits.
  • NamestringThe action name, unique within its scope.

The scope maps directly onto a section of the global menu configuration file, and the name onto a key within that section.

Properties

Name

The action name, unique within its scope.

public string Name { get; init; }
Property Value

Scope

The owning scope. This is either a menu id, or CoreScope for the built-in traversal actions every menu inherits.

public string Scope { get; init; }
Property Value

Methods

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()
Returns
The fully qualified type name.