FindPlayerUnitID
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | FindPlayerUnitID | |
| Function Description: | Retrieves the unitID (or slotID) of a player by their name from the mission player list, returning the unitID if found or -1 if not present. | |
| File Location: | cmm.netFunctions.lua | |
| Syntax: | CMM.FindPlayerUnitID( string PlayerName ) | |
| Return Value: | number | |
| Parameters: | Name | Description |
| PlayerName | The name of the player as it appears in the mission editor or in-game. | |
| Example: | CMM.FindPlayerUnitID("OzDeaDMeaT") | |
| Example Description: | Looks up the unitID for the player named "OzDeaDMeaT" in the player list and returns it if found, otherwise returns -1. | |
| Related Functions: | ||
| Notes: | ||