Class PrimaryInputGateFactoryInput

Input parameters for creating an IPrimaryInputGate.
All fields are optional except for HostTarget.
The engine handles (Target, PromptRoot) are opaque (object) and will be interpreted by the concrete implementation (Unity, Godot, etc.).

Inheritance

object

PrimaryInputGateFactoryInput

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.InputGateway.Domain.Interfaces.Components.Factories

Assembly: Serenity.InputGateway.Application.dll

Syntax

public class PrimaryInputGateFactoryInput

Constructors

PrimaryInputGateFactoryInput(string, string, object, object, bool)

Initializes a new instance of the PrimaryInputGateFactoryInput class with the specified parameters.

Declaration

public PrimaryInputGateFactoryInput(string id, string guid, object target, object promptRoot, bool enablePromptIfAvailable)

Parameters

Type	Name	Description
string	id	Optional logical identifier (IFoundationSettings.Id).
string	guid	Optional global identifier (IFoundationSettings.Guid).
object	target	Handle to the main target of the gate (e.g., a PlayerInput).
object	promptRoot	Optional handle to a UI node/root to show the prompt.
bool	enablePromptIfAvailable	If true, the factory will try to enable/show the prompt if it exists.

Remarks

The exact interpretation depends on the concrete implementation.

Properties

EnablePromptIfAvailable

If true, the factory will try to enable/show the prompt if it exists. The exact interpretation depends on the concrete implementation.

Declaration

public bool EnablePromptIfAvailable { get; set; }

Property Value

Type	Description
bool	True to enable/show the prompt if available; otherwise, false.

Guid

Global identifier (IFoundationSettings.Guid).

Declaration

public string Guid { get; set; }

Property Value

Type	Description
string	The global identifier.

Id

Logical identifier (IFoundationSettings.Id).

Declaration

public string Id { get; set; }

Property Value

Type	Description
string	The logical identifier.

PromptRoot

Optional handle to a UI node/root to show the prompt.

Declaration

public object PromptRoot { get; set; }

Property Value

Type	Description
object	An object representing the UI node/root for the prompt.

Remarks

The exact type depends on the concrete implementation.

Target

Handle to the main target of the gate (e.g., a PlayerInput).

Declaration

public object Target { get; set; }

Property Value

Type	Description
object	An object representing the main target of the gate.

Methods

EnsureValid()

Declaration

public void EnsureValid()