Scripting API

Scripting API

LocalizedArgument

Struct in Abyss.Core, from Abyss.Core.

An argument a string is filled in with: {count} in it gives way to the argument named count, written as the language writes its kind of value, and {price:0.00} in a style of its kind. Made from a name and a number, a date, a length of time or a text: ("count", coins), ("day", DateTime.Now), ("left", TimeSpan.FromMinutes(5)).

public readonly struct LocalizedArgument

Constructors

LocalizedArgument

public LocalizedArgument(string name, string value)

An argument of a name and the text it gives, as it is.

Parameters

  • name
  • value

LocalizedArgument

public LocalizedArgument(string name, string value, ArgumentKind kind)

An argument of a name, a value as text and the kind of value it is.

Parameters

  • name: The name a string writes it as.
  • value: A number as C# writes one with no culture's, 1234.5; a date as 2026-12-31T15:45:30; a length of time as its seconds; or a text.
  • kind: What kind of value it is.

Properties

Name

public string Name { get; }

The name a string writes it as, in braces.

Value

public string Value { get; }

What it gives, as text: a number as C# writes it with no culture's, which also picks a plural form.

Kind

public ArgumentKind Kind { get; }

What kind of value it is.

Operators

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, int Value) argument)

A whole number, written as the language writes numbers.

Parameters

  • argument

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, long Value) argument)

A whole number, written as the language writes numbers.

Parameters

  • argument

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, float Value) argument)

A number with a fraction, as short as writes it exactly, written as the language writes numbers.

Parameters

  • argument

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, double Value) argument)

A number with a fraction, as short as writes it exactly, written as the language writes numbers.

Parameters

  • argument

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, decimal Value) argument)

A decimal number, its places as it has them, written as the language writes numbers.

Parameters

  • argument

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, DateTime Value) argument)

A date and time of day, in the player's time: one in UTC is turned into theirs.

Parameters

  • argument

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, DateTimeOffset Value) argument)

A moment, in the player's time.

Parameters

  • argument

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, TimeSpan Value) argument)

A length of time.

Parameters

  • argument

implicit operator LocalizedArgument

public static implicit operator LocalizedArgument((string Name, string Value) argument)

A text, written as it is.

Parameters

  • argument