Class LaunchUrlOptions

Namespace

BSGameLib.Game.Launch

Assembly

BSGameLib.Game.dll

A game's opt-in to being started by a link: the URL scheme it registered with the system, and what tells its running copies apart. Registered in the game's services; without it the launch-URL service is inert.

public sealed record LaunchUrlOptions : IEquatable<LaunchUrlOptions>

Inheritance

object

LaunchUrlOptions

Implements

IEquatable<LaunchUrlOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LaunchUrlOptions(string, string)

A game's opt-in to being started by a link: the URL scheme it registered with the system, and what tells its running copies apart. Registered in the game's services; without it the launch-URL service is inert.

public LaunchUrlOptions(string Scheme, string InstanceKey)

Parameters

Scheme string

The scheme without its colon, e.g. odyssey. Only URLs with it are passed on.

InstanceKey string

Names the channel a second copy hands its URL to the running one through. Two copies with the same key are "the same game"; a game that can run side by side for testing, each with its own settings, should include something that differs between them, such as its settings folder.

Properties

InstanceKey

Names the channel a second copy hands its URL to the running one through. Two copies with the same key are "the same game"; a game that can run side by side for testing, each with its own settings, should include something that differs between them, such as its settings folder.

public string InstanceKey { get; init; }

Property Value

string

Scheme

The scheme without its colon, e.g. odyssey. Only URLs with it are passed on.

public string Scheme { get; init; }

Property Value

string