read a sheet row

Name of the sheet to read.

Known languages supported by the game data format. NOTE: Not all languages that are supported by the format are valid for all editions of the game. For example, the global game client acknowledges the existence of chs and kr, however does not provide any data for them.

A filter string for selecting fields within a row.

Filters are comprised of a comma-seperated list of field paths, i.e. a,b will select the fields a and b.

Decorators may be used to modify the way a field is read. They take the form of @decorator(arguments), i.e. field@lang(en). Currently accepted decorators:

• @lang(<language>): Overrides the query's language for the decorated field. Allows one query to access data for multiple languages. language accepts any valid LanguageString.

• @as(<format>): Overrides the default output format for the decorated field.

Currently accepted formats for @as:

• raw: Prevents further processing, such as sheet relations, being performed on the decorated field. Has no effect on regular scalar fields.

• html: Formats a string field as rich HTML. Invalid on non-string fields. Output will be a valid HTML fragment, however no stability guarantees are made over the precise markup used.

Nested fields may be selected using dot notation, i.e. a.b will select the field b contained in the struct a.

Arrays must be targeted if selecting fields within them, i.e. a[].b will select all b fields of structs within the array a, however a.b will select nothing.

A filter string for selecting fields within a row.

Filters are comprised of a comma-seperated list of field paths, i.e. a,b will select the fields a and b.

Decorators may be used to modify the way a field is read. They take the form of @decorator(arguments), i.e. field@lang(en). Currently accepted decorators:

• @lang(<language>): Overrides the query's language for the decorated field. Allows one query to access data for multiple languages. language accepts any valid LanguageString.

• @as(<format>): Overrides the default output format for the decorated field.

Currently accepted formats for @as:

• raw: Prevents further processing, such as sheet relations, being performed on the decorated field. Has no effect on regular scalar fields.

• html: Formats a string field as rich HTML. Invalid on non-string fields. Output will be a valid HTML fragment, however no stability guarantees are made over the precise markup used.

Nested fields may be selected using dot notation, i.e. a.b will select the field b contained in the struct a.

Arrays must be targeted if selecting fields within them, i.e. a[].b will select all b fields of structs within the array a, however a.b will select nothing.