Definition List

Overview

A quick reference table of definitions available in YAML

Tag1	Tag2	Tag3	Tag4	Required	Description
input_path				△	Specify table input paths. Local Excel and Google Sheets URLs are supported. Required when base_type is not MultiYamlAction
	path			〇	Specify a local Excel path or Google Sheets URL
development_input_path				×	Specify additional table input paths loaded when development is True. Uses the same format as input_path
	path			〇	Specify a local Excel path or Google Sheets URL
sheet				〇	Specify the table input sheet
row				×	Specify the starting row for table input parsing
base_type				×	Specify one of the following If not defined, it defaults to Normal Normal: Standard data format NoOutput: Do not output data MultiYamlAction: Processing across multiple YAML files ManualOnly: Output only the manual
source_type				×	Specify one of the following If not defined, it defaults to Normal Normal: Standard data format 　The output method differs depending on container_type Enum: Enum output format Const: Constant output format ConstSource: Constant source output format
container_type				×	Specify one of the following If not defined, it defaults to List List: Output as an array Dictionary: Output in <key, value> format 　The first key in fields is used as the key DictionaryList: Output in <key, value[]> format 　The first key in fields is used as the key WienerDictionary: Output in WienerDictionary format 　The first key in fields is used as the key WienerDictionaryList: Output in WienerDictionaryList format 　The first key in fields is used as the key
output_path				△	Specify the output folder. Required when base_type is Normal
name				△	Specify the name used as the file name or class name. Required when base_type is Normal
group				×	When multiple definitions of the same format exist, specify a group name to generate data using a single definition
sort				×	Sort and output by the first key
encryption				×	Whether to encrypt all encryption-capable fields If true, encryptable items are encrypted regardless of the individual fields.encryption setting
template				×	Specify a template file to change the output method Valid only for PHP
manual_comment				×	Specify the YAML comment used for manual output
validate				×	Parent tag for data validation
	composite_unique			×	Duplicate check across multiple keys
		keys		〇
			key	〇
localization				×	Localization settings for this YAML
	id_key			〇	Specify the fields key that uniquely identifies each row
multi_yaml_action				△	Required when base_type is MultiYamlAction
	type			〇	Specify one of the following ValidateKeyExistsYaml: Specify it for the YAML referenced by fields.validate.key_exists_yaml ValidateKeyExistsYamlConditions: Specify it for the YAML referenced by fields.validate.key_exists_yaml_conditions ValidateUnique: Duplicate check across keys in multiple YAML files EnumConstJoin: Combine Enums/Consts and output as a single file (PHP only)
	ignores			×	Ignore list
		value		〇	Value to ignore

fields

Tag1	Tag2	Tag3	Tag4	Required	Description
key				〇	Specify the key item Used for automatically generated variable names, etc. The target specified in relation also uses this item
name				〇	Specify the Excel column name
type				〇	Specify one of the following Bool: boolean 　1, true, yes: true 　0, false, no: false Byte: 8-bit unsigned integer Short: 16-bit signed integer UShort: 16-bit unsigned integer Int: 32-bit signed integer UInt: 32-bit unsigned integer Long: 64-bit signed integer ULong: 64-bit unsigned integer Float: 32-bit floating-point Double: 64-bit floating-point String: string Enum: enum 　enum tag required DateTime: date/time Foreignkey: foreign-key reference type 　 relation tag required
enum				△	Specify the enum name Required when type is Enum Specify header.name of the YAML whose header.source_type is Enum
enum_value				×	Specify the key for the value assigned to the enum If not specified, values start from 0
enum_comment				×	Specify the key for the comment assigned to the enum
default				×	Default value to use when the cell is empty
string_format				×	Valid for PHP output and for ConstSource output in C# / UE5 If you want to adjust value-type output, specify a C# numeric format string For example, to display a float with two decimal places, enter "F2"
comment				×	Write a string comment for the key Valid for C#, UE5, and PHP
manual_comment				×	Write a description of the key Used for manual output
encryption				×	Encryption for tamper protection Enabled when true Supported when type is Byte, Short, UShort, Int, UInt, Long, ULong, Float, Double, or String
localize				×	Set to true to treat it as a localized string
manual_only				×	Set to true to not output data but use it only for the manual
obsolete				×	Marks the generated C# / UE5 accessor as obsolete
relation				×	Data reference feature (similar to Excel VLOOKUP) Required when type is Foreignkey
	yaml			〇	Specify the referenced YAML
	from			〇	Specify the lookup key in the referenced YAML
	to			〇	Specify the destination key for conversion
validate				×	Validation feature
	unique			×	Duplicate check
		enable		〇	Enabled when true
		ignores		×	Ignore list
			value	〇	Specify values to ignore
	key_exist			×	Data existence check against a single YAML file Raise an error if it does not match any item defined in the specified YAML
		yaml		〇	Specify the target YAML
		key		〇	Specify the target key
		ignores		×	Parent for the array of ignored data
			value	〇	Specify data to ignore
	key_exists_yaml			×	Data existence check across multiple YAML files Raise an error if it does not match any item defined in the specified YAML For the target YAML, set header.base_type to MultiYamlAction and header.multi_yaml_action to ValidateKeyExistsYaml
		yaml		〇	Specify the YAML for multi_yaml_action
	key_exists_yaml_conditions			×	Data existence check across multiple YAML files with parameter conditions Raise an error if it does not match any item defined in the YAML corresponding to the specified parameter For the target YAML, set header.base_type to MultiYamlAction and header.multi_yaml_action to ValidateKeyExistsYamlConditions For details, refer to key_exists_yaml_conditions
		yaml		〇	Specify the YAML for multi_yaml_action
		conditions_param_key		〇	Specify the parameter key
	enum_exists			×	Raise an error if not all specified enum items are defined
		yaml		〇	Specify the referenced YAML
		key		〇	Specify the key within the YAML
		unique		×	If unique is true, raise an error when the key value is duplicated Default is true
	range			×	Raise an error if the value is out of range
		min		×	Specify the minimum value
		max		×	Specify the maximum value
		extra_conditions		×	Parent for additional conditions
			key	〇	Specify the key used for the condition check
			value	〇	Specify the value to compare against
			equals	〇	Apply the condition when equal if true, or when not equal if false
	string_length			×	Raise an error if the string length exceeds the specified value
		line_length		〇	Specify the maximum number of characters per line
		line_value		〇	Specify the maximum number of lines

multi_yaml_action

Tag1	Required	Description
yaml	〇	Specify the target YAML
key	△	Specify the key to check. Required when header.multi_yaml_action.type is ValidateKeyExistsYaml, ValidateKeyExistsYamlConditions, or ValidateUnique
conditions_param	△	Specify the condition parameter. Required when header.multi_yaml_action.type is ValidateKeyExistsYamlConditions

Definition List

Overview

header

fields

multi_yaml_action