UNLOZE/sourcemod
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated FindMap function doc.

Browse Source
This commit is contained in:
Nicholas Hastings 2015-06-27 20:04:20 -04:00
parent c383f1dc43
commit 60ac7e23d0
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
plugins/include/halflife.inc
View File

@ -97,12 +97,11 @@ enum FindMapResult
FindMap_Found, FindMap_Found,
// No match for this map name could be found. // No match for this map name could be found.
FindMap_NotFound, FindMap_NotFound,
// A fuzzy match for this mapname was found and pMapName was updated to the full name. // A fuzzy match for this map name was found.
// Ex: cp_dust -> cp_dustbowl // Ex: cp_dust -> cp_dustbowl, c1m1 -> c1m1_hotel
// Supported on many newer games. // Only supported for maps that the engine knows about. (This excludes workshop maps on Orangebox).
FindMap_FuzzyMatch, FindMap_FuzzyMatch,
// A match for this map name was found, and the map name was updated to the canonical version of the // A non-canonical match for this map name was found.
// name.
// Ex: workshop/1234 -> workshop/cp_qualified_name.ugc1234 // Ex: workshop/1234 -> workshop/cp_qualified_name.ugc1234
// Only supported on "Orangebox" games with workshop support. // Only supported on "Orangebox" games with workshop support.
FindMap_NonCanonical, FindMap_NonCanonical,
@ -159,9 +158,9 @@ native bool:IsMapValid(const String:map[]);
/** /**
* Returns whether a full or partial map name is found or can be resolved * Returns whether a full or partial map name is found or can be resolved
* *
* @param map Map path relative to maps/ folder, excluding .bsp extension. * @param map Map name (usually same as map path relative to maps/ dir,
* If result is FindMap_FuzzyMatch or FindMap_NonCanonical, * excluding .bsp extension). If result is FindMap_FuzzyMatch
this will be updated to the full path. * or FindMap_NonCanonical, this will be updated to the full path.
* @param maxlen Maximum length to write to map var. * @param maxlen Maximum length to write to map var.
* @return Result of the find operation. Not all result types are supported on all games. * @return Result of the find operation. Not all result types are supported on all games.
*/ */