Skip to content

Clarify PROPERTY_HINT_RANGE and PROPERTY_HINT_LINK in class reference#117843

Merged
akien-mga merged 1 commit intogodotengine:masterfrom
Calinou:doc-globalscope-property-hint-range-link
Mar 26, 2026
Merged

Clarify PROPERTY_HINT_RANGE and PROPERTY_HINT_LINK in class reference#117843
akien-mga merged 1 commit intogodotengine:masterfrom
Calinou:doc-globalscope-property-hint-range-link

Conversation

@Calinou
Copy link
Copy Markdown
Member

@Calinou Calinou commented Mar 25, 2026

</constant>
<constant name="ERR_PRINTER_ON_FIRE" value="48" enum="Error">
Printer on fire error (This is an easter egg, no built-in methods return this error code).
Printer on fire error (this is an easter egg, no built-in methods return this error code).
Copy link
Copy Markdown

@dujanhung dujanhung Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line is belong to Error enum, not PropertyHint as mentioned in PR.

so instead, you should untouch this line, and open a separated PR for that.

Suggested change
Printer on fire error (this is an easter egg, no built-in methods return this error code).
Printer on fire error (This is an easter egg, no built-in methods return this error code).

Copy link
Copy Markdown
Member

@AThousandShips AThousandShips Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Irrelevant, not out of scope IMO, and not worth making a whole separate PR for

</constant>
<constant name="PROPERTY_HINT_NONE" value="0" enum="PropertyHint">
The property has no hint for the editor.
The property has no hint for the editor. However, the hint string is still read, which can be used to specify a suffix for a property that has no range limit (see [constant PROPERTY_HINT_RANGE]'s description).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should fix grammar mistake, and add a reference.

optional PS: add formatting.

Suggested change
The property has no hint for the editor. However, the hint string is still read, which can be used to specify a suffix for a property that has no range limit (see [constant PROPERTY_HINT_RANGE]'s description).
The property has no hint for the editor. However, when using this one in [annotation @GDScript.export_custom] , the [param]hint_string[/param] mandatory is [i]still[/i] allowed, to specify a suffix for a property that has no range limit (see [constant PROPERTY_HINT_RANGE]'s description).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This suggestion is not valid English nor is it correctly formatted

</constant>
<constant name="PROPERTY_HINT_RANGE" value="1" enum="PropertyHint">
Hints that an [int] or [float] property should be within a range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_less"[/code] to allow manual input going respectively above the max or below the min values.
Hints that an [int], [float], or packed/typed [Array] property containing [int] or [float] types should be within a range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_less"[/code] to allow manual input going respectively above the max or below the min values.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should fix grammar mistake.

Suggested change
Hints that an [int], [float], or packed/typed [Array] property containing [int] or [float] types should be within a range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_less"[/code] to allow manual input going respectively above the max or below the min values.
Hints that an [int], [float], or packed/typed [Array] property (whose types are [int] or [float] ) should be within a range specified via the hint string [code]"min,max"[/code] or [code]"min,max,step"[/code]. The hint string can optionally include [code]"or_greater"[/code] and/or [code]"or_less"[/code] to allow manual input going respectively above the max or below the min values.

Copy link
Copy Markdown
Member

@AThousandShips AThousandShips Mar 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original isn't incorrect I'd say, please explain (also your suggestion is incorrectly formatted), your suggestion is also incorrect grammatically, unlike the original

Copy link
Copy Markdown
Member

@AThousandShips AThousandShips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, good additions and fixes

@akien-mga akien-mga merged commit e3dc665 into godotengine:master Mar 26, 2026
7 checks passed
@akien-mga
Copy link
Copy Markdown
Member

Thanks!

youfch added a commit to youfch/godot that referenced this pull request Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants