ludus::localization::ArgumentDescriptor¶

Struct

One declared argument of a message schema, as a generated descriptor spells it.

Binding compares the fields meaningful for Type exactly: Name and Type always; Origin and MaxBytes for Text; Minimum and Maximum for Count and Number; Unknown and the ordered Values for Enum. Other fields are ignored. Views borrow storage that must outlive the bind call; generated descriptors use static storage.

Declared in modules/localization/include/ludus/localization/catalog.hpp

#include <ludus/localization/catalog.hpp>

struct ludus::localization::ArgumentDescriptor final

Fields¶

Name¶

std::string_view ludus::localization::ArgumentDescriptor::Name

Declared name, [a-z][a-z0-9_]*, at most 64 bytes.

Declared in modules/localization/include/ludus/localization/catalog.hpp

Type¶

ArgumentType ludus::localization::ArgumentDescriptor::Type {ArgumentType::Text}

Value category.

Related types: ArgumentType

Declared in modules/localization/include/ludus/localization/catalog.hpp

Origin¶

TextOrigin ludus::localization::ArgumentDescriptor::Origin {TextOrigin::Game}

Text only: producer of the text.

Related types: TextOrigin

Declared in modules/localization/include/ludus/localization/catalog.hpp

Unknown¶

UnknownPolicy ludus::localization::ArgumentDescriptor::Unknown {UnknownPolicy::Reject}

Enum only: handling of undeclared tokens.

Related types: UnknownPolicy

Declared in modules/localization/include/ludus/localization/catalog.hpp

MaxBytes¶

uint32 ludus::localization::ArgumentDescriptor::MaxBytes {}

Text only: UTF-8 byte limit, 1-4096.

Related types: uint32

Declared in modules/localization/include/ludus/localization/catalog.hpp

Minimum¶

int64 ludus::localization::ArgumentDescriptor::Minimum {}

Count/Number only: inclusive lower bound.

Related types: int64

Declared in modules/localization/include/ludus/localization/catalog.hpp

Maximum¶

int64 ludus::localization::ArgumentDescriptor::Maximum {}

Count/Number only: inclusive upper bound.

Related types: int64

Declared in modules/localization/include/ludus/localization/catalog.hpp

Values¶

std::span<const std::string_view> ludus::localization::ArgumentDescriptor::Values

Enum only: declared tokens in authored order.

Declared in modules/localization/include/ludus/localization/catalog.hpp