Interface IInputRebindabilityProvider

Answers whether a player may rebind a given action, and whether it should be offered at all.

Namespace: Scylla.Input

Assembly: ScyllaInput.dll

Syntax

public interface IInputRebindabilityProvider

Remarks

InputRebindability is authored per action in an actions asset's metadata sidecar, but a built player has no reliable route to that sidecar and no obligation to ship one. This interface is the seam: the rebind manager asks a provider, and a project supplies whichever provider suits how it ships its metadata.

InputMetadataRebindabilityProvider reads the sidecars directly, which suits a project that keeps them under a Resources folder. A project that generates its input constants can implement this over a compiled-in table instead and avoid loading assets at all.

A provider must answer for every action it is asked about. Returning Rebindable for an action it knows nothing about is the correct default, because an unannotated action is an ordinary one.

Methods

GetRebindability(string, string)

Returns how the named action may be rebound.

Declaration

InputRebindability GetRebindability(string mapID, string actionID)

Parameters

Type	Name	Description
string	mapID	The action map's name.
string	actionID	The action's name within that map.

Returns

Type	Description
InputRebindability	The action's rebindability, or Rebindable when the provider has nothing recorded for it.