cmf_kosherGarage_fnc_init

From cluster wiki
Revision as of 16:21, 17 December 2022 by Eric (talk | contribs)
Jump to navigation Jump to search


Hover & click on the images for description
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:
See also needed
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