mirror of
https://github.com/godotengine/godot
synced 2024-09-05 05:28:27 +00:00
GDScript: Improve validation and documentation of @export_flags
This commit is contained in:
parent
929333fe26
commit
c8e3d8b5d5
|
@ -2654,7 +2654,7 @@
|
|||
</constant>
|
||||
<constant name="PROPERTY_HINT_ENUM" value="2" enum="PropertyHint">
|
||||
Hints that an [int] or [String] property is an enumerated value to pick in a list specified via a hint string.
|
||||
The hint string is a comma separated list of names such as [code]"Hello,Something,Else"[/code]. Whitespaces are [b]not[/b] removed from either end of a name. For integer and float properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending [code]:integer[/code] to the name, e.g. [code]"Zero,One,Three:3,Four,Six:6"[/code].
|
||||
The hint string is a comma separated list of names such as [code]"Hello,Something,Else"[/code]. Whitespaces are [b]not[/b] removed from either end of a name. For integer properties, the first name in the list has value 0, the next 1, and so on. Explicit values can also be specified by appending [code]:integer[/code] to the name, e.g. [code]"Zero,One,Three:3,Four,Six:6"[/code].
|
||||
</constant>
|
||||
<constant name="PROPERTY_HINT_ENUM_SUGGESTION" value="3" enum="PropertyHint">
|
||||
Hints that a [String] property can be an enumerated value to pick in a list specified via a hint string such as [code]"Hello,Something,Else"[/code].
|
||||
|
@ -2667,7 +2667,10 @@
|
|||
Hints that a vector property should allow its components to be linked. For example, this allows [member Vector2.x] and [member Vector2.y] to be edited together.
|
||||
</constant>
|
||||
<constant name="PROPERTY_HINT_FLAGS" value="6" enum="PropertyHint">
|
||||
Hints that an [int] property is a bitmask with named bit flags. For example, to allow toggling bits 0, 1, 2 and 4, the hint could be something like [code]"Bit0,Bit1,Bit2,,Bit4"[/code].
|
||||
Hints that an [int] property is a bitmask with named bit flags.
|
||||
The hint string is a comma separated list of names such as [code]"Bit0,Bit1,Bit2,Bit3"[/code]. Whitespaces are [b]not[/b] removed from either end of a name. The first name in the list has value 1, the next 2, then 4, 8, 16 and so on. Explicit values can also be specified by appending [code]:integer[/code] to the name, e.g. [code]"A:4,B:8,C:16"[/code]. You can also combine several flags ([code]"A:4,B:8,AB:12,C:16"[/code]).
|
||||
[b]Note:[/b] A flag value must be at least [code]1[/code] and at most [code]2 ** 32 - 1[/code].
|
||||
[b]Note:[/b] Unlike [constant PROPERTY_HINT_ENUM], the previous explicit value is not taken into account. For the hint [code]"A:16,B,C"[/code], A is 16, B is 2, C is 4.
|
||||
</constant>
|
||||
<constant name="PROPERTY_HINT_LAYERS_2D_RENDER" value="7" enum="PropertyHint">
|
||||
Hints that an [int] property is a bitmask using the optionally named 2D render layers.
|
||||
|
|
|
@ -304,7 +304,7 @@
|
|||
<return type="void" />
|
||||
<param index="0" name="names" type="String" />
|
||||
<description>
|
||||
Export an [int] or [String] property as an enumerated list of options. If the property is an [int], then the index of the value is stored, in the same order the values are provided. You can add specific identifiers for allowed values using a colon. If the property is a [String], then the value is stored.
|
||||
Export an [int] or [String] property as an enumerated list of options. If the property is an [int], then the index of the value is stored, in the same order the values are provided. You can add explicit values using a colon. If the property is a [String], then the value is stored.
|
||||
See also [constant PROPERTY_HINT_ENUM].
|
||||
[codeblock]
|
||||
@export_enum("Warrior", "Magician", "Thief") var character_class: int
|
||||
|
@ -357,6 +357,20 @@
|
|||
[codeblock]
|
||||
@export_flags("Fire", "Water", "Earth", "Wind") var spell_elements = 0
|
||||
[/codeblock]
|
||||
You can add explicit values using a colon:
|
||||
[codeblock]
|
||||
@export_flags("Self:4", "Allies:8", "Foes:16") var spell_targets = 0
|
||||
[/codeblock]
|
||||
You can also combine several flags:
|
||||
[codeblock]
|
||||
@export_flags("Self:4", "Allies:8", "Self and Allies:12", "Foes:16")
|
||||
var spell_targets = 0
|
||||
[/codeblock]
|
||||
[b]Note:[/b] A flag value must be at least [code]1[/code] and at most [code]2 ** 32 - 1[/code].
|
||||
[b]Note:[/b] Unlike [annotation @export_enum], the previous explicit value is not taken into account. In the following example, A is 16, B is 2, C is 4.
|
||||
[codeblock]
|
||||
@export_flags("A:16", "B", "C") var x
|
||||
[/codeblock]
|
||||
</description>
|
||||
</annotation>
|
||||
<annotation name="@export_flags_2d_navigation">
|
||||
|
|
|
@ -3637,15 +3637,6 @@ template <PropertyHint t_hint, Variant::Type t_type>
|
|||
bool GDScriptParser::export_annotations(const AnnotationNode *p_annotation, Node *p_node) {
|
||||
ERR_FAIL_COND_V_MSG(p_node->type != Node::VARIABLE, false, vformat(R"("%s" annotation can only be applied to variables.)", p_annotation->name));
|
||||
|
||||
{
|
||||
const int max_flags = 32;
|
||||
|
||||
if (t_hint == PropertyHint::PROPERTY_HINT_FLAGS && p_annotation->resolved_arguments.size() > max_flags) {
|
||||
push_error(vformat(R"(The argument count limit for "@export_flags" is exceeded (%d/%d).)", p_annotation->resolved_arguments.size(), max_flags), p_annotation);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
VariableNode *variable = static_cast<VariableNode *>(p_node);
|
||||
if (variable->exported) {
|
||||
push_error(vformat(R"(Annotation "%s" cannot be used with another "@export" annotation.)", p_annotation->name), p_annotation);
|
||||
|
@ -3659,14 +3650,50 @@ bool GDScriptParser::export_annotations(const AnnotationNode *p_annotation, Node
|
|||
|
||||
String hint_string;
|
||||
for (int i = 0; i < p_annotation->resolved_arguments.size(); i++) {
|
||||
if (p_annotation->name != SNAME("@export_placeholder") && String(p_annotation->resolved_arguments[i]).contains(",")) {
|
||||
push_error(vformat(R"(Argument %d of annotation "%s" contains a comma. Use separate arguments instead.)", i + 1, p_annotation->name), p_annotation->arguments[i]);
|
||||
return false;
|
||||
String arg_string = String(p_annotation->resolved_arguments[i]);
|
||||
|
||||
if (p_annotation->name != SNAME("@export_placeholder")) {
|
||||
if (arg_string.is_empty()) {
|
||||
push_error(vformat(R"(Argument %d of annotation "%s" is empty.)", i + 1, p_annotation->name), p_annotation->arguments[i]);
|
||||
return false;
|
||||
}
|
||||
if (arg_string.contains(",")) {
|
||||
push_error(vformat(R"(Argument %d of annotation "%s" contains a comma. Use separate arguments instead.)", i + 1, p_annotation->name), p_annotation->arguments[i]);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
if (p_annotation->name == SNAME("@export_flags")) {
|
||||
const int64_t max_flags = 32;
|
||||
Vector<String> t = arg_string.split(":", true, 1);
|
||||
if (t[0].is_empty()) {
|
||||
push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": Expected flag name.)", i + 1), p_annotation->arguments[i]);
|
||||
return false;
|
||||
}
|
||||
if (t.size() == 2) {
|
||||
if (t[1].is_empty()) {
|
||||
push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": Expected flag value.)", i + 1), p_annotation->arguments[i]);
|
||||
return false;
|
||||
}
|
||||
if (!t[1].is_valid_int()) {
|
||||
push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": The flag value must be a valid integer.)", i + 1), p_annotation->arguments[i]);
|
||||
return false;
|
||||
}
|
||||
int64_t value = t[1].to_int();
|
||||
if (value < 1 || value >= (1LL << max_flags)) {
|
||||
push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": The flag value must be at least 1 and at most 2 ** %d - 1.)", i + 1, max_flags), p_annotation->arguments[i]);
|
||||
return false;
|
||||
}
|
||||
} else if (i >= max_flags) {
|
||||
push_error(vformat(R"(Invalid argument %d of annotation "@export_flags": Starting from argument %d, the flag value must be specified explicitly.)", i + 1, max_flags + 1), p_annotation->arguments[i]);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
if (i > 0) {
|
||||
hint_string += ",";
|
||||
}
|
||||
hint_string += String(p_annotation->resolved_arguments[i]);
|
||||
hint_string += arg_string;
|
||||
}
|
||||
|
||||
variable->export_info.hint_string = hint_string;
|
||||
|
|
Loading…
Reference in a new issue