Class ScyllaInputDependencyProvider

Declares the external dependencies required by the Scylla Input module so that the Scylla dependency checker can report missing or outdated packages in the Unity Editor.

Inheritance

object

ScyllaInputDependencyProvider

Implements

IScyllaDependencyProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Scylla.Input.Editor

Assembly: ScyllaInput.Editor.dll

Syntax

public sealed class ScyllaInputDependencyProvider : IScyllaDependencyProvider

Remarks

This provider registers two dependencies:

The Scylla Core module (Scylla.Core.ScyllaCore) - required for the module system, event bus, logging, and all shared utilities.
The Unity Input System UPM package (com.unity.inputsystem, minimum version 1.7.0) - required for all device polling, action maps, binding persistence, and rebinding functionality.

This class is discovered automatically by the Scylla dependency-checker tooling at editor start-up; it does not need to be instantiated manually.

Properties

APIDocsURL

Gets the URL of the generated API reference for this component. When non-empty and the component appears as a Scylla-module dependency of another module, the Getting Started window renders an "API Docs" button on its row that opens this URL.

Declaration

public string APIDocsURL { get; }

Property Value

Type	Description
string	A non-null URL string. Concrete providers typically return their module's `Meta.API_DOCS_URL` constant. The default implementation returns Empty so existing providers do not need to override the member.

ComponentDescription

Gets a short human-readable description of what this component provides. Shown by the Getting Started window above the per-module dependencies table to give the user a quick summary of the component's purpose.

Declaration

public string ComponentDescription { get; }

Property Value

Type	Description
string	A non-null description string. Concrete providers typically return their module's `Meta.DESCRIPTION` constant. The default implementation returns Empty so existing providers do not need to override the member unless they want to surface a description; the editor UI hides the description block when the value is empty.

ComponentDisplayName

Gets the human-readable display name for this component, shown in the Getting Started window and dependency reports (e.g., "Scylla Input", "Scylla Camera").

Declaration

public string ComponentDisplayName { get; }

Property Value

Type	Description
string	A user-friendly name suitable for display in editor UI.

ComponentID

Gets the unique identifier for this component. For Scylla modules, this should match the module's ID as defined in ScyllaModuleID (e.g., "ScyllaInput", "ScyllaCamera"). For non-module components, use a unique, stable string that identifies the component across versions.

Declaration

public string ComponentID { get; }

Property Value

Type	Description
string	A non-null, non-empty string uniquely identifying this component.

ComponentVersion

Gets the semantic version string of this component (e.g., "1.0.0"). Used for display purposes and optional version compatibility checks.

Declaration

public string ComponentVersion { get; }

Property Value

Type	Description
string	A version string, typically following semantic versioning.

DocsURL

Gets the URL of the user-facing documentation for this component. When non-empty and the component appears as a Scylla-module dependency of another module, the Getting Started window renders a "Docs" button on its row that opens this URL.

Declaration

public string DocsURL { get; }

Property Value

Type	Description
string	A non-null URL string. Concrete providers typically return their module's `Meta.DOCS_URL` constant. The default implementation returns Empty so existing providers do not need to override the member.

Methods

GetDependencies()

Returns the complete list of dependencies required or recommended by this component. Each entry describes a single external package or Scylla module dependency, including its source type, version requirements, and installation metadata.

Declaration

public IReadOnlyList<ScyllaDependencyInfoData> GetDependencies()

Returns

Type	Description
IReadOnlyList<ScyllaDependencyInfoData>	A read-only list of Scylla.Core.ScyllaDependencyInfoData entries describing each dependency. Returns an empty list if the component has no external dependencies. Never returns `null`.

Implements

Scylla.Core.IScyllaDependencyProvider