Add docs about conditional features in public API

This commit is contained in:
2026-04-14 16:55:43 +02:00
parent 3f55833939
commit cdf82df326
5 changed files with 10 additions and 0 deletions
+1
View File
@@ -161,6 +161,7 @@ public:
/// <summary> /// <summary>
/// Determines whether this asset was marked to be deleted on unload. /// Determines whether this asset was marked to be deleted on unload.
/// </summary> /// </summary>
/// <remarks>Only available in Editor.</remarks>
API_PROPERTY() bool ShouldDeleteFileOnUnload() const; API_PROPERTY() bool ShouldDeleteFileOnUnload() const;
#endif #endif
+5
View File
@@ -86,6 +86,7 @@ public:
/// <summary> /// <summary>
/// Reimports asset from the source file. /// Reimports asset from the source file.
/// </summary> /// </summary>
/// <remarks>Only available in Editor.</remarks>
API_FUNCTION() void Reimport() const; API_FUNCTION() void Reimport() const;
#endif #endif
@@ -99,6 +100,7 @@ public:
/// <summary> /// <summary>
/// Gets the imported file path from the asset metadata (can be empty if not available). /// Gets the imported file path from the asset metadata (can be empty if not available).
/// </summary> /// </summary>
/// <remarks>Only available in Editor.</remarks>
API_PROPERTY() String GetImportPath() const; API_PROPERTY() String GetImportPath() const;
/// <summary> /// <summary>
@@ -252,6 +254,7 @@ public:
/// <summary> /// <summary>
/// Saves this asset to the storage container. /// Saves this asset to the storage container.
/// </summary> /// </summary>
/// <remarks>Only available in Editor.</remarks>
/// <param name="data">Asset data.</param> /// <param name="data">Asset data.</param>
/// <param name="silentMode">In silent mode don't reload opened storage container that is using target file.</param> /// <param name="silentMode">In silent mode don't reload opened storage container that is using target file.</param>
/// <returns>True if failed, otherwise false.</returns> /// <returns>True if failed, otherwise false.</returns>
@@ -260,6 +263,7 @@ public:
/// <summary> /// <summary>
/// Saves this asset to the file. /// Saves this asset to the file.
/// </summary> /// </summary>
/// <remarks>Only available in Editor.</remarks>
/// <param name="data">Asset data.</param> /// <param name="data">Asset data.</param>
/// <param name="path">Asset path (will be used to override the asset or create a new one).</param> /// <param name="path">Asset path (will be used to override the asset or create a new one).</param>
/// <param name="silentMode">In silent mode don't reload opened storage container that is using target file.</param> /// <param name="silentMode">In silent mode don't reload opened storage container that is using target file.</param>
@@ -269,6 +273,7 @@ public:
/// <summary> /// <summary>
/// Saves asset data to the storage container. Asset unique ID is handled by auto. /// Saves asset data to the storage container. Asset unique ID is handled by auto.
/// </summary> /// </summary>
/// <remarks>Only available in Editor.</remarks>
/// <param name="path">Asset path (will be used to override the asset or create a new one).</param> /// <param name="path">Asset path (will be used to override the asset or create a new one).</param>
/// <param name="data">Asset data.</param> /// <param name="data">Asset data.</param>
/// <param name="silentMode">In silent mode don't reload opened storage container that is using target file.</param> /// <param name="silentMode">In silent mode don't reload opened storage container that is using target file.</param>
+2
View File
@@ -96,11 +96,13 @@ public:
/// <summary> /// <summary>
/// Gets the resource name. /// Gets the resource name.
/// </summary> /// </summary>
/// <remarks>Only available in Development and Debug builds.</remarks>
API_PROPERTY() StringView GetName() const; API_PROPERTY() StringView GetName() const;
/// <summary> /// <summary>
/// Sets the resource name. /// Sets the resource name.
/// </summary> /// </summary>
/// <remarks>Only available in Development and Debug builds.</remarks>
API_PROPERTY() void SetName(const StringView& name); API_PROPERTY() void SetName(const StringView& name);
#endif #endif
@@ -39,6 +39,7 @@ public:
/// <summary> /// <summary>
/// Enables verbose logging of the networking runtime. Can be used to debug problems of missing RPC invoke or object replication issues. /// Enables verbose logging of the networking runtime. Can be used to debug problems of missing RPC invoke or object replication issues.
/// </summary> /// </summary>
/// <remarks>Only available in Development and Debug builds.</remarks>
API_FIELD(Attributes="DebugCommand") static bool EnableLog; API_FIELD(Attributes="DebugCommand") static bool EnableLog;
#endif #endif
+1
View File
@@ -295,6 +295,7 @@ public:
/// <summary> /// <summary>
/// Resets the all achievements progress for this game. /// Resets the all achievements progress for this game.
/// </summary> /// </summary>
/// <remarks>Only available in Development and Debug builds.</remarks>
/// <param name="localUser">The local user (null if use default one).</param> /// <param name="localUser">The local user (null if use default one).</param>
/// <returns>True if failed, otherwise false.</returns> /// <returns>True if failed, otherwise false.</returns>
API_FUNCTION() virtual bool ResetAchievements(User* localUser = nullptr) = 0; API_FUNCTION() virtual bool ResetAchievements(User* localUser = nullptr) = 0;