GetCargoState
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | GetCargoState | |
| Function Description: | Gets the Max Wounded, Personnel , maxmass and current weight of cargo on board the player's current airframe. Returns a table with the cargo state information or nil if an error occurs. Logs informational messages for errors or successful retrievals. | |
| File Location: | cmm.sideMissionFunctions.lua | |
| Syntax: | CMM.GetCargoState( table UnitObject ) | |
| Return Value: | nil or table | |
| Parameters: | Name | Description |
| UnitObject | Player object | |
| Example: | CMM.Miz.CheckAirFrame(player, "CargoMission") | |
| Example Description: | Verifies that the player's airframe has the required cargo capacity for a cargo mission, returning true if valid and logging the match details. | |
| Related Functions: | ||
| Notes: | ||