OpenTTD Source 20260512-master-g20b387b91f
StringParameter Struct Reference

The data required to format and validate a single parameter of a string. More...

#include <strings_type.h>

Public Member Functions

 StringParameter (StringParameterData &&data)
 StringParameter (const std::monostate &data)
 StringParameter (uint64_t data)
 StringParameter (std::string_view data)
 StringParameter (std::string &&data)
 StringParameter (const std::string &data)
 StringParameter (const ConvertibleThroughBase auto &data)
template<typename T>
 StringParameter (const T &data)
 Create a StringParameter from a scoped enum.

Data Fields

StringParameterData data
 The data of the parameter.
char32_t type
 The StringControlCode to interpret this data with when it's the first parameter, otherwise '\0'.

Detailed Description

The data required to format and validate a single parameter of a string.

Definition at line 79 of file strings_type.h.

Constructor & Destructor Documentation

◆ StringParameter() [1/8]

StringParameter::StringParameter ( StringParameterData && data)
inline

Definition at line 84 of file strings_type.h.

◆ StringParameter() [2/8]

StringParameter::StringParameter ( const std::monostate & data)
inline

Definition at line 86 of file strings_type.h.

◆ StringParameter() [3/8]

StringParameter::StringParameter ( uint64_t data)
inline

Definition at line 87 of file strings_type.h.

◆ StringParameter() [4/8]

StringParameter::StringParameter ( std::string_view data)
inline

Definition at line 89 of file strings_type.h.

◆ StringParameter() [5/8]

StringParameter::StringParameter ( std::string && data)
inline

Definition at line 90 of file strings_type.h.

◆ StringParameter() [6/8]

StringParameter::StringParameter ( const std::string & data)
inline

Definition at line 91 of file strings_type.h.

◆ StringParameter() [7/8]

StringParameter::StringParameter ( const ConvertibleThroughBase auto & data)
inline

Definition at line 93 of file strings_type.h.

◆ StringParameter() [8/8]

template<typename T>
StringParameter::StringParameter ( const T & data)
inline

Create a StringParameter from a scoped enum.

Template Parameters
Tthe type of the scoped enum.
Parameters
datathe scoped enum value.

Definition at line 101 of file strings_type.h.

References data, T, to_underlying(), and type.

Field Documentation

◆ data

StringParameterData StringParameter::data

The data of the parameter.

Definition at line 80 of file strings_type.h.

Referenced by StringParameter().

◆ type

char32_t StringParameter::type

The StringControlCode to interpret this data with when it's the first parameter, otherwise '\0'.

Definition at line 81 of file strings_type.h.

Referenced by StringParameter().


The documentation for this struct was generated from the following file: