This repo contains the YAML files and images used to generate the property specifier documentation pages on benui.ca:
I've made them open-source so people can submit pull requests, make forks, publish their own versions of the documentation.
- name: VisibleAnywhere
incompatible: [ VisibleDefaultsOnly, VisibleInstanceOnly, EditAnywhere, EditDefaultsOnly, EditInstanceOnly ]
Properties marked with `VisibleAnywhere` are visible in the both Details Panel of Blueprint assets and the Details Panel of Blueprint instances within maps.
Note that this refers to being visible in the *Details Panel*, not visible in the *Blueprint Graph*. For that you need to use `BlueprintReadOnly`.
text: Indicates that this property is visible in all property windows, but cannot be edited. This Specifier is incompatible with the "Edit" Specifiers.
images: [ /assets/unreal/uproperty/visibility-defaults-selected.png, /assets/unreal/uproperty/visibility-instance-selected.jpg ]
comment field less like strict documentation and more
tutorial-like; talking about why you'd want to use the specifier and
|Plain text. I try to camelcase even though the name is technically case-insensitive.
|Arbitrary string I use to display related specifiers together.
|A way of categorizing specifiers further within a group.
|Valid values are
|Valid values are
|Extra information about the type. For example if the
string must be the name of a valid
UPROPERTY member variable, or
number must be an integer.
|Long free-text description on how to use the specifier. Includes Markdown formatting.
|An array of code snippets that show how the specifier is used.
|A list of specifiers that must be included for this specifier to be valid.
|Other specifiers that are worth looking at related to this context.
|A list of specifiers that are invalid when paired with this specifier.
|A list of specifiers that have the same effect to this specifier.
|A list of specifiers that have the opposite effect to this specifier.
UCLASS-specific. Whether a specifier on a parent means the child implicitly has that same specifier.
|See below for the properties within this struct.
documentation struct exists.
|Official Unreal Engine documentation that describes the specifier. Can be taken from web or source code.
|The URL from which the documentation is taken. In the case of files I include a link to the file on GitHub.
|I try to take screenshots with Unreal Engine 5.0 for consistency.