xiiParticleGraphParameterDesc Struct Reference

Artist/scientist-facing parameter exposed by a particle graph node. More...

#include <ParticleGraph.h>

Public Attributes
xiiHashedString	m_sName
	Unique identifier for this parameter within its node. This is used for connecting to pins and for referencing the parameter in code. It should be unique among all parameters of the same node.
xiiString	m_sDisplayName
	User-friendly name for this parameter, shown in the editor UI. This can contain spaces and special characters, and is meant to be descriptive for artists and designers.
xiiString	m_sCategory
	Optional category for grouping parameters in the editor UI. Parameters with the same category may be shown together under a collapsible header. This is purely for organizational purposes in the editor.
xiiString	m_sTooltip
	Optional tooltip text for this parameter, shown in the editor UI when hovering over the parameter. This should provide a clear and concise description of what the parameter does and how it affects the node's behavior.
xiiVariant	m_DefaultValue
	Default value for this parameter, used when no value is set. This value will be used if the parameter is not connected to a pin or if the node's implementation chooses to use it as a fallback.
xiiVariant	m_MinValue
	Optional minimum value for this parameter, used for clamping in the editor UI. This is a hint for the editor to prevent artists from entering values that are outside of a reasonable range. The node's implementation may choose to enforce this clamp at runtime or simply use it as a guideline for the editor.
xiiVariant	m_MaxValue
	Optional maximum value for this parameter, used for clamping in the editor UI. This is a hint for the editor to prevent artists from entering values that are outside of a reasonable range. The node's implementation may choose to enforce this clamp at runtime or simply use it as a guideline for the editor.
bool	m_bAnimatable = true
	Whether this parameter can be animated over time in the editor. This is a hint for the editor to allow keyframing or curve editing for this parameter. The node's implementation may choose to support animation for this parameter or ignore this flag.
bool	m_bAdvanced = false
	Whether this parameter is considered advanced and should be hidden by default in the editor UI. This is a hint for the editor to allow artists to focus on the most commonly used parameters while still providing access to more advanced options when needed. The node's implementation may choose to support this flag by hiding advanced parameters in a collapsible section or simply use it as a guideline for the editor.

Detailed Description

Artist/scientist-facing parameter exposed by a particle graph node.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/XII/XII/Source/Engine/GraphicsCore/Particles/ParticleGraph.h