Add Examples for export suffix hint feature in GDScript and C#

[ShawnHardern]

In response to the discussion in godot-proposals #10498, this pull request updates the documentation to surface this functionality

[0stam]

You should add dots at the ends of paragraphs for consistency with the rest of docs. Other than that looks great, I personally didn't know the unit hints exist ;)

According to the workflow you should also squash the commits before merging.

[ShawnHardern]

You should add dots at the ends of paragraphs for consistency with the rest of docs. Other than that looks great, I personally didn't know the unit hints exist ;)

According to the workflow you should also squash the commits before merging.

@0stam Good spot😄! thanks I have pushed an update, will squash the commits too

[tetrapod00]

You may also want to mention that vector types are supported. No need to list every type, but at least float and Vector3, and maybe also int would be good. Or maybe use "scalar and vector types" or "numeric types".

Quick testing on which types can be used with this property hint:

# Unsupoorted
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var unsupported_bool : bool
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var unsupported_color : Color
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var unsupported_string : String
# Supported
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_float : float
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_int : int
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_vec2 : Vector2
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_vec2I : Vector2i
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_vec3 : Vector3
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_vec3I : Vector3i
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_vec4 : Vector4
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_vec4I : Vector4i
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_quaternion : Quaternion
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_basis : Basis
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var supported_rect2 : Rect2
# Partially supported
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var partial_transform2d : Transform2D
@export_custom(PROPERTY_HINT_NONE, "suffix:m/s\u00b2") var partial_transform3d : Transform3D

Using any unit hint at all is nonsensical for some of these types - for example the transforms or quaternions. Possibly some of these behaviors should be changed on the engine side.

[ShawnHardern]

@tetrapod00 Thank you for your awesome suggestions 👍🏻 and for taking the time to test the values! 🙌🏻. I've gone ahead and added your suggestions🎉.

[tetrapod00]

Looking at this again, using \u00b2 for the squared symbol may merit a comment or a mention in the preceding sentence. Personally I think it's fine as is - curiosity is a good teacher.

Other than that, LGTM but my approval as just a contributor is not the one that matters for getting these changes merged.

[ShawnHardern]

Hey @tetrapod00 thanks for the feedback!

I agree that it's probably a good idea to add a comment / clarification regarding the use of \u00b2, I'll wait for input from maintainers to see how they'd like to proceed.

[ShawnHardern]

Think this PR will need some guidance from the maintainers regarding if the placement of the examples for export suffix hint in the page are alright.

Additionally some guidance in relation to @tetrapod00's comment would be helpful to determine if there are any missing explanations or additional examples should be included.

[Calinou]

• Superseded by Document @export_custom and additional range hints in GDScript exports #9993. Thanks for the contribution nonetheless!