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

Update Actor docs for GetScripts to be more precise about search method

Browse Source
This commit is contained in:
Wojtek Figat
2021-02-16 11:00:08 +01:00
parent 7221f7167f
commit 537dde594d
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Source/Engine/Level/Actor.cs
View File

@@ -203,7 +203,7 @@ namespace FlaxEngine
}
/// <summary>
/// Finds the script of the given type.
/// Finds the script of the given type from this actor.
/// </summary>
/// <typeparam name="T">Type of the script to search for. Includes any scripts derived from the type.</typeparam>
/// <returns>The script or null if failed to find.</returns>
@@ -213,7 +213,7 @@ namespace FlaxEngine
}
/// <summary>
/// Tries to find the script of the given type.
/// Tries to find the script of the given type from this actor.
/// </summary>
/// <typeparam name="T">Type of the script to search for. Includes any scripts derived from the type.</typeparam>
/// <param name="script">The returned script, valid only if method returns true.</param>
@@ -240,7 +240,7 @@ namespace FlaxEngine
}
/// <summary>
/// Searches for all scripts of a specific type.
/// Searches for all scripts of a specific type from this actor.
/// </summary>
/// <typeparam name="T">Type of the scripts to search for. Includes any scripts derived from the type.</typeparam>
/// <returns>All scripts matching the specified type.</returns>

8
Source/Engine/Level/Actor.h
View File

@@ -272,14 +272,14 @@ public:
}
/// <summary>
/// Gets the script of the given type.
/// Gets the script of the given type from this actor.
/// </summary>
/// <param name="type">Type of the script to search for. Includes any scripts derived from the type.</param>
/// <returns>The script or null.</returns>
API_FUNCTION() Script* GetScript(const MClass* type) const;
/// <summary>
/// Gets the script of the given type.
/// Gets the script of the given type from this actor.
/// </summary>
/// <returns>The script or null.</returns>
template<typename T>
@@ -289,14 +289,14 @@ public:
}
/// <summary>
/// Gets the scripts of the given type.
/// Gets the scripts of the given type from this actor.
/// </summary>
/// <param name="type">Type of the script to search for. Includes any scripts derived from the type.</param>
/// <returns>The scripts.</returns>
API_FUNCTION() Array<Script*> GetScripts(const MClass* type) const;
/// <summary>
/// Gets the scripts of the given type.
/// Gets the scripts of the given type from this actor.
/// </summary>
/// <returns>The scripts.</returns>
template<typename T>