Update FindEntityByClassname docs (#1491)

Makes it a little bit clearer that `startEnt` isn't just an index to start searching from and that passing an invalid one can throw an error
This commit is contained in:
Impact 2021-05-21 10:45:42 +02:00 committed by GitHub
parent 4a43ac1bdd
commit e6129ab2d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -119,11 +119,11 @@ native void SlapPlayer(int client, int health=5, bool sound=true);
/**
* Searches for an entity by classname.
*
* @param startEnt The entity index after which to begin searching from.
* @param startEnt A valid entity's index after which to begin searching from.
* Use -1 to start from the first entity.
* @param classname Classname of the entity to find.
* @return Entity index >= 0 if found, -1 otherwise.
* @error Lack of mod support.
* @error Lack of mod support or invalid start entity.
*/
native int FindEntityByClassname(int startEnt, const char[] classname);