Miz.CheckAirFrame: Difference between revisions
Ozdeadmeat (talk | contribs) Miz.CheckAirFrame – created via PowerShell script (2025-11-11T21:12:38Z) Tag: Recreated |
Ozdeadmeat (talk | contribs) m Miz.CheckAirFrame – created via PowerShell script (2026-06-24T22:27:14Z) |
||
| Line 1: | Line 1: | ||
{{Template:FunctionInfo|fName= Miz.CheckAirFrame|fDescription= Checks if a player's airframe is compatible with a specified mission type by comparing the airframe's cargo capacity against the mission's required cargo type. Returns true if the airframe has sufficient cargo capacity, otherwise returns false. Logs informational messages for errors or successful matches.|parentFile= cmm.sideMissionFunctions.lua|syntax= CMM.Miz.CheckAirFrame(playerObject <object>, MissionType <string>)|return= boolean|returnDesc= Returns true if the airframe meets the mission's cargo requirement, false otherwise.|example= CMM.Miz.CheckAirFrame(player, "CargoMission")|exampleDesc= 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= |note= |envType= CMM|par1= | {{Template:FunctionInfo|fName= Miz.CheckAirFrame|fDescription= Checks if a player's airframe is compatible with a specified mission type by comparing the airframe's cargo capacity against the mission's required cargo type. Returns true if the airframe has sufficient cargo capacity, otherwise returns false. Logs informational messages for errors or successful matches.|parentFile= cmm.sideMissionFunctions.lua|syntax= CMM.Miz.CheckAirFrame(playerObject <object>, MissionType <string>)|return= boolean|returnDesc= Returns true if the airframe meets the mission's cargo requirement, false otherwise.|example= CMM.Miz.CheckAirFrame(player, "CargoMission")|exampleDesc= 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= |note= |envType= CMM|par1= table playerObject|reqType1= table|reqName1= playerObject|desc1= Player object to retrieve the airframe type from, must have a getTypeName method.|par2= string MissionType|reqType2= string|reqName2= MissionType|desc2= The mission type string, case-insensitive, used to determine cargo requirements from sidequest data.}} | ||
Latest revision as of 12:27, 24 June 2026
| Environment: | Mission Scripting | |
|---|---|---|
| Function: | Miz.CheckAirFrame | |
| Function Description: | Checks if a player's airframe is compatible with a specified mission type by comparing the airframe's cargo capacity against the mission's required cargo type. Returns true if the airframe has sufficient cargo capacity, otherwise returns false. Logs informational messages for errors or successful matches. | |
| File Location: | cmm.sideMissionFunctions.lua | |
| Syntax: | CMM.Miz.CheckAirFrame( table playerObject , string MissionType ) | |
| Return Value: | boolean | |
| Parameters: | Name | Description |
| playerObject | Player object to retrieve the airframe type from, must have a getTypeName method. | |
| MissionType | The mission type string, case-insensitive, used to determine cargo requirements from sidequest data. | |
| 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: | ||