GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update attributes style to be consistent in engine

Browse Source
This commit is contained in:
Wojtek Figat
2025-04-12 22:09:12 +02:00
parent 74d7dd58c2
commit 59aed828f6
17 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Source/Editor/Cooker/CookingData.h
View File

@@ -142,7 +142,7 @@ API_ENUM() enum class BuildPlatform
/// <summary>
/// Windows (ARM64)
/// </summary>
API_ENUM(Attributes = "EditorDisplay(null, \"Windows ARM64\")")
API_ENUM(Attributes="EditorDisplay(null, \"Windows ARM64\")")
WindowsARM64 = 15,
};

2
Source/Engine/AI/BehaviorTreeNodes.h
View File

@@ -306,7 +306,7 @@ API_CLASS(Sealed) class FLAXENGINE_API BehaviorTreeLoopDecorator : public Behavi
API_AUTO_SERIALIZATION();
// Is the loop infinite (until failed)?
API_FIELD(Attributes = "EditorOrder(10)")
API_FIELD(Attributes="EditorOrder(10)")
bool InfiniteLoop = false;
// Amount of times to execute the node. Unused if LoopCountSelector is used or if InfiniteLoop is used.

2
Source/Engine/Audio/AudioSource.h
View File

@@ -152,7 +152,7 @@ public:
/// <summary>
/// Determines the time (in seconds) at which the audio clip starts playing if Play On Start is enabled.
/// </summary>
API_PROPERTY(Attributes = "EditorOrder(51), DefaultValue(0.0f), Limit(0, float.MaxValue, 0.01f), EditorDisplay(\"Audio Source\", \"Start Time\"), VisibleIf(nameof(PlayOnStart))")
API_PROPERTY(Attributes="EditorOrder(51), DefaultValue(0.0f), Limit(0, float.MaxValue, 0.01f), EditorDisplay(\"Audio Source\", \"Start Time\"), VisibleIf(nameof(PlayOnStart))")
FORCE_INLINE float GetStartTime() const
{
return _startTime;

4
Source/Engine/Core/Config/GraphicsSettings.h
View File

@@ -68,13 +68,13 @@ public:
/// <summary>
/// Default probes cubemap resolution (use for Environment Probes, can be overriden per-actor).
/// </summary>
API_FIELD(Attributes = "EditorOrder(1500), EditorDisplay(\"Quality\")")
API_FIELD(Attributes="EditorOrder(1500), EditorDisplay(\"Quality\")")
ProbeCubemapResolution DefaultProbeResolution = ProbeCubemapResolution::_128;
/// <summary>
/// If checked, Environment Probes will use HDR texture format. Improves quality in very bright scenes at cost of higher memory usage.
/// </summary>
API_FIELD(Attributes = "EditorOrder(1502), EditorDisplay(\"Quality\")")
API_FIELD(Attributes="EditorOrder(1502), EditorDisplay(\"Quality\")")
bool UseHDRProbes = false;
/// <summary>

4
Source/Engine/Level/Actors/Camera.h
View File

@@ -150,13 +150,13 @@ public:
/// <summary>
/// Frame rendering flags used to switch between graphics features for this camera.
/// </summary>
API_FIELD(Attributes = "EditorOrder(110), EditorDisplay(\"Camera\")")
API_FIELD(Attributes="EditorOrder(110), EditorDisplay(\"Camera\")")
ViewFlags RenderFlags = ViewFlags::DefaultGame;
/// <summary>
/// Describes frame rendering modes for this camera.
/// </summary>
API_FIELD(Attributes = "EditorOrder(120), EditorDisplay(\"Camera\")")
API_FIELD(Attributes="EditorOrder(120), EditorDisplay(\"Camera\")")
ViewMode RenderMode = ViewMode::Default;
public:

10
Source/Engine/Level/Actors/DirectionalLight.h
View File

@@ -15,7 +15,7 @@ public:
/// <summary>
/// The partitioning mode for the shadow cascades.
/// </summary>
API_FIELD(Attributes = "EditorOrder(64), DefaultValue(PartitionMode.Manual), EditorDisplay(\"Shadow\")")
API_FIELD(Attributes="EditorOrder(64), DefaultValue(PartitionMode.Manual), EditorDisplay(\"Shadow\")")
PartitionMode PartitionMode = PartitionMode::Manual;
/// <summary>
@@ -27,25 +27,25 @@ public:
/// <summary>
/// Percentage of the shadow distance used by the first cascade.
/// </summary>
API_FIELD(Attributes = "EditorOrder(66), DefaultValue(0.05f), VisibleIf(nameof(ShowCascade1)), Limit(0, 1, 0.001f), EditorDisplay(\"Shadow\")")
API_FIELD(Attributes="EditorOrder(66), DefaultValue(0.05f), VisibleIf(nameof(ShowCascade1)), Limit(0, 1, 0.001f), EditorDisplay(\"Shadow\")")
float Cascade1Spacing = 0.05f;
/// <summary>
/// Percentage of the shadow distance used by the second cascade.
/// </summary>
API_FIELD(Attributes = "EditorOrder(67), DefaultValue(0.15f), VisibleIf(nameof(ShowCascade2)), Limit(0, 1, 0.001f), EditorDisplay(\"Shadow\")")
API_FIELD(Attributes="EditorOrder(67), DefaultValue(0.15f), VisibleIf(nameof(ShowCascade2)), Limit(0, 1, 0.001f), EditorDisplay(\"Shadow\")")
float Cascade2Spacing = 0.15f;
/// <summary>
/// Percentage of the shadow distance used by the third cascade.
/// </summary>
API_FIELD(Attributes = "EditorOrder(68), DefaultValue(0.50f), VisibleIf(nameof(ShowCascade3)), Limit(0, 1, 0.001f), EditorDisplay(\"Shadow\")")
API_FIELD(Attributes="EditorOrder(68), DefaultValue(0.50f), VisibleIf(nameof(ShowCascade3)), Limit(0, 1, 0.001f), EditorDisplay(\"Shadow\")")
float Cascade3Spacing = 0.50f;
/// <summary>
/// Percentage of the shadow distance used by the fourth cascade.
/// </summary>
API_FIELD(Attributes = "EditorOrder(69), DefaultValue(1.0f), VisibleIf(nameof(ShowCascade4)), Limit(0, 1, 0.001f), EditorDisplay(\"Shadow\")")
API_FIELD(Attributes="EditorOrder(69), DefaultValue(1.0f), VisibleIf(nameof(ShowCascade4)), Limit(0, 1, 0.001f), EditorDisplay(\"Shadow\")")
float Cascade4Spacing = 1.0f;
public:

2
Source/Engine/Level/Actors/EnvironmentProbe.h
View File

@@ -42,7 +42,7 @@ public:
/// <summary>
/// The reflections texture resolution.
/// </summary>
API_FIELD(Attributes = "EditorOrder(0), EditorDisplay(\"Probe\")")
API_FIELD(Attributes="EditorOrder(0), EditorDisplay(\"Probe\")")
ProbeCubemapResolution CubemapResolution = ProbeCubemapResolution::UseGraphicsSettings;
/// <summary>

2
Source/Engine/Level/Actors/PointLight.h
View File

@@ -33,7 +33,7 @@ public:
/// <summary>
/// Whether to use physically based inverse squared distance falloff, where Radius is only clamping the light's contribution.
/// </summary>
API_FIELD(Attributes = "EditorOrder(13), DefaultValue(false), EditorDisplay(\"Light\")")
API_FIELD(Attributes="EditorOrder(13), DefaultValue(false), EditorDisplay(\"Light\")")
bool UseInverseSquaredFalloff = false;
/// <summary>

2
Source/Engine/Level/Actors/SpotLight.h
View File

@@ -32,7 +32,7 @@ public:
/// <summary>
/// Whether to use physically based inverse squared distance falloff, where Radius is only clamping the light's contribution.
/// </summary>
API_FIELD(Attributes = "EditorOrder(13), DefaultValue(false), EditorDisplay(\"Light\")")
API_FIELD(Attributes="EditorOrder(13), DefaultValue(false), EditorDisplay(\"Light\")")
bool UseInverseSquaredFalloff = false;
/// <summary>

2
Source/Engine/Navigation/NavMesh.h
View File

@@ -14,7 +14,7 @@ class NavMeshRuntime;
/// <summary>
/// The navigation mesh actor that holds a navigation data for a scene.
/// </summary>
API_CLASS(Attributes = "ActorContextMenu(\"New/Navigation/Nav Mesh\")")
API_CLASS(Attributes="ActorContextMenu(\"New/Navigation/Nav Mesh\")")
class FLAXENGINE_API NavMesh : public Actor
{
DECLARE_SCENE_OBJECT(NavMesh);

8
Source/Engine/Physics/Actors/WheeledVehicle.h
View File

@@ -53,12 +53,12 @@ API_CLASS(Attributes="ActorContextMenu(\"New/Physics/Wheeled Vehicle\"), ActorTo
/// <summary>
/// The vehicle speed.
/// </summary>
API_FIELD(Attributes = "Limit(0)") float Speed = 1000;
API_FIELD(Attributes="Limit(0)") float Speed = 1000;
/// <summary>
/// The target max steer of the speed.
/// </summary>
API_FIELD(Attributes = "Limit(0, 1)") float Steer = 1;
API_FIELD(Attributes="Limit(0, 1)") float Steer = 1;
SteerControl() = default;
@@ -242,7 +242,7 @@ API_CLASS(Attributes="ActorContextMenu(\"New/Physics/Wheeled Vehicle\"), ActorTo
/// <summary>
/// Number of gears to move to forward
/// </summary>
API_FIELD(Attributes = "Limit(1, 30)") int32 ForwardGearsRatios = 5;
API_FIELD(Attributes="Limit(1, 30)") int32 ForwardGearsRatios = 5;
/// <summary>
/// Time it takes to switch gear. Specified in seconds (s).
@@ -482,7 +482,7 @@ public:
/// <summary>
/// Gets the vehicle drive control settings.
/// </summary>
API_PROPERTY(Attributes = "EditorOrder(5), EditorDisplay(\"Vehicle\")") DriveControlSettings GetDriveControl() const;
API_PROPERTY(Attributes="EditorOrder(5), EditorDisplay(\"Vehicle\")") DriveControlSettings GetDriveControl() const;
/// <summary>
/// Sets the vehicle drive control settings.

2
Source/Engine/Physics/Joints/SphericalJoint.h
View File

@@ -29,7 +29,7 @@ DECLARE_ENUM_OPERATORS(SphericalJointFlag);
/// rotate around the anchor points, and their rotation can be limited by an elliptical cone.
/// </summary>
/// <seealso cref="Joint" />
API_CLASS(Attributes = "ActorContextMenu(\"New/Physics/Joints/Spherical Joint\"), ActorToolbox(\"Physics\")")
API_CLASS(Attributes="ActorContextMenu(\"New/Physics/Joints/Spherical Joint\"), ActorToolbox(\"Physics\")")
class FLAXENGINE_API SphericalJoint : public Joint
{
DECLARE_SCENE_OBJECT(SphericalJoint);

2
Source/Engine/Physics/PhysicalMaterial.h
View File

@@ -10,7 +10,7 @@
/// <summary>
/// Physical materials are used to define the response of a physical object when interacting dynamically with the world.
/// </summary>
API_CLASS(Attributes = "ContentContextMenu(\"New/Physics/Physical Material\")")
API_CLASS(Attributes="ContentContextMenu(\"New/Physics/Physical Material\")")
class FLAXENGINE_API PhysicalMaterial final : public ScriptingObject, public ISerializable
{
API_AUTO_SERIALIZATION();

6
Source/Engine/Platform/Android/AndroidPlatformSettings.h
View File

@@ -81,13 +81,13 @@ API_CLASS(sealed, Namespace="FlaxEditor.Content.Settings") class FLAXENGINE_API
/// <summary>
/// The minimum Android API level (eg. 20, 28, 34).
/// </summary>
API_FIELD(Attributes = "EditorOrder(20), EditorDisplay(\"General\")")
API_FIELD(Attributes="EditorOrder(20), EditorDisplay(\"General\")")
String MinimumAPILevel = TEXT("23");
/// <summary>
/// The target Android API level (eg. 20, 28, 34).
/// </summary>
API_FIELD(Attributes = "EditorOrder(30), EditorDisplay(\"General\")")
API_FIELD(Attributes="EditorOrder(30), EditorDisplay(\"General\")")
String TargetAPILevel = TEXT("33");
/// <summary>
@@ -99,7 +99,7 @@ API_CLASS(sealed, Namespace="FlaxEditor.Content.Settings") class FLAXENGINE_API
/// <summary>
/// The default screen orientation.
/// </summary>
API_FIELD(Attributes = "EditorOrder(110), EditorDisplay(\"General\")")
API_FIELD(Attributes="EditorOrder(110), EditorDisplay(\"General\")")
ScreenOrientation DefaultOrientation = ScreenOrientation::AutoRotation;
/// <summary>

2
Source/Engine/Scripting/Script.h
View File

@@ -118,7 +118,7 @@ public:
/// <summary>
/// Called every fixed framerate frame (after FixedUpdate) if object is enabled.
/// </summary>
API_FUNCTION(Attributes = "NoAnimate") virtual void OnLateFixedUpdate()
API_FUNCTION(Attributes="NoAnimate") virtual void OnLateFixedUpdate()
{
}

8
Source/Engine/Tools/ModelTool/ModelTool.h
View File

@@ -198,7 +198,7 @@ public:
API_FIELD(Attributes="EditorOrder(100), EditorDisplay(\"Geometry\"), VisibleIf(nameof(ShowGeometry))")
String CollisionMeshesPrefix = TEXT("");
// The type of collision that should be generated if the mesh has a collision prefix specified.
API_FIELD(Attributes = "EditorOrder(105), EditorDisplay(\"Geometry\"), VisibleIf(nameof(ShowGeometry))")
API_FIELD(Attributes="EditorOrder(105), EditorDisplay(\"Geometry\"), VisibleIf(nameof(ShowGeometry))")
CollisionDataType CollisionType = CollisionDataType::ConvexMesh;
public: // Transform
@@ -279,10 +279,10 @@ public:
API_FIELD(Attributes="EditorOrder(400), EditorDisplay(\"Materials\"), VisibleIf(nameof(ShowGeometry))")
bool ImportMaterials = true;
// If checked, the importer will create the model's materials as instances of a base material.
API_FIELD(Attributes = "EditorOrder(401), EditorDisplay(\"Materials\"), VisibleIf(nameof(ImportMaterials)), VisibleIf(nameof(ShowGeometry))")
API_FIELD(Attributes="EditorOrder(401), EditorDisplay(\"Materials\"), VisibleIf(nameof(ImportMaterials)), VisibleIf(nameof(ShowGeometry))")
bool ImportMaterialsAsInstances = false;
// The material used as the base material that will be instanced as the imported model's material.
API_FIELD(Attributes = "EditorOrder(402), EditorDisplay(\"Materials\"), VisibleIf(nameof(ImportMaterialsAsInstances)), VisibleIf(nameof(ShowGeometry))")
API_FIELD(Attributes="EditorOrder(402), EditorDisplay(\"Materials\"), VisibleIf(nameof(ImportMaterialsAsInstances)), VisibleIf(nameof(ShowGeometry))")
AssetReference<MaterialBase> InstanceToImportAs;
// If checked, the importer will import texture files used by the model and any embedded texture resources.
API_FIELD(Attributes="EditorOrder(410), EditorDisplay(\"Materials\"), VisibleIf(nameof(ShowGeometry))")
@@ -291,7 +291,7 @@ public:
API_FIELD(Attributes="EditorOrder(420), EditorDisplay(\"Materials\", \"Keep Overridden Materials\"), VisibleIf(nameof(ShowGeometry))")
bool RestoreMaterialsOnReimport = true;
// If checked, the importer will not reimport any material from this model which already exist in the sub-asset folder.
API_FIELD(Attributes = "EditorOrder(421), EditorDisplay(\"Materials\", \"Skip Existing Materials\"), VisibleIf(nameof(ShowGeometry))")
API_FIELD(Attributes="EditorOrder(421), EditorDisplay(\"Materials\", \"Skip Existing Materials\"), VisibleIf(nameof(ShowGeometry))")
bool SkipExistingMaterialsOnReimport = true;
public: // SDF

2
Source/Engine/Video/VideoPlayer.h
View File

@@ -76,7 +76,7 @@ public:
/// <summary>
/// Determines the time (in seconds) at which the video clip starts playing if Play On Start is enabled.
/// </summary>
API_FIELD(Attributes = "EditorOrder(35), DefaultValue(0.0f), Limit(0, float.MaxValue, 0.01f), EditorDisplay(\"Video Player\"), VisibleIf(nameof(PlayOnStart))")
API_FIELD(Attributes="EditorOrder(35), DefaultValue(0.0f), Limit(0, float.MaxValue, 0.01f), EditorDisplay(\"Video Player\"), VisibleIf(nameof(PlayOnStart))")
float StartTime = 0.0f;
/// <summary>