Add docs about conditional features in public API
This commit is contained in:
@@ -161,6 +161,7 @@ public:
|
||||
/// <summary>
|
||||
/// Determines whether this asset was marked to be deleted on unload.
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Editor.</remarks>
|
||||
API_PROPERTY() bool ShouldDeleteFileOnUnload() const;
|
||||
#endif
|
||||
|
||||
|
||||
@@ -86,6 +86,7 @@ public:
|
||||
/// <summary>
|
||||
/// Reimports asset from the source file.
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Editor.</remarks>
|
||||
API_FUNCTION() void Reimport() const;
|
||||
#endif
|
||||
|
||||
@@ -99,6 +100,7 @@ public:
|
||||
/// <summary>
|
||||
/// Gets the imported file path from the asset metadata (can be empty if not available).
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Editor.</remarks>
|
||||
API_PROPERTY() String GetImportPath() const;
|
||||
|
||||
/// <summary>
|
||||
@@ -252,6 +254,7 @@ public:
|
||||
/// <summary>
|
||||
/// Saves this asset to the storage container.
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Editor.</remarks>
|
||||
/// <param name="data">Asset data.</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>
|
||||
@@ -260,6 +263,7 @@ public:
|
||||
/// <summary>
|
||||
/// Saves this asset to the file.
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Editor.</remarks>
|
||||
/// <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="silentMode">In silent mode don't reload opened storage container that is using target file.</param>
|
||||
@@ -269,6 +273,7 @@ public:
|
||||
/// <summary>
|
||||
/// Saves asset data to the storage container. Asset unique ID is handled by auto.
|
||||
/// </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="data">Asset data.</param>
|
||||
/// <param name="silentMode">In silent mode don't reload opened storage container that is using target file.</param>
|
||||
|
||||
@@ -96,11 +96,13 @@ public:
|
||||
/// <summary>
|
||||
/// Gets the resource name.
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Development and Debug builds.</remarks>
|
||||
API_PROPERTY() StringView GetName() const;
|
||||
|
||||
/// <summary>
|
||||
/// Sets the resource name.
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Development and Debug builds.</remarks>
|
||||
API_PROPERTY() void SetName(const StringView& name);
|
||||
#endif
|
||||
|
||||
|
||||
@@ -39,6 +39,7 @@ public:
|
||||
/// <summary>
|
||||
/// Enables verbose logging of the networking runtime. Can be used to debug problems of missing RPC invoke or object replication issues.
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Development and Debug builds.</remarks>
|
||||
API_FIELD(Attributes="DebugCommand") static bool EnableLog;
|
||||
#endif
|
||||
|
||||
|
||||
@@ -295,6 +295,7 @@ public:
|
||||
/// <summary>
|
||||
/// Resets the all achievements progress for this game.
|
||||
/// </summary>
|
||||
/// <remarks>Only available in Development and Debug builds.</remarks>
|
||||
/// <param name="localUser">The local user (null if use default one).</param>
|
||||
/// <returns>True if failed, otherwise false.</returns>
|
||||
API_FUNCTION() virtual bool ResetAchievements(User* localUser = nullptr) = 0;
|
||||
|
||||
Reference in New Issue
Block a user