Difference between revisions of "cmf kosherGarage fnc init"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 28: | Line 28: | ||
|x1= {{code|lang=scilab|[this, _myGarageObject, 75, "myLoadoutID", 5] call cmf_kosherGarage_fnc_init;}} | |x1= {{code|lang=scilab|[this, _myGarageObject, 75, "myLoadoutID", 5] call cmf_kosherGarage_fnc_init;}} | ||
|seealso= [[cmf_kosherGarage_fnc_garageInterface]] [[cmf_kosherGarage_fnc_getAllPylonWeapons]] | |||
[[cmf_kosherGarage_fnc_registerWhitelist]] [[cmf_kosherGarage_fnc_syncVehicle]] | |||
|var1= {{!}} LOCAL {{!}}{{!}} Mission {{!}}{{!}} cmf_kosherGarage_open {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that is true when the garage is open | |var1= {{!}} LOCAL {{!}}{{!}} Mission {{!}}{{!}} cmf_kosherGarage_open {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that is true when the garage is open | ||
|var2= {{!}} LOCAL {{!}}{{!}} UI {{!}}{{!}} cmf_kosherGarage_display {{!}}{{!}} A variable containing the garage [https://community.bistudio.com/wiki/Display Display] | |var2= {{!}} LOCAL {{!}}{{!}} UI {{!}}{{!}} cmf_kosherGarage_display {{!}}{{!}} A variable containing the garage [https://community.bistudio.com/wiki/Display Display] | ||
|var3= {{!}} LOCAL {{!}}{{!}} Mission {{!}}{{!}} cmf_kosherGarage_spawns {{!}}{{!}} An [https://community.bistudio.com/wiki/Array Array] variable containing all the spawned [https://community.bistudio.com/wiki/Script_Handle Script Handles] | |var3= {{!}} LOCAL {{!}}{{!}} Mission {{!}}{{!}} cmf_kosherGarage_spawns {{!}}{{!}} An [https://community.bistudio.com/wiki/Array Array] variable containing all the spawned [https://community.bistudio.com/wiki/Script_Handle Script Handles] | ||
|var4= {{!}} LOCAL {{!}}{{!}} | |var4= {{!}} LOCAL {{!}}{{!}} Mission {{!}}{{!}} cmf_kosherGarage_whitelist {{!}}{{!}} An [https://community.bistudio.com/wiki/Array Array] variable containing the parsed whitelist | ||
|event1= {{!}} LOCAL {{!}}{{!}} cmf_kosherGarage_onOpen {{!}}{{!}} [display] {{!}}{{!}} Is fired locally when a kosherGarage interface is opened | |event1= {{!}} LOCAL {{!}}{{!}} cmf_kosherGarage_onOpen {{!}}{{!}} [display] {{!}}{{!}} Is fired locally when a kosherGarage interface is opened | ||
Latest revision as of 21:53, 17 December 2022
Description
- Description:
- This function initializes kosherGarage on a object.
- Execution:
- Call
- Groups:
- CMF3: kosherGarage
Syntax
- Syntax:
- [actionObject, garageObject, garageDirection, whitelistID, clearRange] call cmf_kosherGarage_fnc_init
- Parameters:
- actionObject: Object - The object to attach the "Open Garage" action to.
- garageObject: Object - An object to be used as the position of where to spawn the vehicles
- garageDirection: Number - (Optional, default 0) The direction to spawn vehicles in
- whitelistID: String - (Optional, default "ALL") a whitelist ID to whitelist the garage (you can get an ID using cmf_kosherGarage_fnc_registerWhitelist).
- clearRange: Number - (Optional, default 8) The radius from the garageObject to delete existing vehicles (used to avoid spawned vehicles from clipping).
- Return Value:
- None
Examples
- Example 1:
[this, _myGarageObject, 75, "myLoadoutID", 5] call cmf_kosherGarage_fnc_init;
Additional Information
- See also:
- cmf_kosherGarage_fnc_garageInterface cmf_kosherGarage_fnc_getAllPylonWeapons cmf_kosherGarage_fnc_registerWhitelist cmf_kosherGarage_fnc_syncVehicle
Internal Variables
| Locality | Namespace | Name | Description |
|---|---|---|---|
| LOCAL | Mission | cmf_kosherGarage_open | A Boolean variable that is true when the garage is open |
| LOCAL | UI | cmf_kosherGarage_display | A variable containing the garage Display |
| LOCAL | Mission | cmf_kosherGarage_spawns | An Array variable containing all the spawned Script Handles |
| LOCAL | Mission | cmf_kosherGarage_whitelist | An Array variable containing the parsed whitelist |
Events
| Locality | Name | Variables | Description |
|---|---|---|---|
| LOCAL | cmf_kosherGarage_onOpen | [display] | Is fired locally when a kosherGarage interface is opened |
| LOCAL | cmf_kosherGarage_onClose | [ ] | Is fired locally when a kosherGarage interface is closed |
| LOCAL | cmf_kosherGarage_onSelect | [vehicle] | Is fired locally when a new vehicle is selected |
Notes