Arma 3 functions

Aircraft Carrier

BIS_fnc_aircraftCatapultLaunchAccelerates an aircraft off the aircraft carrier. For this to work the aircraft must be properly configured in config. See Arma 3: Aircraft Systems…
BIS_fnc_aircraftTailhookAircraft carrier arrest/recovery function for USS Freedom aircraft carrier. If the aircraft exceeds the speed defined in config a wire snap will be…
BIS_fnc_carrier01AnimateDeflectorsPlays a set of animations to animate the carriers' catapult jet blast deflectors. See Arma 3: Aircraft Systems for information about needed config…
BIS_fnc_carrier01CatapultActionAdd
BIS_fnc_carrier01CatapultActionRemove*N/A*
BIS_fnc_carrier01CatapultID*N/A*
BIS_fnc_carrier01CatapultLockTo*N/A*
BIS_fnc_carrier01CrewInAnim*N/A*
BIS_fnc_carrier01CrewPlayAnim*N/A*
BIS_fnc_carrier01EdenDelete- This is a sub function designed to delete dynamic aircrfat carrier in EDEN editor. Carrier consists of multiple sub-objects that are linked…
BIS_fnc_carrier01EdenInit- This is a sub function designed to assemble dynamic aircrfat carrier in EDEN editor. Carrier consists of multiple sub-objects that are linked…
BIS_fnc_carrier01InitThis is a main function designed to assemble a dynamic aircraft carrier. A carrier consists of multiple sub-objects that are linked together based on…
BIS_fnc_carrier01PosUpdate- This is a sub function designed to update dynamic aircraft carriers position in EDEN editor. Carrier consists of multiple sub-objects that are…

Aircraft Functionality

BIS_fnc_aircraftFoldingWingsHandles foldable wings of aircrafts. Is supposed to be used from within class Eventhandlers of the vehicle. See Arma 3: Aircraft Systems for…
BIS_fnc_aircraftTailhookAiHandles landing on the aircraft carrier for AI and player autopilot.
BIS_fnc_ejectionSeatRelease- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such…
BIS_fnc_planeAiEject- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such…
BIS_fnc_planeEjection- This function is designed to implement semi-authenthic ejection system on fixed wing aircrfat that have such functionality enabled/configured.
BIS_fnc_planeEjectionFX- This function is designed as part of set of functions to implement semi-authenthic ejection system on fixed wing aircrfat that have such…

Ambient

BIS_fnc_ambientAnimPlay set of ambient animations on given unit. If the unit should react to combat, use BIS_fnc_ambientAnimCombat instead.
BIS_fnc_ambientAnimCombatPlay set of ambient animations on given unit AND allows the unit to leave the ambient state and engage enemy or move away.
BIS_fnc_ambientAnimGetParamsFeeds params of given animset to BIS_fnc_ambientAnim.
BIS_fnc_ambientBlacklistCheck if area is blacklisted. Blacklist triggers are to be named 'bis_ambientBlacklist_#', where # is number from 0 to 99.
BIS_fnc_ambientBlacklistAddAdd a new ambient blacklist trigger
BIS_fnc_ambientBoats
BIS_fnc_ambientFlybySpawns an air unit that moves from point A to point B, never engaging nor being engaged. It is set as captive and will despawn once it reaches its…
BIS_fnc_ambientHelicopters
BIS_fnc_ambientPlanesCreates ambient airplanes fly-by near airports around the player. It will automatically get classes from `configFile >> "CfgVehicles"` on all planes…
BIS_fnc_ambientPostprocessInitialize terrain-related postprocess effects.
BIS_fnc_animalBehaviourAnimal behaviour control. Called by `Animals_F\Data\Scripts\main.fsm`.
BIS_fnc_animalRandomizationRandomise animals skin.
BIS_fnc_animalSiteSpawnCreate an area that spawns animals. The animals will be created or deleted if a player is inside or outside the area's radius.

Arrays

BIS_fnc_addToPairsAdds given value to pair array, stored under unique key.
BIS_fnc_arrayCompareThis function checks if two arrays are containing the same elements in the same order.
BIS_fnc_arrayFindDeepSearches an array for a specific value and returns its index.
BIS_fnc_arrayInsertInserts the elements of one array into another, at a specified index. Neither arrays are touched by reference, a new array is returned.
BIS_fnc_arrayPopThis function removes the last (rightmost) element of an array and returns it.
BIS_fnc_arrayPushThis function adds an element to the end of an array and returns the array.
BIS_fnc_arrayPushStackThis function is similar to the array push function; however, it pushes the contents of an array onto the stack array.
BIS_fnc_arrayShiftThis function removes the first (leftmost) element of an array and returns it.
BIS_fnc_arrayShuffleReturn a new array with randomized order of elements from input array.
BIS_fnc_arrayUnShiftThis function adds an element to the beginning of an array and returns the array. The array is passed by reference so changes inside the function…
BIS_fnc_colorConfigToRGBAConverts config color format to RGBA array of numbers.
BIS_fnc_colorRGBAtoHTMLConverts RGBA color format to #AARRGGBB HTML color format.
BIS_fnc_colorRGBAtoTextureConverts RGB color format to procedural texture, e.g `[0,0,0,1]` becomes `"#(argb,8,8,3)color(0,0,0,1)"`.
BIS_fnc_colorRGBtoHTMLConverts RGB color format to HTML color format.
BIS_fnc_conditionalSelectThis returns a sub-array of elements that satisfy a specific condition in the order they have been passed.
BIS_fnc_consolidateArrayFinds duplicates in the given array of anything and consolidates them into an array of sub-arrays
BIS_fnc_findAllNestedElementsReturns array of paths to all matching elements in deeply nested array, similar to BIS_fnc_findNestedElement but with all occurences.
BIS_fnc_findExtremeReturns the minimum or maximum value in an array of numbers.
BIS_fnc_findInPairsSearches the associative array for the first occurance of the key string and returns its index. Seach is not case-sensitive.
BIS_fnc_findNestedElementFunction to find item in nested arrays and return a path to the first match.
BIS_fnc_getFromPairsSearches the associative array for the 1st occurance of the key string and returns the value associated with it. Search is not case sensitiv.
BIS_fnc_greatestNumReturns the greatest number out of the passed set.
BIS_fnc_lowestNumReturns the lowest number out of the passed set.
BIS_fnc_maxDiffArrayFunction to return the maximum difference between all values in an array.
BIS_fnc_nearestNumReturns the provided set closest number to the target number.
BIS_fnc_numberDigitsBreak number into array of digits.
BIS_fnc_paramLoad a script parameter. See Arma 3: Functions Library for detailed description.
BIS_fnc_paramInSee BIS_fnc_param. Overloading default values is disabled in this variant. It's intended to be used where _this is not used as an input param.
BIS_fnc_parseNumberSafeConverts expression into a number. Can also convert array of expressions into an array of numbers. If expression does not return a number, 0 is…
BIS_fnc_randomIndexReturn a random integer representing an index in the passed array.
BIS_fnc_removeFromPairsRemoves an item from pair array, modifying or not the original array.
BIS_fnc_removeIndexTakes an array, and returns a new array with the specified index(es) removed. This takes the array passed in the first parameter, and returns an…
BIS_fnc_removeNestedElementFunction to remove an item in a nested array. Modifies the array by reference.
BIS_fnc_returnNestedElementFunction to return an item at a path in an array.
BIS_fnc_selectRandomSelects one of the arguments at random.
BIS_fnc_selectRandomWeightedSelects a random item from an array, taking into account item weight.
BIS_fnc_setNestedElementFunction to set an item in a nested array using a path. Modifies the array by reference.
BIS_fnc_setToPairsWorks similar to the BIS_fnc_addToPairs but it doesn't try to add values. It just overwrites the volue if the key already exists.
BIS_fnc_sortAlphabeticallyAlphabetically sort an array of strings without modifying the original. See also sort.
BIS_fnc_sortBySorts an array according to given algorithm. See sort for simple sorts.
BIS_fnc_sortNumSorts an array of numbers from lowest (left) to highest (right). The passed array is modified by reference. This function uses the quick sort…
BIS_fnc_subSelectReturns a sub-selection of the passed array.

Behavior

BIN_fnc_behaviorInit
BIN_fnc_breatheInit
BIN_fnc_findSafePositions
BIN_fnc_findTargetWeight
BIN_fnc_getBehaviorCoefBIN_fnc_getBehaviorCoef Get behavior coefficients
BIN_fnc_setBehavior
BIN_fnc_setBehaviorCoefBIN_fnc_setBehaviorCoef Set behavior coefficients
BIN_fnc_setBreathe
BIN_fnc_setTargetWeightBIN_fnc_setTargetWeight Set target priroty which is used later by BIN_fnc_findTargetWeight function to find target.

Bitwise

BIS_fnc_bitflagsCheckChecks if one or more flags are set in the given flagset, represented with decimal or hexadecimal number
BIS_fnc_bitflagsFlipFlips one or more flags (set gets unset and vice versa) in the given flagset, represented with decimal or hexadecimal number
BIS_fnc_bitflagsSetSets one or more flags in the given flagset, represented with decimal or hexadecimal number
BIS_fnc_bitflagsToArrayReturns array with all bit flags which are set in the given flagset
BIS_fnc_bitflagsUnsetUnsets one or more flags in the given flagset, represented with decimal or hexadecimal number
BIS_fnc_bitwiseANDPerforms bitwise AND operation on two decimal or hexadecimal unsigned 24 bit integers (Hexadecimal number representation is simply auto-converted…
BIS_fnc_bitwiseNOTPerforms bitwise NOT operation on decimal or hexadecimal unsigned 24 bit integer (Hexadecimal number representation is simply auto-converted into…
BIS_fnc_bitwiseORPerforms bitwise OR operation on two decimal or hexadecimal unsigned 24 bit integers (Hexadecimal number representation is simply auto-converted into…
BIS_fnc_bitwiseXORPerforms bitwise XOR operation on two decimal or hexadecimal unsigned 24 bit integers (Hexadecimal number representation is simply auto-converted…
BIS_fnc_decodeFlagsDecodes a single scalar into array of unique binary flags with indexes between 0-15.
BIS_fnc_decodeFlags2Decodes a single scalar into array of unique binary flags (zeroes or ones).
BIS_fnc_decodeFlags4Decodes a single scalar into array of unique 4-state flags (values 0,1,2,3).
BIS_fnc_decodeFlags8Decodes a single scalar into array of unique 8-state flags (values 0,1,2,3,4,5,6,7).
BIS_fnc_encodeFlagsEncodes array of unique binary flags with indexes between 0-15 into a single scalar.
BIS_fnc_encodeFlags2Encodes array of unique binary flags (zeroes or ones) into a single scalar.
BIS_fnc_encodeFlags4Encodes array of unique 4-state flags (0,1,2,3) into a single number.
BIS_fnc_encodeFlags8Encodes array of unique 8-state flags (0,1,2,3,4,5,6,7) into a single number.

Boat Recovery

BIS_fnc_boatRack01ActionAdd- This is sub function for 'boat recovery' functionality.
BIS_fnc_BoatRack01ActionCondition
BIS_fnc_boatRack01ActionRemove- This is sub function for 'boat recovery' functionality.
BIS_fnc_boatRack01AdjustZOffset- This is sub function for 'boat recovery' functionality.
BIS_fnc_boatRack01CanExetuteAction- This is sub function for 'boat recovery' functionality.
BIS_fnc_boatRack01CanProgressAction- This is sub function for 'boat recovery' functionality.
BIS_fnc_boatRack01Init- This is main function for 'boat recovery' functionality.
BIS_fnc_boatRack01InitAdjustZOffsets- This is sub function for 'boat recovery' functionality.

Briefing

BIS_fnc_animatedBriefingPlays the Animated Briefings. Basically, it is a wrap function for the BIS_fnc_eventTimeline function.
BIS_fnc_briefingAnimateAnimate briefing markers.
BIS_fnc_briefingInitInitialize animated briefing markers.
BIS_fnc_selectDiarySubjectSelects a diary subject.

Broken Functions

BIN_fnc_CBRNCharacterAddEnables CBRN systems on a specific character entity.
BIN_fnc_CBRNContaminantAddRegisters a CBRN contaminant.
BIN_fnc_CBRNContaminantRemoveUnregisters a CBRN contaminant.
BIN_fnc_CBRNGearActivateActivates a specific piece of CBRN gear for a character entity.
BIN_fnc_CBRNGearDeactivateDeactivates a specific piece of CBRN gear for a character entity.
BIN_fnc_CBRNGearUpdateProcesses CBRN gear updates on a specific character entity.
BIN_fnc_CBRNInContaminantReturns whether or not a character entity is within a CBRN contaminated area.
BIS_fnc_3DENMissionStatsThis functions does nothing.
BIS_fnc_diagVehicleIconsPreviews all vehicle icons on map.
BIS_fnc_effectFiredLongSmokeThis function does nothing.
BIS_fnc_errorMsgDisplay error window.
BIS_fnc_exportGUIBaseClassesExport GUI macros and base classes to the clipboard.
BIS_fnc_garageSplendid™ Virtual Arsenal Garage.
BIS_fnc_healingHealing postprocess. Supposed to give healing postprocess effects.
BIS_fnc_incapacitatedEffectA draft of incapacitated effects function.
BIS_fnc_missionConversationsLocal
BIS_fnc_missionTasksLocal
BIS_fnc_moduleRespawnVehicleSet vehicle respawn, compatible both with SP and MP.
BIS_fnc_ORBATConfigPreviewOpens config viewer and shows CfgORBAT. Used to retrieve CfgOrbat data
BIS_fnc_respawnBase
BIS_fnc_sceneGetObjectsThis function gets objects (but centre object) positions and direction relative to the choosen object and copies the result to the clipboard via…
BIS_fnc_sceneSetObjectsThis function sets objects positions and direction relative to the chosen object.
BIS_fnc_wpPatrol

Camera

BIS_fnc_camera_deletedDeletes given camera.
BIS_fnc_camera_getCamGets camera instance of camerea object
BIS_fnc_camera_getCinemaBordersEnabledCheck if camera uses cinema borders.
BIS_fnc_camera_getFocusReturns camera focus.
BIS_fnc_camera_getFOVGets FOV of camera.
BIS_fnc_camera_getHUDEnabledReturns wether camera HUD is enabled.
BIS_fnc_camera_getVisionModeReturns camera vision mode.
BIS_fnc_camera_initInitialises a camera.
BIS_fnc_camera_setCamSets camera instance of camera object.
BIS_fnc_camera_setCinemaBordersEnabledSets cinema borders.
BIS_fnc_camera_setFocusSets camera focus.
BIS_fnc_camera_setFOVSets the FOV of given camera.
BIS_fnc_camera_setHUDEnabledEnables or disables camera HUD.
BIS_fnc_camera_setVisionModeSets camera vision mode.
BIS_fnc_camera_tickTicks a camera. Updates position and view mode.
BIS_fnc_camFollowRefresh a camera Field of View according to its distance with the target.

Camera3DEN

BIS_fnc_camera_edenAttributesChangedAttributes change in EDEN for a camera
BIS_fnc_camera_edenConnectionChanged3DEN connections of a camera are changed
BIS_fnc_camera_edenDeletedCamera is deleted
BIS_fnc_camera_edenInitCamera is initialized in 3den
BIS_fnc_camera_edenIsSelectedWhether this camera is selected in 3den
BIS_fnc_camera_edenRegisteredToWorld*N/A*
BIS_fnc_camera_edenResetResets camera in 3DEN
BIS_fnc_camera_edenSelectionChangedThe selection state of given camera changes
BIS_fnc_camera_edenUnregisteredFromWorldAttributes change in EDEN for a camera

Campaign

BIS_fnc_EXP_camp_addTickets*N/A*
BIS_fnc_EXP_camp_balanceGroupBalances a group depending on the amount of connected players
BIS_fnc_EXP_camp_checkpointSet's a mission checkpoint, in single-player an auto save happens, in multiplayer a new respawn position is added
BIS_fnc_EXP_camp_dynamicAISkillChanges AI skill based on player count, responding to player connected / player disconnected events.
BIS_fnc_EXP_camp_getCinematicModeReturns whether or not player is in cinematic mode.
BIS_fnc_EXP_camp_getPlayersGroupReturns group that players belong to in coop campaign scenario.
BIS_fnc_EXP_camp_guidedProjectileSpawns object of given class and makes it travel, hooming towards the target To be used with CfgAmmo type of entity, but can be used with virtually…
BIS_fnc_EXP_camp_hasMissionStartedReturns whether the mission has actually started (see Manager)
BIS_fnc_EXP_camp_IFFSimple handling of the Support Team's scripted IFF.
BIS_fnc_EXP_camp_initCharacterAssigns correct appearance and loadout of story characters based upon their vehicle classnames.
BIS_fnc_EXP_camp_initClassesInitializes the classes players can choose from before spawning.
BIS_fnc_EXP_camp_initDifficultyInitializes difficulty settings in Apex Protocol campaign.
BIS_fnc_EXP_camp_playerChecklistDisplay a checklist of players that don't meet the given condition, thus preventing mission progress.
BIS_fnc_EXP_camp_playTimelineVideoPlays a video with BIS_fnc_EXP_camp_setCinematicMode enabled.
BIS_fnc_EXP_camp_replaceVehiclesReplaces textures of "I_G_Offroad_01_armed_F" and "I_G_Quadbike_01_F" randomly.
BIS_fnc_EXP_camp_setCinematicModeSets cinematic mode, with cinematic mode enabled the sounds are muted and screen is black.
BIS_fnc_EXP_camp_setSkillSets skill for an entire AI side. The skill will be calculated using a lerp function. Function will take player as multiplier.
BIS_fnc_EXP_camp_SITREPDisplays multiple lines of text in given order.
BIS_fnc_isCampaignChecks to see if a mission is being run in a campaign.

CampaignLobby

BIS_fnc_EXP_camp_lobbyCore Function
BIS_fnc_EXP_camp_lobby_clearVarsClear variables
BIS_fnc_EXP_camp_lobby_ctrlSetColorUpdates controls with defined colors
BIS_fnc_EXP_camp_lobby_findHostFind host
BIS_fnc_EXP_camp_lobby_getHostSettingsGrabs the host settings for respawn and revive
BIS_fnc_EXP_camp_lobby_getPlayerSquadNameReturn the player squad name
BIS_fnc_EXP_camp_lobby_goRun Mission
BIS_fnc_EXP_camp_lobby_introOn Load Function (Does nothing)
BIS_fnc_EXP_camp_lobby_launchLaunch Function
BIS_fnc_EXP_camp_lobby_loopUpdate UI Loop
BIS_fnc_EXP_camp_lobby_missionCountdownCountdown to run mission
BIS_fnc_EXP_camp_lobby_onLoadOn Load Function (Does nothing)
BIS_fnc_EXP_camp_lobby_onUnLoadOn display unload function - clear variables and close as necessary
BIS_fnc_EXP_camp_lobby_playMissionVideoCreates the control and plays mission video
BIS_fnc_EXP_camp_lobby_serverPingUpdates player status
BIS_fnc_EXP_camp_lobby_serverUpdateServer update function (runs on "host" machine for dedicated servers)
BIS_fnc_EXP_camp_lobby_structuredTextFormats structured text
BIS_fnc_EXP_camp_lobby_UIMilitaryManagerUpdates military efficiency based on mission settings
BIS_fnc_EXP_camp_lobby_UIMissionCountdownCountdown to run mission
BIS_fnc_EXP_camp_lobby_UIMissionManagerHandles UI behaviour of tree mission options
BIS_fnc_EXP_camp_lobby_UIOverlayManagerUpdates the mission overview and intel from tree interactions
BIS_fnc_EXP_camp_lobby_UIProgressManagerHandles Progress button UI behaviour
BIS_fnc_EXP_camp_lobby_UISettingsManagerHandles the mission settings for Respawn and Revive
BIS_fnc_EXP_camp_lobby_updateHostSettingsUpdates all clients with the latest host settings
BIS_fnc_EXP_camp_lobby_updateIntelUpdates the mission overview and intel from tree interactions
BIS_fnc_EXP_camp_lobby_updateMilitaryEfficiencyUpdates military efficiency radial bar
BIS_fnc_EXP_camp_lobby_updatePlayersUpdates UI based on player status changes
BIS_fnc_EXP_camp_lobby_updatePlayerStatusUpdates player status

CampaignManager

BIS_fnc_EXP_camp_managerHandles match start synchronization between server and clients
BIS_fnc_EXP_camp_manager_getStateGet's the mission state, can be one of "Waiting", "Intro", "Loadout" or "Started"
BIS_fnc_EXP_camp_manager_onPlayerRegisteredA player is registered for given state
BIS_fnc_EXP_camp_manager_setStateSet's the state of the mission
BIS_fnc_EXP_camp_manager_triggerEventTriggers corresponding event for given mission state

Cargo Platform

BIN_fnc_cargoPlatform_01_adjustAdjust Military Cargo Platform legs length in Eden Editor.
BIN_fnc_cargoPlatform_01_destructionBIN_fnc_CargoPlatform_01_destruction
BIN_fnc_cargoPlatform_01_updateBIN_fnc_cargoPlatform_01_update

Checkpoint

Collisions

BIN_fnc_addEntitiesToArea
BIN_fnc_addObjectsToAreaAdds given array of objects to area, ovewriting previous objects data stored for the area in extension
BIN_fnc_crearAllDataThis function contains no code.
BIN_fnc_diag_drawAllAreaObjectsBoundsDraws all area objects bounds
BIN_fnc_diag_getAllAreaEntities
BIN_fnc_diag_getAllAreaObjectsReturns stored area objects for diagnostics
BIN_fnc_getAllAreas
BIN_fnc_getEntityBoundingBarrel
BIN_fnc_getObjectBoundingBarrelReturns bounding barrel of the given object
BIN_fnc_getTerrainObjectsReturns terrain objects of the given type for the given area dimensions
BIN_fnc_markFreeAreaPositionsReturns array of booleans in place of passed positions, where true is free and false is possible collision

Combat

BIS_fnc_enemyDetectedReturns true if unit knows about nearby enemy unit or driven vehicle.
BIS_fnc_enemyTargetsReturn list of nearby enemy targets for given unit.
BIS_fnc_fireMakes a unit or a vehicle fire given muzzle. Make sure that there is some ammo to fire, and, in case of a unit, the weapon with given muzzle is…
BIS_fnc_fireSupportMortar/artillery fire support.
BIS_fnc_spotterMake spotter report target distance to sniper. Will only stop if one of the two units dies.
BIS_fnc_stalkContinuously set WP of one group to a different group to hunt it. It does not change the group's behaviour.
BIS_fnc_threatCalculates threat values of given unit.

CombatPatrol

BIS_fnc_CPDummy*N/A*
BIS_fnc_CPFindEmptyPositionCombat Patrol empty position locator
BIS_fnc_CPInitCombat Patrol init & general handle
BIS_fnc_CPLogCombat Patrol dedicated logging fnc
BIS_fnc_CPPickSafeDirCombat Patrol safe azimuth picker.
BIS_fnc_CPSafeAzimuthsCombat Patrol safe azimuth finder. Scans around the AO for usable & convenient approach routes
BIS_fnc_CPSendReinforcementsCombat Patrol reinforcements handle
BIS_fnc_CPSpawnGarrisonGrpCombat Patrol garrison spawning
BIS_fnc_CPWaitUntilFunction waits until condition becomes true. Condition is checked with given interval.

BIS_fnc_addCommMenuItemAdd communication menu to the given unit.
BIS_fnc_commsMenuCreateCreates the global communications menu, if it is not already created. All entries are invisible by default. Unhide appropriate sections by using…
BIS_fnc_commsMenuToggleAvailabilityEnables or disables certain sections of the global communications menu.
BIS_fnc_commsMenuToggleVisibilityShows or hides certain sections of the global communications menu.
BIS_fnc_createMenuCreate custom commanding menu (with multiple pages if necessary).
BIS_fnc_refreshCommMenuRefresh the communication menu variable.
BIS_fnc_removeCommMenuItemRemove an item from the communication menu.

Configs

BIS_fnc_baseVehicleReturns base vehicle (i.e., vehicle which is not just derivative of other with different textures / animations).
BIS_fnc_classMagazineReturns class of magazine given by string.
BIS_fnc_configExtremesScan config paths and return min and max values for each property.
BIS_fnc_configPathReturns config path to given entry in given format.
BIS_fnc_controlConfigsReturn config paths to all display controls.
BIS_fnc_displayNameReturn given class displayName value. Return base class name if displayName not defined.
BIS_fnc_getCfgSmart-return config (extension for BIS_fnc_getCfgXXXX functions). Can by called 2 ways: - 1st way - passing config directly - 2nd way - passing array…
BIS_fnc_getCfgDataSmart-return number, text or array value from config. - Default syntax works for any config. - Alternative syntax is for working comfortably with…
BIS_fnc_getCfgDataArrayGets an array defined in Config. If the value is not an array, it is retyped into one.
BIS_fnc_getCfgDataBoolGets a number defined in config and retype it into a boolean. Everything greater than 0 is true, otherwise it is false.
BIS_fnc_getCfgDataObjectGet the object defined in cfg by its name (global variable).
BIS_fnc_getCfgDataPoolGet array of attribute values out of the parent config class. Attributes need to be in this format: "_n", where n is an index number (starting from…
BIS_fnc_getCfgIsClassReturn true if it is a class. Can by called in two ways: - first way (general) works for any config - second way is for comfortable working with…
BIS_fnc_getCfgSubClassesReturn all child classes of given class.
BIS_fnc_loadClassSearches for class in mission, campaign and then in global config file.
BIS_fnc_loadEntrySearches for config entry in mission, campaign and then in global config file.
BIS_fnc_returnChildrenReturns all subclasses within given class.
BIS_fnc_returnConfigEntryExplores parent classes in the run-time config for the value of a config entry.
BIS_fnc_returnParentsReturns list of all parent classes.
BIS_fnc_subClasses*Same function as BIS_fnc_returnChildren*
BIS_fnc_uniqueClassesComposes an array of classes with unique param (based on returned value of passed code). If class inherits the param from parent, it's not listed.
BIS_fnc_unitAddonReturn addon from CfgPatches to which a given object belongs to.

Contact

BIN_fnc_addDangerZone
BIN_fnc_addSiteEntitiesRegister entities to a site, so they can be despawned with the rest when player leaves the area.
BIN_fnc_addTravelPoint
BIN_fnc_animateSmooth
BIN_fnc_attachChemlight
BIN_fnc_CBRNHoseInitInitialises CBRN Hose for given unit.
BIN_fnc_colorHSLtoRGBConverts HSL colour format to RGB.
BIN_fnc_createScriptedSoundSource
BIN_fnc_createScriptedSoundSourceVehicle<pre>
BIN_fnc_debugQuests
BIN_fnc_deleteDangerZone
BIN_fnc_deleteTravelPoint
BIN_fnc_dockModule
BIN_fnc_droneDestructionFX
BIN_fnc_droneModuleDestructionBIN_fnc_droneModuleDestruction Alien Module destruction
BIN_fnc_empVehicleSets EMP parameters to a vehicle. Destroys lights and optionally prevents vehicle from starting
BIN_fnc_eulerToVector
BIN_fnc_exit
BIN_fnc_exitAntennas
BIN_fnc_exitDiary
BIN_fnc_exitGroup
BIN_fnc_exitPersistentObjects
BIN_fnc_exitQuests
BIN_fnc_exitSites
BIN_fnc_exitTasks
BIN_fnc_getCharacterSounds
BIN_fnc_getFormattedControlReturn a formatted string of a mapped control (same style as the Field Manual and Hints)
BIN_fnc_getGroupSeed
BIN_fnc_getRoleIconGet soldier's role icon (e.g., sniper, machine-gunner, etc.)
BIN_fnc_getSiteLayerEntities
BIN_fnc_gravityBurst
BIN_fnc_gravityCannon_01_ai
BIN_fnc_grenadeThrowback
BIN_fnc_hackAIDrone
BIN_fnc_inDangerZone
BIN_fnc_initAcctime
BIN_fnc_initActors
BIN_fnc_initAIDrone
BIN_fnc_initAntennas
BIN_fnc_initConstants
BIN_fnc_initCutLayers<pre>//--- Register RSC layers in the correct order (they are not serialized)
BIN_fnc_initDiary
BIN_fnc_initDroneModule
BIN_fnc_initGroup
BIN_fnc_initHub
BIN_fnc_initInventory<pre>//--- Ignored in missions without special description.ext property
BIN_fnc_initLocations
BIN_fnc_initMiniUGV
BIN_fnc_initMothershipLightsEnable scripted ET Mothership lights on baked memory points Created lights can be retrieved via getVariable "BIN_lights" on the Mothership
BIN_fnc_initPersistentObjects
BIN_fnc_initProbeMap<pre>//--- Debug
BIN_fnc_initQuests
BIN_fnc_initRevive
BIN_fnc_initSideColors<pre>#define FORMAT "Map_%1_%2"
BIN_fnc_initSites
BIN_fnc_initTasks
BIN_fnc_initTurret
BIN_fnc_initUAV
BIN_fnc_initUGV
BIN_fnc_inList
BIN_fnc_isNull
BIN_fnc_isPaused
BIN_fnc_isPausedInit
BIN_fnc_lightBurst
BIN_fnc_list
BIN_fnc_markDangerZone
BIN_fnc_matrixMultiply
BIN_fnc_matrixTranspose
BIN_fnc_matterballDestructionBIN_fnc_matterBallDestruction Alien Module destruction
BIN_fnc_matterballEffectsBIN_fnc_matterBallEffects
BIN_fnc_matterCollectionFX
BIN_fnc_missileDeflection
BIN_fnc_missileSwarm
BIN_fnc_moduleChargeSequence
BIN_fnc_persistentVariables
BIN_fnc_playAlternatingSound
BIN_fnc_playMission
BIN_fnc_postInit
BIN_fnc_preInit
BIN_fnc_prototypeCannon_01_ai
BIN_fnc_prototypeCannon_01_player
BIN_fnc_prototypeCannon_01_slaved
BIN_fnc_scan
BIN_fnc_scanObject
BIN_fnc_setCustomSoundController
BIN_fnc_setDroneModuleParams
BIN_fnc_setDroneModuleTarget
BIN_fnc_setModuleSpeed
BIN_fnc_setPointOfInterestAdd point of interest shown in the map
BIN_fnc_setSite``` #define DEBUG #define ALPHA_ON 1.0 #define ALPHA_OFF 0.4 #define DRAW(SHOW)\ _color =…
BIN_fnc_showCurrentTask
BIN_fnc_showSimpleNotification
BIN_fnc_skip
BIN_fnc_soundDrone
BIN_fnc_taskActiveReturn if task is active, i.e., added to player, but not yet completed. Only in this state can player assign it.
BIN_fnc_taskAddedReturn if task was added to player. Includes both finished and unfinished tasks.
BIN_fnc_travelToPoint
BIN_fnc_tvSaveExpanded
BIN_fnc_vectorToEuler
BIN_fnc_wpAddScript
BIN_fnc_wpDroneMove
BIS_fnc_setCustomSoundController

ControlPoint

BIS_fnc_controlPoint_computeComputes data for control point.
BIS_fnc_controlPoint_computeOwnerKeyReturns the key owner of given control point.
BIS_fnc_controlPoint_getOwnerKeyReturns the key owner of given control point.
BIS_fnc_controlPoint_isArriveWhether given control point is arrive, not leave.
BIS_fnc_controlPoint_setIsArriveSet's whether this control point is arrive or leave.

ControlPoint3DEN

BIS_fnc_controlPoint_edenAttributesChangedAttributes change in EDEN for a control point
BIS_fnc_controlPoint_edenConnectionChanged3DEN connections of a control point is changed
BIS_fnc_controlPoint_edenDraggedEntity is dragged in 3DEN
BIS_fnc_controlPoint_edenIsSelectedWhether given control point is selected in 3den
BIS_fnc_controlPoint_edenRegisteredToWorldAttributes change in EDEN for a control point
BIS_fnc_controlPoint_edenUnregisteredFromWorldAttributes change in EDEN for a control point

Conversations

BIS_fnc_genericSentencePlay generic sentence with probablity set by bis_genericSentenceMode variable (0.5 = 50%, 1 = 100%)
BIS_fnc_genericSentenceInit*N/A*
BIS_fnc_kbCanSpeakCheck if person is not locked by some conversation.
BIS_fnc_kbCreateDummyCreates a dummy speaker (as a Game Logic). If given dummy variable has already been created, returns this one.
BIS_fnc_kbIsSpeakingCheck if speaker is locked for different conversation.
BIS_fnc_kbMenuOpens conversation menu. Script terminates itself when menu selection is finished.
BIS_fnc_kbPrioritySet conversation priority. Conversations with priority not in the list won't be played
BIS_fnc_kbSentence*N/A*
BIS_fnc_kbSkipSkip a conversation started with BIS_fnc_kbTell. Currently played sentence will be finished.
BIS_fnc_kbTellPlay given sentence/conversation. Script terminates itself when conversation is finished.
BIS_fnc_kbTellLocalPlay given sentence, disable radio and/or lower sounds. Will use BIS_fnc_showSubtitle for better effects if channel is DIRECT or VEHICLE.
BIS_fnc_kbTopicConfigReads the configs to return a matching `config >> CfgSentences >> missionName >> topic` entry.
BIS_fnc_missionConversationsHeader function of local mission conversations
BIS_fnc_missionConversationsLocal

Curator

BIS_fnc_addCuratorAreaFromTriggerAdd curator editing / camera area based on triggers.
BIS_fnc_addCuratorIconAdd an icon displayed in curator interface.
BIS_fnc_curatorAttachObjectAttach an object on another one under cursor.
BIS_fnc_curatorAttributesReturn attributes available for given entity
BIS_fnc_curatorAutomaticSpawn units based on curator settings. Used when curator role is not taken.
BIS_fnc_curatorAutomaticPositions*N/A*
BIS_fnc_curatorHintShow hint in curator interface.
BIS_fnc_curatorObjectEditedCode executed when curator object is edited (i.e., moved or rotated). When a soldier or a vehicle is moved high above ground, create a parachute for…
BIS_fnc_curatorObjectPlacedCode executed when curator object is placed.
BIS_fnc_curatorObjectRegisteredRegister "curatorObjectRegistered" handler. Cost of vehicles with crews will be automatically calculated based on vehicle + crew cost.
BIS_fnc_curatorObjectRegisteredTableRegister curator object costs from a table.
BIS_fnc_curatorPingedShow effects when player pings curator. Icon and entity list highlighting is handled by engine
BIS_fnc_curatorRespawnRestore unit for curators after respawn. When curator owner, it will transfer ownership to the new unit. When editable by curator, it will remove the…
BIS_fnc_curatorSayMessagePlays some radio message from CfgRadio locally.
BIS_fnc_curatorVisionModesToggle curator vision mode.
BIS_fnc_curatorWaypointPlacedCode executed when curator waypoint is placed.
BIS_fnc_drawCuratorDeathsShow skull unit for curator when the unit dies.
BIS_fnc_drawCuratorLocationsLabel every vilage, town and city in curator interface
BIS_fnc_drawCuratorRespawnMarkersCreate a curator icon on every respawn marker
BIS_fnc_exportCuratorCostTableGenerate spreadsheet with object classes and copy it to clipboard. The table will generate export code to be used in…
BIS_fnc_forceCuratorInterfaceForce curator interface, so user cannot exit it by pressing Zeus key.
BIS_fnc_initCuratorAttribute*N/A*
BIS_fnc_isCuratorReturns if given object is curator logic. Despite the misleading name this does not check if a player has access to Zeus. It just check if the given…
BIS_fnc_isCuratorEditableReturn true if given object is editable by player (when he's curator).
BIS_fnc_isForcedCuratorInterfaceReturn if curator interface is forced (user cannot leave it by pressing Zeus key).
BIS_fnc_listCuratorPlayersReturns list of playable units with access to curator.
BIS_fnc_manageCuratorAddonsSet which vision modes curator can access.
BIS_fnc_mirrorCuratorSettingsMirrors settings from one curator to another.
BIS_fnc_registerCuratorObjectGet individual cost of an object.
BIS_fnc_removeCuratorIconRemove icon displayed in curator interface.
BIS_fnc_removeDestroyedCuratorEditableObjectsMake destroyed curator objects non-editable.
BIS_fnc_setCuratorAttributesSet which attributes are available for given entity or entity type.
BIS_fnc_setCuratorCameraMove curator camera to a position and direction. Finished when animation ends.
BIS_fnc_setCuratorVisionModesSet which vision modes curator can access.
BIS_fnc_shakeCuratorCameraShake curator camera.
BIS_fnc_showCuratorAttributesShow attributes window of an entity. When no attributes are available, no window is opened.
BIS_fnc_showCuratorFeedbackMessageShow feedback message when illegal operation is attempted in curator interface.
BIS_fnc_toggleCuratorVisionModeToggle curator vision mode.

CuratorChallenges

BIS_fnc_addCuratorChallengeAdd challenges for curator to complete
BIS_fnc_completedCuratorChallengesCountReturn number of completed curator challenges.
BIS_fnc_curatorChallengeDestroyVehicle*N/A*
BIS_fnc_curatorChallengeFindIntel*N/A*
BIS_fnc_curatorChallengeFireWeapon*N/A*
BIS_fnc_curatorChallengeGetInVehicle*N/A*
BIS_fnc_curatorChallengeIlluminate*N/A*
BIS_fnc_curatorChallengeSpawnLightning*N/A*
BIS_fnc_finishCuratorChallengeHandle repeated curator challenges. When rewards defined in the argument are exceeded, refilling points bar fill be offered instead. Number of…
BIS_fnc_formatCuratorChallengeObjectsFormat the list of objects compatible with curator challenge to be displayed in the task descriptipon.
BIS_fnc_manageCuratorChallengesHandle repeated curator challenges. When rewards defined in the argument are exceeded, refilling points bar fill be offered instead.

Curve3DEN

BIS_fnc_richCurve_edenAttributesChanged3DEN attributes of a curve change
BIS_fnc_richCurve_edenBakeCurve3DBakes a curve to a set of points
BIS_fnc_richCurve_edenComputeNearestSegmentComputes the nearest baked segment from given 3D position
BIS_fnc_richCurve_edenConnectionChanged3DEN connection of a curve change
BIS_fnc_richCurve_edenDraggedEntity is dragged in 3DEN
BIS_fnc_richCurve_edenDrawControlPoints3DDraws all control points of a curve
BIS_fnc_richCurve_edenDrawCurve3DDraws a location curve in 3D
BIS_fnc_richCurve_edenIsSelectedWhether given curve is selected in 3den
BIS_fnc_richCurve_edenMarkStateDirtyMarks a curve state as dirty, so it knows it needs to recalculate For example, moving a key in EDEN
BIS_fnc_richCurve_edenTick

Database

BIS_fnc_dbClassCheckCheck if class exists in Scripted Database.
BIS_fnc_dbClassIdConverts string to class definition.
BIS_fnc_dbClassIndexReturns indices leading to given class.
BIS_fnc_dbClassListReturns all classes within class.
BIS_fnc_dbClassRemoveRemove class from Scripted Database. The function does not return the modified database but modifies the passed array directly.
BIS_fnc_dbClassReturnReturns content of given class.
BIS_fnc_dbClassSetAdd class to Scripted Database. The function modifies the passed array and returns a success flag.
BIS_fnc_dbConfigPathIf there is a database present in the config (config.cpp or descritpion.ext) then this function can be used to get the config path of the passed…
BIS_fnc_dbImportConfigCopy config classes and adds them to Scripted Database. Config values can not be passed through this function. The passed array gets modified.
BIS_fnc_dbImportXMLImport XML file into Scripted Database.
BIS_fnc_dbIsClassChecks if string is class definition.
BIS_fnc_dbIsValueChecks if string is value definition.
BIS_fnc_dbPrintCopy Scripted Database content into clipboard for evaluation. Text will be formatted as config.
BIS_fnc_dbSymbolClassA getter function to return the symbol used for declaring a class.
BIS_fnc_dbSymbolValueA getter function to return the symobl used for declaring a value.
BIS_fnc_dbValueCheckCheck if value exists in Scripted Database.
BIS_fnc_dbValueIdConverts string to value definition or vice versa.
BIS_fnc_dbValueIndexReturns indexes leading to given value.
BIS_fnc_dbValueListReturns all values within class.
BIS_fnc_dbValueRemoveRemove value from Scripted Database.
BIS_fnc_dbValueReturnReturns content of given value.
BIS_fnc_dbValueSetAdd value to Scripted Database. If the provided path does not exist it is created, otherwise the value is overwritten. The passed array gets modified.

Decon Shower

BIN_fnc_deconShowerAnim
BIN_fnc_deconShowerAnimLarge
BIN_fnc_deconShowerAnimStopBIN_fnc_deconShowerAnimStop Delete all sound sources attachted to decon shower in case it is destroyed or deleted
BIN_fnc_deconShowerCollision
BIN_fnc_deconShowerDeleteBIN_fnc_deconShowerDelete Delete all sound sources attachted to decon shower in case it is destroyed or deleted
BIN_fnc_deconShowerMove

Destroyer

BIS_fnc_destroyer01AnimateHangarDoors- This is a sub function designed to handle animations of ship hangar doors. Used in Eden attributes and objects user actions.
BIS_fnc_destroyer01EdenDelete- This is a sub function designed to delete dynamic ships (multi-part structure) in EDEN editor. Ship consists of multiple sub-objects that are…
BIS_fnc_destroyer01EdenInit- This is a sub function designed to assemble dynamic ship (multi-part structure) in EDEN editor. Ship consists of multiple sub-objects that are…
BIS_fnc_destroyer01GetShipPart- This is a helper function to get ship components (objects) by class name from stored array in ships master component's name-space…
BIS_fnc_destroyer01HandleDamage- This is a damage visual FX simulation function designed to animate ships bridge windows when shot. Due to engine limitation (damage simulation is…
BIS_fnc_destroyer01Init- This is a main function designed to assemble dynamic ship (multi-part structure). Ship consists of multiple sub-objects that are linked together…
BIS_fnc_destroyer01InitHullNumbers- This is a sub function designed to customize ships hull numbers.
BIS_fnc_destroyer01OperateHangarDoorsThis function is designed to handle animations of ship hangar doors from vehicle user action (see #Examples). It calls…
BIS_fnc_destroyer01PlayHangarDoorSound- This is a sub function designed to add sounds required for ship hangar door animation.
BIS_fnc_destroyer01PosUpdate- This is a sub function designed to update dynamic ships (multi-part structure) position in EDEN editor.

Diagnostic

BIN_fnc_debugDraw
BIN_fnc_debugDrawMapInit
BIN_fnc_debugText
BIN_fnc_isExtensionErrorReturns true and displays description of the error from extension if there was an error.
BIS_fnc_animViewerOpens the Splendid™ Animation Viewer.
BIS_fnc_cameraSplendid™ Camera, *"Ultimate Screenshot Simulator"*
BIS_fnc_cameraOldClassic camera script, replaced by the Splendid™ BIS_fnc_camera.
BIS_fnc_codePerformanceMeasures how much time it takes to execute given expression. Results may vary based on overall performance; use this function to compare alternative…
BIS_fnc_configViewerOpens the Splendid™ Config Viewer.
BIS_fnc_debugConsoleExecExecutes Debug Console code.
BIS_fnc_debugProfilePurges user profile from unwanted BIS_fnc_diagAAR data. If more than 7500 entries are found, the user is asked to delete profileNamespace variable…
BIS_fnc_deltaTimeCalculates and returns the time's delta between previous and current call to this function.
BIS_fnc_diagAARFill an AAR (After Action Review) display with data and Event Handlers.
BIS_fnc_diagAARrecordStarts recording units position and events for an AAR (After Action Review).
BIS_fnc_diagAnimDisplays or logs animation states: - animChanged - when action is performed (only to debug.log) - animDone - when animation chain that was started by…
BIS_fnc_diagBulletCamAdd a "bullet camera" to shots fired by the specified unit.
BIS_fnc_diagConfigPrints config entries.
BIS_fnc_diagFindMissingAuthorsCopies a list of objects to the clipboard which miss the author attribute.
BIS_fnc_diagHitTracks received wounds. (getNumber (missionConfigFile >> "diagHit") > 0) has to be true.
BIS_fnc_diagJIRAlink*N/A*
BIS_fnc_diagKeyTracks pressed keys. (getNumber (missionConfigFile >> "diagKey") > 0) has to be true.
BIS_fnc_diagKeyLayoutExports default key layout to wiki template.
BIS_fnc_diagKeyTestReturns all user actions according to mode.
BIS_fnc_diagKnownAsTargetVisualize and profile which units know about one specific unit and how much they do. Calling function again stops diagnostics.
BIS_fnc_diagKnownTargetsVisualize and profile which units one specific unit knows about and how much. Calling function again stops diagnostics.
BIS_fnc_diagLoopRuns scripted loop. Repeated call terminates previous loops.
BIS_fnc_diagMacrosExports config macros.
BIS_fnc_diagMacrosAuthor*N/A*
BIS_fnc_diagMacrosEditorPreview*N/A*
BIS_fnc_diagMacrosMapSizePrints mapSize values based on real object size and copies it to clipboard. Mission has to be running on order to get the values.
BIS_fnc_diagMacrosNameSoundDetects vehicle types and prints their radio protocol definitions to clipboard.
BIS_fnc_diagMacrosSimpleObjectGenerates simple object config data.
BIS_fnc_diagMacrosVerify*N/A*
BIS_fnc_diagMissionPositionsDisplays positions of units from all missions
BIS_fnc_diagMissionWeaponsLists all weapons and magazines available in a mission.
BIS_fnc_diagObjectPerformanceBenchmarks objects vs. simple objects performance and exports the data into .csv sheet.
BIS_fnc_diagPreviewPreviews selected classes from given container.
BIS_fnc_diagPreviewCyclePreviews selected class from the list. When cheat1 (?) is activated, classnames will be shown instead of display names.
BIS_fnc_diagPreviewVehicleCrewCreates vehicles with their crew.
BIS_fnc_diagRadioTracks played radio sentences.
BIS_fnc_diagVehicleIconsPreviews all vehicle icons on map.
BIS_fnc_diagWikiScans specific config folder and outputs the values in wiki format.
BIS_fnc_errorLogs an error message and shows an ingame error message. The message is shown when either of the following is true:
BIS_fnc_errorParamsTypeDisplays a parameter type error message (using BIS_fnc_error) explaining the problem.
BIS_fnc_exportCfgGroupsExport group or object composition for use in CfgGroups. The result will be copied to clipboard.
BIS_fnc_exportCfgHintsExports `CfgHints` to wiki format (see Category:Arma 3: Field Manual).
BIS_fnc_exportCfgMagazinesExport list of magazines for Arma 3 Assets.
BIS_fnc_exportCfgPatchesExport list of addons for Community Wiki - Arma 3 Assets.
BIS_fnc_exportCfgVehiclesExport list of objects for Community Wiki (Assets).
BIS_fnc_exportCfgVehiclesAssetDBCopies CfgVehicles information to clipboard in wiki format.
BIS_fnc_exportCfgWeaponsExport list of weapons for Community Wiki Arma 3 Assets Category.
BIS_fnc_exportConfigHierarchyExport config hierarchy of given config.
BIS_fnc_exportEditorPreviewsExport screenshots of objects for Eden Editor and Community Wiki to `<Arma 3 Profile>\Screenshots\EditorPreviews` directory. See Arma 3 assets.
BIS_fnc_exportFunctionsToWikiExport function descriptions to Community Wiki. Exported text will be copied to clipboard in XML format.
BIS_fnc_exportGroupFormations*N/A*
BIS_fnc_exportGUIBaseClassesExport GUI macros and base classes to the clipboard.
BIS_fnc_exportMapToBiTXTReturns terrain height map to BiTXT (Universal Bistudio TXT) format, which can be imported to Object Builder. Output is also copied to clipboard.
BIS_fnc_fpsFunction to measure FPS. Spawns code running for given time and displays result on screen via titleText, globalChat and diag_log. Variable…
BIS_fnc_functionMetaReturns function's meta data.
BIS_fnc_functionPathReturns path to function file.
BIS_fnc_functionsDebugChanges debug mode used when compiling functions from the Arma 3: Functions Library. Also recompiles all functions. See Arma 3: Functions Library for…
BIS_fnc_GCSends an entity to the garbage collection queue. Replaces Arma 2 Garbage Collector.
BIS_fnc_GCinitInitializes Garbage Collection.
BIS_fnc_helpOpens the Functions Viewer which lists all functions defined in: - Arma 2: Functions Library (Also Arma 2: Operation Arrowhead) - Arma 3: Functions…
BIS_fnc_importImageLinksImports CfgVehicles image links from the Community Wiki (https://community.bistudio.com/). 1. Run the script. It will copy a text into clipboard 1.…
BIS_fnc_isDebugConsoleAllowedReturns true if debug console is allowed in current context
BIS_fnc_isDemoReturns true when game version is demo.
BIS_fnc_loadFunctionsCompile scripts and save them into globally available functions. Defines _fnc_scriptName variable.
BIS_fnc_locWeaponInfoShows a utility tool checking length of weapon info texts.
BIS_fnc_logLog debug message.
BIS_fnc_logFormatDisplay debug message.
BIS_fnc_logFormatServerLogs (using diag_log) a debug message (profileName, playerUID, _fnc_scriptName, provided text) to server's .RPT. In singleplayer, BIS_fnc_logFormat…
BIS_fnc_preloadStart automatic loading screen upon mission start. On client, it will finish only when server is finished.
BIS_fnc_recompileCan be used to recompile functions.
BIS_fnc_shutdownShut downs the game.
BIS_fnc_traceBulletsVisualise unit's bullet trajectories. Can only be used on one shooter in a single instance.
BIS_fnc_versionDetects which Arma 2 expansions and addons are available. Only works in Arma 2/Arma 2: Operation Arrowhead.

Diary

BIN_fnc_deleteDiaryRecord
BIN_fnc_drawIconFixedSet fixed size marker to be drawn in main map
BIN_fnc_drawMap
BIN_fnc_drawProbeMap
BIN_fnc_drawSpectrum
BIN_fnc_drawTooltip
BIN_fnc_handDrawBezierShow hand-drawn bezier curve in the map
BIN_fnc_handDrawEllipseShow hand-drawn ellipse in the map
BIN_fnc_initInspectableDiaryRecord
BIN_fnc_selectDiaryCategory
BIN_fnc_selectDiaryRecord
BIN_fnc_selectDiaryTask
BIN_fnc_setDiaryRecord
BIN_fnc_showMapOptionsSelect which maps will be available
BIN_fnc_switchMap

Eden Editor

BIS_fnc_3DENAttributeDoorStatesInternal function used for the Eden Editor Edit Terrain Object module.
BIS_fnc_3DENCameraMoves Eden's camera depending on one of two modes: - "random" - A random position over land preferring non forested areas - "selected" - The current…
BIS_fnc_3DENControlsHintUsed by Eden to display control hints for the current Eden operation as seen in the bottom right corner of the Editor display.
BIS_fnc_3DENDiagCreateListCopies all in Eden Editor available objects to the clipboard.
BIS_fnc_3DENDiagFontsDisplays given font in various different sizes. The fontID is the index of the font in `configFile >> "CfgFontFamilies"`.
BIS_fnc_3DENDiagMouseControlCreates a display which highlights currently pressed mouse buttons and CTRL, ALT or SHIFT key.
BIS_fnc_3DENDrawLocationsInternal function used by Eden Editor to draw locations.
BIS_fnc_3DENEntityMenuExcutes actions available in the entity menu (context menu).
BIS_fnc_3DENExportAttributesCopies all available attributes to the clipboard.
BIS_fnc_3DENExportOldSQMExport current mission (usually in Eden Editor) in 2D Editor format to the clipboard.
BIS_fnc_3DENExportSQFExport 3DEN mission to SQF script. When called, the script will dynamically recreate the mission.
BIS_fnc_3DENExportTerrainBuilderGets all empty vehicles placed in the currently opened Eden mission and converts data into the format used by the Terrain Builder.
BIS_fnc_3DENFlashlightToggle or set Eden Editor flashlight (light source snapped to the camera).
BIS_fnc_3DENGridHandles action when grid button is pressed in the toolbar in Eden Editor.
BIS_fnc_3DENIntelIs used to set the weather settings in Eden Editor. Internal use only.
BIS_fnc_3DENInterface*N/A*
BIS_fnc_3DENListLocationsUsed in the locations display in Eden Editor. Internal use only.
BIS_fnc_3DENMissionPreview
BIS_fnc_3DENMissionStatsThis functions does nothing.
BIS_fnc_3DENModuleDescriptionUsed to display module description in the attribute window.
BIS_fnc_3DENNotificationShows notification banner with given text, animated or not, at the top of the screen in the Eden Editor.
BIS_fnc_3DENShowMessageShows a pop-up message. In order to skip any optional parameter in between other parameters, send nil as parameter.
BIS_fnc_3DENStatusBar*N/A*
BIS_fnc_3DENToolbarInteracts with the Eden Editor toolbar
BIS_fnc_3DENTutorialShow tutorial in Eden Editor.
BIS_fnc_3DENVisionModeToggle or set Eden Editor vision mode. Has to be executed while Eden interface is opened.
BIS_fnc_garage3DENThe code is identical to the one of BIS_fnc_garage, except that `FNC_IS3DEN` is set to 1. For more information about the garage, visit BIS_fnc_garage
BIS_fnc_initAmmoBox
BIS_fnc_initSliderValueInitialises a slider attribute control within the Eden Editor. Can also be used outside of Eden Editor.

Effects

BIN_fnc_circleSmokeMissile
BIS_fnc_effectFired*N/A*
BIS_fnc_effectFiredArtillery*N/A*
BIS_fnc_effectFiredCruiseMissileCruise Missile Start VFX BIS_fnc_effectFiredCruiseMissile
BIS_fnc_effectFiredFlaresArma 2 flares, by Maddmatt
BIS_fnc_effectFiredHeliRocket*N/A*
BIS_fnc_effectFiredRifleUsed to add an effect to fired bullets. Should be executed from Fired Event Handler.
BIS_fnc_effectFiredRocket*N/A*
BIS_fnc_effectFiredSmokeLauncherArma 2 smokscreen, by Maddmatt Uses code from VBS2 Smoke launcher by Philipp Pilhofer (raedor) & Andrew Barron
BIS_fnc_effectFiredSmokeLauncher_boatArma 2 smokscreen, by Maddmatt Uses code from VBS2 Smoke launcher by Philipp Pilhofer (raedor) & Andrew Barron
BIS_fnc_effectKilled*N/A*
BIS_fnc_effectKilledAirDestruction*N/A*
BIS_fnc_effectKilledAirDestructionStage2*N/A*
BIS_fnc_effectKilledSecondaries<pre>//Small secondary fuel explosions //By Maddmatt for Arma 2
BIS_fnc_effectPlanktonCreate underwater plankton particle effect.

EM Interface

Environment

BIS_fnc_calculateDateTimeReturns the end datetime if an offset is passed, or the offset between start and end dates.
BIS_fnc_compareDateTimesReturns the newer date or returns true if they are identical.
BIS_fnc_createRuinCreate a building ruin and hide the original object.
BIS_fnc_crowsSpawns flock of crows circling the area.
BIS_fnc_destroyCityDestroys building in given area based on input seed.
BIS_fnc_earthquakeEarthquake simulated through camera shake and sound. Stamina is impacted by the earthquake too. Earthquake will last between 13 and 20 seconds.
BIS_fnc_fixDateChecks the array with date data and makes sure the values are within the boundries.
BIS_fnc_fliesSpawns flies around position.
BIS_fnc_interpolateWeatherInterpolate weather (overcast and fog) according to 2 boundry dates and their weather conditions.
BIS_fnc_isDateTimeNewerReturns true if the first passed datetime is newer than the second one.
BIS_fnc_isLeapYearReturns true if given year is a leap year, otherwise false.
BIS_fnc_monthDaysReturns number of days in given month. Takes in account for leap year.
BIS_fnc_sandstormCreates particle sandstorm round given object.
BIS_fnc_setDateInstantly set date and share it across network with optional transition effect.
BIS_fnc_setFogInstantly set weather conditions and share it across network.
BIS_fnc_setOvercastInstantly set weather conditions and share it across network. Must be executed in scheduled environment.
BIS_fnc_setRainA helper function for setting rainParams in multiplayer. The call to the function could be placed in init.sqf to sync rainParams between all clients…
BIS_fnc_showTimeShows time gap between two dates.
BIS_fnc_sunriseSunsetTimeCalculate sunrise and sunset time.

Event Handlers

BIS_fnc_addScriptedEventHandlerAdds a Scripted Event Handler and returns its ID. Additionally, the "ScriptedEventHandlerAdded" Scripted EH is called. For the full list of all…
BIS_fnc_addStackedEventHandlerStacks an event handler. All event handlers accept user arguments, which are passed to the EH code in `_this` variable.
BIS_fnc_callScriptedEventHandlerCalls all the codes assigned to scripted event handler with given name. Since Arma 3 v1.68 the code receives current EH id in the special variable:…
BIS_fnc_executeStackedEventHandlerThis function executes the stacked items.
BIS_fnc_onDiaryChangedRegister code to be executed when diary item changes.
BIS_fnc_onEndRegister code to be executed after mission end.
BIS_fnc_onLoadRegister code to be executed after a mission load (from a save, for example).
BIS_fnc_onPlayerConnectedExecutes a function on server every time a player connects the mission.
BIS_fnc_removeAllScriptedEventHandlersRemoves all scripted event handler with given name. Additionally "ScriptedEventHandlerRemoved" scripted EH is called for every removed event handler.
BIS_fnc_removeScriptedEventHandlerRemoves scripted event handler with given name and id. Additionally "ScriptedEventHandlerRemoved" scripted EH is called.
BIS_fnc_removeStackedEventHandlerRemoves a stacked event handler with specified custom id.
BIS_fnc_shakeMapEHEvent handler function for the shakeMap.sqf function
BIS_fnc_zoomLockEHEvent handler function for locking the camera.

Feedback

BIS_fnc_bloodEffectAdds the bleeding effect post-processing effect to the players screen.
BIS_fnc_damageChangedHandle effects caused by changing of damage.
BIS_fnc_damagePulsingGame pulsing damage effect.
BIS_fnc_dirtEffectScreen dirt (texture) postprocess. Displays dust PP according to damage obtained from near explosion; takes array from "Explosion" event handler.
BIS_fnc_fatigueEffectEffects for high fatigue values. Internal engine use only, as it relies on internal BIS_* variables.
BIS_fnc_feedbackInitInit function for feedback system. Declaration of variables, eventhandlers, etc. for in-game effects. Engine use only.
BIS_fnc_feedbackMainMain feedback FSM, used for feedback effects (fatigue, drowning, injury etc.). Internal use only.
BIS_fnc_flamesEffectFlames (texture) postprocess.
BIS_fnc_healingHealing postprocess. Supposed to give healing postprocess effects.
BIS_fnc_healthEffectsEffects when player is hit. Parameters are sent by the HandleDamage event handler.
BIS_fnc_incapacitatedEffectA draft of incapacitated effects function.
BIS_fnc_indicateBleedingShows a PP effect which indicates bleeding.
BIS_fnc_radialRedRed radial postprocess (hit damage, fire damage). Parameters are the same as the first four of HandleDamage EH.
BIS_fnc_radialRedOutRemoves red radial postprocess (fire damage) created by BIS_fnc_radialRed.

Geometry

BIN_fnc_distanceToAreaBorder
BIS_fnc_dirToFunction which returns vector direction from pos1 to pos2.
BIS_fnc_distance2DReturns the distance between two objects or positions.
BIS_fnc_distance2DsqrReturns the SQUARE of the distance between the two objects or positions "as the crow flies" (ignoring elevation).
BIS_fnc_getAngleDeltaReturns the smallest difference between two angles in degrees.
BIS_fnc_getAreaExtracts area information from trigger, marker, location or array
BIS_fnc_getIntersectionsUnderCursorReturns intersections under cursor. For more information see lineIntersectsSurfaces.
BIS_fnc_getLineDistReturn the distance between two sections of a virtual straight line.
BIS_fnc_inAngleSectorChecks if a position lies within an angle sector.
BIS_fnc_isInFrontOfCheck if an object is in front of another object (in the front 180°)
BIS_fnc_isInsideAreaDetects whether a position is within a square area of given size about center.
BIS_fnc_nearestPointComputes nearest point in a line.
BIS_fnc_randomPosIntersectionReturns random 2D position inside the intersection of two circles. [-1,-1] is returned if the circles do not intersect.
BIS_fnc_relativeDirToReturns the relative direction from object 1 to object/position 2. Return value is always in between 0 and 360.
BIS_fnc_relPosReturns a position that is a specified distance and compass direction from the passed position or object.
BIS_fnc_relPosObjectPlace an object relative to another object, like a *setRelPos* command.
BIS_fnc_relScaledDistExponentially inflated rational number between 0 and 1, with 1 being center and 0 being edge of the trigger. This function can be used to check where…
BIS_fnc_terrainGradAngleReturns the gradient angle (in radians) of the terrain at a specified position and a compass direction. It is an angle of the slope of a tangent…

GUI

BIN_fnc_addButtonEvents*N/A*
BIN_fnc_callButtonEvent
BIN_fnc_showHorizontalCompassShow or hide horizontal compass
BIS_fnc_3DcreditsDisplays structured text in 3D world. GUI layer for indicator is `2733`.
BIS_fnc_AANAdd an AAN overlay to the screen, with one headline and a rolling text on the bottom.
BIS_fnc_advHintShows advanced hint to player.
BIS_fnc_advHintArgAdvanced hint arguments preprocess.
BIS_fnc_advHintCallAdvanced hint call, creates hint itself.
BIS_fnc_advHintCreditsAdvanced hint credits preprocessor.
BIS_fnc_advHintFormatReturn formatted texts of a CfgHints hint.
BIS_fnc_blackInUnregister a black screen. When none other black screen is registered, fade it out.
BIS_fnc_blackOutRegister a black screen. Start the black screen when the first request is registered.
BIS_fnc_cinemaBorderCreates cinematic borders. Player cannot move during cutscene.
BIS_fnc_controlConfigsReturn config paths to all display controls.
BIS_fnc_createLogRecordCreate a dated, timed diary record in the owner's "Log" subject.
BIS_fnc_createTooltipShows group tooltip. Adapted for Tac Ops DLC for use in the animated briefings.
BIS_fnc_creditsOpens credits, identical to those found in main menu (Arma 3). Also present in Arma 3.
BIS_fnc_credits_movieMovie credits function.
BIS_fnc_credits_movieConfigMovie credits config preprocessor.
BIS_fnc_credits_movieSupportMovie credits supporters preprocessor.
BIS_fnc_ctrlFitToTextHeightResize structured text control to fit its text height.
BIS_fnc_ctrlSetScaleScale a control while maintaining its centering.
BIS_fnc_ctrlTextHeightResize control according to it is text.
BIS_fnc_customGPSReplaces GPS frame.
BIS_fnc_customGPSVideoPlays in-game video in GPS frame.
BIS_fnc_diaryHints<pre>#define DIARY_CATEGORY "BIS_fnc_diaryHints"
BIS_fnc_diaryMaps<pre>#define DIARY_CATEGORY "BIS_fnc_diaryMaps"
BIS_fnc_dirIndicatorShow a 4-directions indicator.
BIS_fnc_displayClouds<pre>#define DISPLAY (uinamespace getvariable 'hsim_RscClouds') 1. define CONTROL (DISPLAY displayctrl _idc) 1. define RSC_LAYER 759
BIS_fnc_displayColorGetLoads custom color settings from CfgUIDefault.
BIS_fnc_displayColorSetApplies custom color settings to given Display.
BIS_fnc_displayControlsReturn all controls of given display class
BIS_fnc_displayLoadingLoading Screens init.
BIS_fnc_displayMissionReturns main display of current mission/intro/outro. A cleaner alternative to `findDisplay 46`.
BIS_fnc_displayResize*N/A*
BIS_fnc_dynamicTextShows dynamic opening credits or any type of text.
BIS_fnc_endLoadingScreenUnregister a loading screen. When none other remains, end the loading.
BIS_fnc_establishingShotPlays a fake UAV observational sequence which serves as an establishing shot.
BIS_fnc_EXP_camp_IFFSimple handling of the Support Team's scripted IFF.
BIS_fnc_EXP_camp_playSubtitlesDisplays the given subtitles at the correctly defined moments. Each array added to the parameters represents one subtitle.
BIS_fnc_EXP_camp_SITREPDisplays multiple lines of text in given order.
BIS_fnc_exportGUIBaseClassesExport GUI macros and base classes to the clipboard.
BIS_fnc_fadeEffectEasily carry out complex fading. Default values will be used if parameters are not defined or set to nil.
BIS_fnc_getIDCReturns IDD of given display.
BIS_fnc_getIDDReturns IDD of given display.
BIS_fnc_groupIndicatorDisplays Group Indicator (to the right of the screen in Arma 3 v1.82)
BIS_fnc_GUIbackgroundCreates GUI background.
BIS_fnc_GUIeditorOpens the Arma 3: User Interface Editor.
BIS_fnc_guiEffectTilesUsed in dialogs to animate background UAV tiles. See notes for a full working example.
BIS_fnc_GUIgridReturns grid params and stores it into uiNamespace.
BIS_fnc_GUIgridToProfile
BIS_fnc_GUIhintCreates advanced hintC dialog
BIS_fnc_guiMessageDisplays an interactive message dialog in the center of the screen.
BIS_fnc_GUInewsfeedLoad newsfeed.
BIS_fnc_highlightControlHighlights given control by drawing a border around it and letting it pulsate. The effect is visible until explicitly removed.
BIS_fnc_HUDLimitsSet helicopter advanced flight model HUD limits and prevents overwriting existing values. See also setHUDMovementLevels.
BIS_fnc_infoTextDisplay a text in the "mission" GUI area with some effects. Good for the beginning of a mission.
BIS_fnc_initDisplayThis function is a central part of how BI handles UIs. For a full explanation see this page.
BIS_fnc_initListNBoxSortingAutomatically creates buttons and sets them up so they can be used to sort a CT_LISTNBOX. The buttons will automatically be resized to fit the column…
BIS_fnc_isLoadingCheck if a loading screen is opened.
BIS_fnc_keyCodeReturns DIK code of a given key.
BIS_fnc_overviewAuthorReturns the mission author's name preceded by "by", e.g "by Username". See Description.ext#author.
BIS_fnc_overviewDifficulty*N/A*
BIS_fnc_overviewMission<pre>#define CONTROL_SHOW(CONTROL) \ CONTROL ctrlshow true; \ CONTROL ctrlsetfade 0; \ CONTROL ctrlcommit 0;
BIS_fnc_overviewTerrain*N/A*
BIS_fnc_overviewTimeTrialReturns the dynamically composed overview text for Time Trial scenarios.
BIS_fnc_PIPDisplays Picture in Picture.
BIS_fnc_playVideoPlays in-game video with a range of options. The function can be called or spawned. If spawned, scriptDone command can be used to see if video is…
BIS_fnc_progressLoadingScreenProgress scripted loading screen. The value will be preserved even when a new screen is opened.
BIS_fnc_quotationsDisplay a quotation video.
BIS_fnc_rscLayerRegister RSC layer and returns a unique ID.
BIS_fnc_setIDCStreamFriendlyShows or hides UI control according to state of the Stream Friendly UI switch in Game Options.
BIS_fnc_shakeGaugesShake analogue gauges
BIS_fnc_showAANArticleShow an AAN article.
BIS_fnc_showMarkersShow or hide given markers using fade effect.
BIS_fnc_showNotificationShow a config-defined notification.
BIS_fnc_showSubtitleDisplays a subtitle at the bottom of the screen.
BIS_fnc_showUnitInfoHides or shows weapon information. Also hides *grenades* information.
BIS_fnc_showWelcomeScreenShow welcome screen. Used in the main menu (works fine in Eden Editor).
BIS_fnc_textTilesShows an animated text with background tiles.
BIS_fnc_titlecardDisplay a mission-specific titlecard before the mission begins. Only works the first time it is called.
BIS_fnc_titleTextDisplay given string as structured text.
BIS_fnc_toUpperDisplayTextsConverts text of selected classes in one display to upper-case except classes with name PlayersName. Also searches inside CT_CONTROLS_GROUPs.
BIS_fnc_typeTextTypes a structured text on the screen, letter by letter, cursor blinking.
BIS_fnc_typeText2Types a structured text on the screen, letter by letter, cursor blinking. Note that line returns are manual, unlike BIS_fnc_typeText.
BIS_fnc_versionInfoFills the first passed control with game type and version number, and positions both controls according to the game type.
BIS_fnc_WLSmoothTextDisplay given text smoothly.

Helicopters

BIS_fnc_helicopterCanFly*N/A*
BIS_fnc_helicopterDamageHandling EH-based helicopter damage, event handler in question being Da*mm*aged [sic].
BIS_fnc_helicopterGetHitpointsReturn all hitpoints for a helicopter.
BIS_fnc_helicopterSeatCheck if unit sits on right or left seat.
BIS_fnc_helicopterSeatMovePlays cockpit animation. Take On Helicopters only.
BIS_fnc_helicopterTypeReturns helicopter type.

IDWMap

BIN_fnc_addIDWMapMeasurementPointAdds measurement point to IDWMap
BIN_fnc_allIDWMapMeasurementPointsRetrieves user measurements data with strengths
BIN_fnc_clearIDWMapClears IDWMap on the main map
BIN_fnc_diag_IDWMapAdds user action menu to the player with different IDWMap diag options
BIN_fnc_drawIDWMapDraws IDWMap on the main map
BIN_fnc_getIDWMapDrawColorSetGets stored draw colors
BIN_fnc_getIDWMapDrawPatternIndexGets stored draw pattern index
BIN_fnc_getIDWMapParamsReturns currently set IDWMap params
BIN_fnc_getIDWMapSaveData<pre>/* Killzone_Kid
BIN_fnc_getIDWMapStaticDataLayersGets static data from extension
BIN_fnc_loadIDWMapLoads IDWMap data from global variable 'BIN_fnc_IDWMap_saveData' into extension
BIN_fnc_preInitIDWMapShould be called from preInit, contains saving/loading functions as well as default initisalization
BIN_fnc_saveIDWMapSaves IDWMap data into global variable 'BIN_fnc_IDWMap_saveData' so that it can be serialised and then loaded from game save when needed
BIN_fnc_setIDWMapDrawColorSetSets map draw color set
BIN_fnc_setIDWMapDrawPatternIndexSets map draw pattern
BIN_fnc_setIDWMapParamsResets extension data, sets IDWMap params from argument, from config or default * This function must be called before any data is added to the IDWMap…
BIN_fnc_setIDWMapStaticDataLayersSets static data for extension use from argument or config "CfgIDWMap"
BIN_fnc_updateIDWMapDrawDataRetrieves draw data for IDWMap and stores it in 'IDWMapDrawData' variable on map control for use in 'Draw' event handler. Should be called in…

Interaction

BIS_fnc_escortAI*N/A*
BIS_fnc_escortAIHoldAction*N/A*
BIS_fnc_holdActionAddAdds an action to an object which requires the user to hold a key to perform the action.
BIS_fnc_holdActionRemoveRemoves a hold action. This does exactly the same as removeAction.
BIS_fnc_holdKeyFunction that executes code when a key has been held down for a long enough time - "Hold X to Advance" text is displayed when any key is pressed.
BIS_fnc_initInspectableInitialize inspectable object: add "Inspect" action to the object. When a player activates it, full-screen detail of the objects is shown.
BIS_fnc_initIntelObjectThis function sets up an object as intel retrievable by the players by adding a "Take Intel" addAction to it.
BIS_fnc_initLeafletInitialise interactive leaflet.
BIS_fnc_keyHoldAllows for hold button interactions. Hold action is started by pressing <kbd>Space</kbd>.
BIS_fnc_lookAtArrayExecutes a code when one of the specified objects is looked at (player's cursor pointed towards it) for enough time
BIS_fnc_lookAtArrayEHEvent handler function for the BIS_fnc_lookAtArray function.
BIS_fnc_showAANArticleShow an AAN article.
BIS_fnc_targetHandles the shooting targets in the Bootcamp DLC, statistics, animation, etc. (targets such as `TargetBootcampHuman_f`)

Interpolation

BIN_fnc_bezierCalculate bezier curve
BIN_fnc_bezierAverage
BIN_fnc_bezierBoundingBox
BIN_fnc_bezierEditor
BIN_fnc_bezierNormalize
BIN_fnc_bezierVelocityCalculate bezier curve velocity
BIS_fnc_berpDerivative of the Kelvin function ber).
BIS_fnc_berpVectorWrapper for BIS_fnc_berp applying to each respective element of current and target vectors.
BIS_fnc_bezierInterpolate*N/A*
BIS_fnc_bezierInterpolateVector*N/A*
BIS_fnc_bezierLength*N/A*
BIS_fnc_bounceIn*N/A*
BIS_fnc_bounceInOut*N/A*
BIS_fnc_bounceInOutVector*N/A*
BIS_fnc_bounceInVector*N/A*
BIS_fnc_bounceOut*N/A*
BIS_fnc_bounceOutVector*N/A*
BIS_fnc_clerpCLerp - Circular Lerp - is like lerp but handles the wraparound from 0 to 360 This is useful when interpolating eulerAngles and the object crosses…
BIS_fnc_easeInWraps BIS_fnc_lerp.
BIS_fnc_easeInOut*N/A*
BIS_fnc_easeInOutVector*N/A*
BIS_fnc_easeInVector*N/A*
BIS_fnc_easeOut*N/A*
BIS_fnc_easeOutVector*N/A*
BIS_fnc_hermite*N/A*
BIS_fnc_hermiteVector*N/A*
BIS_fnc_interpolateInterpolates scalar to target, starts fast, eases out
BIS_fnc_interpolateConstantInterpolates scalar to target linearly.
BIS_fnc_interpolateVectorInterpolates vector to target, scaled by distance. Starts very fast and smoothes out.
BIS_fnc_interpolateVectorConstantInterpolates vector to target linearly.
BIS_fnc_inverseLerpInverse of BIS_fnc_lerp.
BIS_fnc_lerpLinear floating point interpolation (see Linear Interpolation).
BIS_fnc_quinticIn*N/A*
BIS_fnc_quinticInOut*N/A*
BIS_fnc_quinticInOutVector*N/A*
BIS_fnc_quinticInVector*N/A*
BIS_fnc_quinticOut*N/A*
BIS_fnc_quinticOutVector*N/A*
BIS_fnc_slerpSpherical lerp, for correct lerping of normalized direction vectors
BIS_fnc_smoothStepInterpolates between 0 and 1 with smoothing at the limits. Formula is `n2 × (3 - 2n)`.

Inventory

BIS_fnc_addVirtualBackpackCargoAdd virtual backpacks to an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_addVirtualItemCargoAdd virtual items to an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_addVirtualMagazineCargoAdd virtual magazines to an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_addVirtualWeaponCargoAdd virtual weapons to an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_addWeaponAdds a weapon to the specified unit, with magazine classnames taken from the weapon's config (in CfgWeapons).
BIS_fnc_arsenalFunction used for the Virtual Arsenal. The function features four different modes, each mode comes with its own parameters.
BIS_fnc_basicBackpackDetermines basic backpack with no equipment present (ie empty).
BIS_fnc_compatibleItemsReturn all compatible weapon attachments.
BIS_fnc_deleteInventoryDelete loadout saved using BIS_fnc_saveInventory.
BIS_fnc_exportInventoryExports unit's loadout as a String, also copies it to clipboard.
BIS_fnc_getVirtualBackpackCargoGet virtual backpacks from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_getVirtualItemCargoGet virtual items from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_getVirtualMagazineCargoGet virtual magazines from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_getVirtualWeaponCargoGet virtual weapons from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_hasItemReturns true if object contains given item in inventory / cargo storage.
BIS_fnc_invReturns inventory contents of given vehicle (unit). For vehicles it returns mounted gun and its ammo, not cargo weapons and ammo.
BIS_fnc_invAddAdds item to inventory - checks if there is room for it. Checks if add was done by engine.
BIS_fnc_invCodeToArrayConverts inventory code (used in configs) to array with numbers for weapons and magazines (and their counts).
BIS_fnc_inventoryExistsCheck if loadout with given name exists.
BIS_fnc_invRemoveRemoves from inventory. Given number of items. Returns actually removed items count.
BIS_fnc_invSlotsReturns config inventory slots of given unit (total numbers of available slots in array).
BIS_fnc_invSlotsEmptyReturns empty inventory slots of given unit.
BIS_fnc_invSlotTypeReturns empty inventory slots of given unit.
BIS_fnc_invStringReturns inventory contents of given vehicle (unit).
BIS_fnc_isThrowableReturns true if given magazine is throwable.
BIS_fnc_itemTypeReturns item category and type.
BIS_fnc_limitAmmunitionLimits the number of magazines carried by individual unit. Each container (uniform, vest and backpack) can be limited separately or left untouched.
BIS_fnc_limitItemsKeeps or removes unit's items (including NVGs and binocular/designator) based on probability user sets.
BIS_fnc_limitWeaponItemsKeeps or remove unit's weapon attachments based on probability user sets. Apply for primary, secondary or handgun weapon separately.
BIS_fnc_loadInventoryAdds a predefined loadout (either via `CfgVehicles`, `CfgRespawnInventory`, or a custom inventory saved via BIS_fnc_saveInventory) to a specified…
BIS_fnc_removeVirtualBackpackCargoRemove virtual backpacks from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_removeVirtualItemCargoRemove virtual items from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_removeVirtualMagazineCargoRemove virtual magazines from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_removeVirtualWeaponCargoRemove virtual weapons from an object (e.g., ammo box). Virtual items can be selected in the Arsenal.
BIS_fnc_saveInventorySave unit's loadout.
BIS_fnc_unitHeadgearRandomise headgear and facewear of a character.

Key

BIS_fnc_key_computeComputes data for a key
BIS_fnc_key_computeOwnerCurveComputes the curve that owns key
BIS_fnc_key_computeTimeComputes the time of given key
BIS_fnc_key_getArriveControlPointReturns the arrive control point of a key
BIS_fnc_key_getArriveTangentReturns the key arrive tangent
BIS_fnc_key_getArriveTangentWeightReturns the key arrive tangent weight
BIS_fnc_key_getConfigTimeReturns the time of given key
BIS_fnc_key_getFOVReturns the FOV value of a key
BIS_fnc_key_getInterpModeReturns the key interp mode index 0 - Linear 1 - Cubic 2 - EaseIn 3 - EaseOut 4 - EaseInOut 5 - Hermite 6 - Berp 7 - BounceIn 8 - BounceOut 9 -…
BIS_fnc_key_getLeaveControlPointReturns the leave control point of key
BIS_fnc_key_getLeaveTangentReturns the key leave tangent
BIS_fnc_key_getLeaveTangentWeightReturns the key leave tangent weight
BIS_fnc_key_getOwnerCurveReturns the curve that owns key
BIS_fnc_key_getTimeReturns the time of given key
BIS_fnc_key_getValueReturns the value of given key
BIS_fnc_key_isFloatReturns true if this is a key with float value, false if not
BIS_fnc_key_isVectorReturns true if this is a key with vector value, false if not
BIS_fnc_key_setArriveTangentSet's the key arrive tangent
BIS_fnc_key_setArriveTangentWeightSet's the key arrive tangent weight
BIS_fnc_key_setInterpModeSet's the interpolation mode of the key
BIS_fnc_key_setLeaveTangentSet's the key leave tangent
BIS_fnc_key_setLeaveTangentWeightSet's the key leave tangent weight
BIS_fnc_key_setTimeSet's the time of given key
BIS_fnc_key_setValueSet's the value of given key

Key3DEN

BIS_fnc_key_edenAreControlPointsLockedWhether control points of given key are set to locked
BIS_fnc_key_edenAttributesChangedAttributes change in EDEN for a key
BIS_fnc_key_edenConnectionChangedAttributes change in EDEN for a key
BIS_fnc_key_edenDraggedEntity is dragged in 3DEN
BIS_fnc_key_edenIsSelectedWhether given key is selected in 3den
BIS_fnc_key_edenRegisteredToWorldAttributes change in EDEN for a key
BIS_fnc_key_edenUnregisteredFromWorldAttributes change in EDEN for a key

KeyframeAnimation

BIS_fnc_3den_initUsed internally by the Key Frame Animation system. Adds needed event handlers.
BIS_fnc_3den_onKeyDownUsed internally by the Arma 3: Key Frame Animation system. Called when a button is pressed.
BIS_fnc_3den_onKeyUpUsed internally by the Key Frame Animation system. Called when a button is released.
BIS_fnc_3den_onMissionLoadUsed internally by the Key Frame Animation system. Executed when a new mission is loaded.
BIS_fnc_3den_onMissionNewUsed internally by the Key Frame Animation system. Executed when a new mission is created.
BIS_fnc_3den_onMissionPreviewEndUsed internally by the Key Frame Animation system. Executed when preview ended.
BIS_fnc_3den_onSelectionChangeUsed internally by the Key Frame Animation system.
BIS_fnc_keyframeAnimation_deltaTime*N/A*
BIS_fnc_keyframeAnimation_init*N/A*

Live Feed

BIS_fnc_liveFeedDisplay a live feed.
BIS_fnc_liveFeedEffectsAdd effect to the current live feed.
BIS_fnc_liveFeedSetSourceSet the source of the current live feed.
BIS_fnc_liveFeedSetTargetSet the target of the current live feed.
BIS_fnc_liveFeedTerminateTerminate a live feed.

Map and Markers

BIS_fnc_blinkMarkerMakes given marker blink.
BIS_fnc_cancelMarkerCancels a marker by a red 'X' marker. Also sets its variable to "Canceled" to true.
BIS_fnc_changeColorMarkerMakes the marker go from its original color to a specified color over time
BIS_fnc_colorMarkerChanges color of a marker with a little effect
BIS_fnc_drawAODraws a dashed line around the outer edges of a trigger.
BIS_fnc_drawArrowDraws a static arrow (outline or color filled) on map. See #Example 4 for arrow removal.
BIS_fnc_drawMinefieldsDraw minefields on the map. Dynamically calculated from all mines positions. Distinguishes AP and AT minefields.
BIS_fnc_getAreaExtracts area information from trigger, marker, location or array
BIS_fnc_getBorderMarkersRetrieves marker names used in the border restrictions module.
BIS_fnc_getMarkersReturns markers in format PREFIX_N where PREFIX_ is the provided argument and N is an integer between 1 and 128. If there are 128 markers but marker…
BIS_fnc_getMarkerStateReturns the state of a marker.
BIS_fnc_hideMarkerGradual hiding of a marker by setting its alpha to 0.
BIS_fnc_hideMarkerArrayHides a list of markers one by one.
BIS_fnc_isInZoomChecks if map zoom level is in between given interval.
BIS_fnc_keypointsExport*N/A*
BIS_fnc_keypointsExportFromKMLImports and marks positions from KLM file.
BIS_fnc_KMLimportRead positions from a KML file.
BIS_fnc_locationDescriptionReturn location description (e.g. "NE of Agia Marina")
BIS_fnc_mapAnimAddSimilar to mapAnimAdd, yet it provides additional parameters to allow for a non-linear zoom and various position interpolation modes.
BIS_fnc_mapAnimClearSame as mapAnimClear
BIS_fnc_mapAnimDoneSame as mapAnimAdd but with possibility for non linear zoom and position interpolation modes
BIS_fnc_mapGridSizeReturns the size of map grid square at current zoom level.
BIS_fnc_mapSizeReturns map size from config. Do not confuse with worldSize. The engine command calculates the map size and doesn't read it from config.
BIS_fnc_markerCreateCreates marker with given params. Reads config to recognize settings - use for quick debugging only.
BIS_fnc_markerParamsReturns marker params in format compatible with BIS_fnc_markerCreate.
BIS_fnc_markerPathCreate marker(s) between two points.
BIS_fnc_markerToStringConverts existing marker to String, for example: `"|marker_0|[3799.0110,2781.9880,0.0000]|mil_pickup|ICON|[1,1]|0|Solid|Default|1|You are here"`
BIS_fnc_markerToTriggerMakes an existing or new marker cover a trigger area.
BIS_fnc_markWaypointsCreates a marker on each uncompleted waypoint and marks it checked after completing that WP.
BIS_fnc_moduleCoverMapCovers the map except for a defined area. This function was designed to be used by the Modules framework, but it can also be used without the module.…
BIS_fnc_moveMarkerMoves marker to a new position
BIS_fnc_nearestHelipadFinds the nearest helipad of given type.
BIS_fnc_noFlyZone*N/A*
BIS_fnc_noFlyZonesCreate*N/A*
BIS_fnc_noFlyZonesExport*N/A*
BIS_fnc_posDegToUTMGenerate a UTM Zone, Easting and Northing from lat and long fields. It uses NAD83 constants.
BIS_fnc_posDegToWorldConvert latitude/longtitude coordinates into game world position.
BIS_fnc_posUTMToDegGenerate Lat and Long fields from UTM Zone, Easting and Northing. It uses NAD83 constants.
BIS_fnc_randomPosTriggerSelects random position within trigger, marker, location area or area defined by array
BIS_fnc_resizeMarkerResize marker. Use either absolute values or proportional values.
BIS_fnc_rotateMarkerRotating a marker to new azimuth, using shortest turn, clockwise or anticlockwise movement.
BIS_fnc_shakeMap"Camera shake" function for the map. Shakes the map for a given amount of time with a given amount of force around the given camera center. Exits if…
BIS_fnc_shakeMapEHEvent handler function for the shakeMap.sqf function
BIS_fnc_showMarkerGradual revealing of a marker by setting its alpha to its original alpha or to a user-specified alpha.
BIS_fnc_showMarkerArrayUnhide the markers sequentially.
BIS_fnc_simpleMoveMarkerMove the provided marker to a new position. Simple version of BIS_fnc_moveMarker.
BIS_fnc_stringToMarkerConverts serialized data from BIS_fnc_markerToString into a global map marker
BIS_fnc_stringToMarkerLocalConverts serialized data from BIS_fnc_markerToString into a local map marker.
BIS_fnc_textureMarkerChecks whether texture is defined in CfgMarkers and if so, returns the marker texture.
BIS_fnc_triggerToMarkerMakes an existing or new trigger cover a marker area.
BIS_fnc_worldAreaCreates (or returns if it already exists) trigger with size of map.
BIS_fnc_zoomLockLocks the camera in place when the map is open.
BIS_fnc_zoomLockEHEvent handler function for locking the camera.
BIS_fnc_zoomOnAreaMap will zoom on the given area. Function always takes the longer side of the area to zoom on.
BIS_fnc_zoomUnlockFunction that unlocks the camera in which has been previously locked with BIS_fnc_zoomLock.

Math

BIS_fnc_arithmeticMeanReturns the arithmetic mean) ("average value") of an array of numbers.
BIS_fnc_clampClamps provided value within min..max range.
BIS_fnc_convertUnitsConverts values to a target system of units.
BIS_fnc_cutDecimalsFunction that rounds specified number to specified amount of decimals.
BIS_fnc_deltaTimeCalculates and returns the time's delta between previous and current call to this function.
BIS_fnc_findExtremeReturns the minimum or maximum value in an array of numbers.
BIS_fnc_fixDateChecks the array with date data and makes sure the values are within the boundries.
BIS_fnc_geometricMeanReturns the geometric mean of an array of numbers.
BIS_fnc_greatestNumReturns the greatest number out of the passed set.
BIS_fnc_HEXtoRGBConvert RGBA hexcode color into RGBA array format.
BIS_fnc_isLeapYearReturns true if given year is a leap year, otherwise false.
BIS_fnc_linearConversionLinear conversion of a value from one set to another
BIS_fnc_lowestNumReturns the lowest number out of the passed set.
BIS_fnc_monthDaysReturns number of days in given month. Takes in account for leap year.
BIS_fnc_nearestNumReturns the provided set closest number to the target number.
BIS_fnc_numberTextConvert a number into string (avoiding scientific notation).
BIS_fnc_parseNumberReturn number from expression
BIS_fnc_powReturn value1 raised to the power of value2. Identical to a ^ b.
BIS_fnc_pulsatePulsates a value from 0 to 1.
BIS_fnc_randomIntReturns a random integer between the two passed numbers (inclusive). The order of parameters doesn't matter: it can be `[min, max]` or `[max, min]`.
BIS_fnc_randomNumReturns a random (float) number between the two passed numbers. The order of parameters doesn't matter: it can be `[min, max]` or `[max, min]`.
BIS_fnc_romanNumeralConvert integer to roman numerals (e.g. 42 becomes "XLII").
BIS_fnc_roundDirRound direction to nearest set rounding; used for determining cardinal direction.
BIS_fnc_roundNumRound a number to the provided factor.

Mission Parameters

BIS_fnc_getParamValueReturns the value of the named mission parameter. This function is global and will return selected param value on any PC including JIP. For backward…
BIS_fnc_initParamsInitialize mission params and create log in the diary.
BIS_fnc_paramCountdownSet side mission time.
BIS_fnc_paramDaytimeSets time of the day to the hour. Minutes will always be zero.
BIS_fnc_paramGuerFriendlySet relationship between Independents and remaining sides.
BIS_fnc_paramRespawnTicketsSet side respawn tickets.
BIS_fnc_paramReviveBleedOutDurationGrabs server param into global variable. (bis_reviveParam_bleedOutDuration)
BIS_fnc_paramReviveDurationGrabs server param into global variable. (bis_reviveParam_duration)
BIS_fnc_paramReviveForceRespawnDurationGrabs server param into global variable. (bis_reviveParam_forceRespawnDuration)
BIS_fnc_paramReviveMedicSpeedMultiplierGrabs server param into global variable. (bis_reviveParam_medicSpeedMultiplier)
BIS_fnc_paramReviveModeGrabs server param into global variable. (bis_reviveParam_mode)
BIS_fnc_paramReviveRequiredItemsGrabs server param into global variable. (bis_reviveParam_requiredItems)
BIS_fnc_paramReviveRequiredTraitStores the provided value in the global `BIS_reviveParam_requiredTrait` mission variable.
BIS_fnc_paramReviveUnconsciousStateModeGrabs server param into global variable. (bis_reviveParam_unconsciousStateMode)
BIS_fnc_paramTimeAccelerationManages setTimeMultiplier Multiplayer setting (set with paramTimeAcceleration.hpp)
BIS_fnc_paramViewDistanceSet view distance.
BIS_fnc_paramWeatherSets overcast using BIS_fnc_setOvercast.
BIS_fnc_storeParamsValuesParses mission params and stores them into public variable "BIS_fnc_storeParamsValues_data". Use BIS_fnc_getParamValue to retrieve params values from…

Missions

BIN_fnc_enableSavingSets a variable used in Arma 3 Contact which handles saving.
BIN_fnc_savingEnabledReturns the value of `missionNamespace getVariable ["BIN_enableSaving", true]`.
BIS_fnc_addEvidence
BIS_fnc_bleedTicketsFunction that handles bleeding ticket system. Tickets are set beforehand using BIS_fnc_respawnTickets.
BIS_fnc_countdownTriggers a countdown.
BIS_fnc_disableLoadingDisables the load/restart button. Currently only for BIS_fnc_cinemaBorder used within the Prologue and Survive campaigns. Only works in single player.
BIS_fnc_disableSavingControls the disabling of saving, stacking each request to prevent saving being enabled too early.
BIS_fnc_enableSavingControls the enabling of saving. Will only enable saving if there are no remaining requests for disabled saving.
BIS_fnc_endMissionEnds mission with a signature shot or a fade effect, marks it finished for Steam and activates a key in format `activateKey format ["BIS_%1.%2_done",…
BIS_fnc_forceEnd*N/A*
BIS_fnc_isCampaignChecks to see if a mission is being run in a campaign.
BIS_fnc_isDebugConsoleAllowedReturns true if debug console is allowed in current context
BIS_fnc_missionFlowThis function is automatically run in post-init by a CfgFunctions declaration. If the mission contains a `missionFlow.fsm` file, it will be loaded,…
BIS_fnc_missionHandlers<pre>#define VAR_RELOADS (missionname + "_reloads_" + str ismultiplayer)
BIS_fnc_missionTimeLeftReturns time in seconds until the mission end. Remaining time can be set using estimatedTimeLeft command or using BIS_fnc_countdown.
BIS_fnc_saveGameEvaluates the current battlefield situation and saves the game when appropriate.
BIS_fnc_setMissionStatusSlotSet a slot for mission status with sectors, respawn tickets, etc.
BIS_fnc_showMissionStatusShow mission status with sectors, respawn tickets, etc.
BIS_fnc_singleMissionConfigReturns config of current single mission.
BIS_fnc_singleMissionKeysActivate mission related keys.
BIS_fnc_singleMissionNameReturns name of currently selected single mission.
BIS_fnc_trackMissionTimeTracks mission time by storing time in profileNamespace.

Modules

BIN_fnc_moduleAntenna
BIN_fnc_moduleDangerZone
BIN_fnc_moduleFaradayCage
BIN_fnc_moduleGravityAnomaly
BIN_fnc_modulePointOfInterest
BIN_fnc_moduleSimpleObject
BIN_fnc_moduleTravel
BIS_fnc_moduleAI*N/A*
BIS_fnc_moduleAmmo*N/A*
BIS_fnc_moduleAnimals*N/A*
BIS_fnc_moduleArsenal*N/A*
BIS_fnc_moduleBleedTickets*N/A*
BIS_fnc_moduleBootcampStage<pre>/*
BIS_fnc_moduleCAS*N/A*
BIS_fnc_moduleChatMake a list of units use any *chat command (groupChat, vehicleChat, sideChat, commandChat, globalChat).
BIS_fnc_moduleCivilianPresence
BIS_fnc_moduleCivilianPresenceSafeSpot
BIS_fnc_moduleCivilianPresenceUnit
BIS_fnc_moduleCombatGetIn*N/A*
BIS_fnc_moduleCountdown*N/A*
BIS_fnc_moduleCoverMapCovers the map except for a defined area. This function was designed to be used by the Modules framework, but it can also be used without the module.…
BIS_fnc_moduleCreateDiaryRecord*N/A*
BIS_fnc_moduleCreateProjectile*N/A*
BIS_fnc_moduleDamageDamage given vehicles.
BIS_fnc_moduleDateUsed by the Date module.
BIS_fnc_moduleDiary*N/A*
BIS_fnc_moduleDoorOpen*N/A*
BIS_fnc_moduleEditTerrainObjectSetups given terrain object.
BIS_fnc_moduleEffectsBubblesCreates underwater bubble effect on defined place (called usually by BIS_fnc_moduleEffectsEmitterCreator).
BIS_fnc_moduleEffectsEmitterCreatorModule function. Creates particle emitters and calls effect function.
BIS_fnc_moduleEffectsFireCreates fire on position of module (called usually by BIS_fnc_moduleEffectsEmitterCreator).
BIS_fnc_moduleEffectsPlanktonCreates underwater plankton effect around player (called usually by BIS_fnc_moduleEffectsEmitterCreator).
BIS_fnc_moduleEffectsShellsCreates empty ammo cartridges on position of the module logic.
BIS_fnc_moduleEffectsSmokeCreates smoke on position of module (called usually by BIS_fnc_moduleEffectsEmitterCreator).
BIS_fnc_moduleEndMission*N/A*
BIS_fnc_moduleExecute*N/A*
BIS_fnc_moduleFriendlyFireHandles the friendly fire. Use either the module interface in the editor, or call individual functions.
BIS_fnc_moduleFuelSet fuel of linked units' vehicles.
BIS_fnc_moduleGenericRadio*N/A*
BIS_fnc_moduleGrenade*N/A*
BIS_fnc_moduleGroupID*N/A*
BIS_fnc_moduleHandle*N/A*
BIS_fnc_moduleHealth*N/A*
BIS_fnc_moduleHideTerrainObjects3DEN MOD: Hiddes closest terrain object.
BIS_fnc_moduleHint<pre>/*
BIS_fnc_moduleHQRegister or return side HQ speaker
BIS_fnc_moduleHvtInit*N/A*
BIS_fnc_moduleHvtObjective
BIS_fnc_moduleHvtObjectives*N/A*
BIS_fnc_moduleHvtObjectivesInstance*N/A*
BIS_fnc_moduleInit*N/A*
BIS_fnc_moduleLightningZeus lightning strike.
BIS_fnc_moduleMine*N/A*
BIS_fnc_moduleMissionName*N/A*
BIS_fnc_moduleMode*N/A*
BIS_fnc_moduleModulesScans synchronized objects and returns synchronized modules
BIS_fnc_moduleMPTypeDefense*N/A*
BIS_fnc_moduleMPTypeGameMaster*N/A*
BIS_fnc_moduleMPTypeGroundSupport<pre>// Debug log
BIS_fnc_moduleMPTypeGroundSupportBase*N/A*
BIS_fnc_moduleMPTypeSectorControl*N/A*
BIS_fnc_moduleMPTypeSeize*N/A*
BIS_fnc_moduleObjective*N/A*
BIS_fnc_moduleObjectiveFind*N/A*
BIS_fnc_moduleObjectiveGetIn*N/A*
BIS_fnc_moduleObjectiveMove*N/A*
BIS_fnc_moduleObjectiveRaceCP*N/A*
BIS_fnc_moduleObjectiveRaceFinish*N/A*
BIS_fnc_moduleObjectiveRaceStart*N/A*
BIS_fnc_moduleObjectiveSector*N/A*
BIS_fnc_moduleObjectiveTarget*N/A*
BIS_fnc_modulePositioning*N/A*
BIS_fnc_modulePoster*N/A*
BIS_fnc_modulePostprocess
BIS_fnc_moduleProjectile*N/A*
BIS_fnc_modulePunishment<pre>/*
BIS_fnc_moduleRadioChannelCreate*N/A*
BIS_fnc_moduleRankUsed by the Set Rank module.
BIS_fnc_moduleRatingFunction used by the Rating module.
BIS_fnc_moduleRemoteControl*N/A*
BIS_fnc_moduleRespawnInventorySet respawn loadouts a curator can assign to players
BIS_fnc_moduleRespawnPosition*N/A*
BIS_fnc_moduleRespawnTickets*N/A*
BIS_fnc_moduleRespawnVehicleSet vehicle respawn, compatible both with SP and MP.
BIS_fnc_moduleSaveGameSaves the game. Saving has to be enabled.
BIS_fnc_moduleSectorInitialize a sector module. Can be also used to get sector parameters.
BIS_fnc_moduleSFX*N/A*
BIS_fnc_moduleShowHide*N/A*
BIS_fnc_moduleSimulationManager*N/A*
BIS_fnc_moduleSimulationManager_grab*N/A*
BIS_fnc_moduleSiteInit*N/A*
BIS_fnc_moduleSkill*N/A*
BIS_fnc_moduleSkiptime*N/A*
BIS_fnc_moduleSlingload*N/A*
BIS_fnc_moduleSound*N/A*
BIS_fnc_moduleSpawnAIDEBUG LOG FLAG
BIS_fnc_moduleSpawnAIOptionsTERMINATE ALL BUT 1ST MODULE
BIS_fnc_moduleSpawnAIPoint*N/A*
BIS_fnc_moduleSpawnAISectorTacticRUN ONCE
BIS_fnc_moduleSupportsInitProvider*N/A*
BIS_fnc_moduleSupportsInitProviderVirtual*N/A*
BIS_fnc_moduleSupportsInitRequester*N/A*
BIS_fnc_moduleTaskCreateCreate Task module function
BIS_fnc_moduleTaskSetDescriptionSet Task Description module function
BIS_fnc_moduleTaskSetDestinationSet Task Destination module function
BIS_fnc_moduleTaskSetStateSet Task State module function
BIS_fnc_moduleTimeMultiplier*N/A*
BIS_fnc_moduleTracersFunction used by the Tracers module.
BIS_fnc_moduleTrident*N/A*
BIS_fnc_moduleTriggers*N/A*
BIS_fnc_moduleUnits*N/A*
BIS_fnc_moduleUnlockArea*N/A*
BIS_fnc_moduleUnlockObject*N/A*
BIS_fnc_moduleVanguardFob
BIS_fnc_moduleVanguardObjective
BIS_fnc_moduleVanguardScorePersistence
BIS_fnc_moduleVolume*N/A*
BIS_fnc_moduleWeatherSet overcast and fog
BIS_fnc_moduleZoneProtection*N/A*
BIS_fnc_moduleZoneRestriction*N/A*

Modules - CBRN

BIN_fnc_CBRNCharacterAddEnables CBRN systems on a specific character entity.
BIN_fnc_CBRNContaminantAddRegisters a CBRN contaminant.
BIN_fnc_CBRNContaminantRemoveUnregisters a CBRN contaminant.
BIN_fnc_CBRNGearActivateActivates a specific piece of CBRN gear for a character entity.
BIN_fnc_CBRNGearDeactivateDeactivates a specific piece of CBRN gear for a character entity.
BIN_fnc_CBRNGearUpdateProcesses CBRN gear updates on a specific character entity.
BIN_fnc_CBRNInContaminantReturns whether or not a character entity is within a CBRN contaminated area.
BIN_fnc_moduleCBRNEnables CBRN systems in a scenario (not MP-compatible!).

Modules - Curator

BIS_fnc_moduleCurator*N/A*
BIS_fnc_moduleCuratorAddAddons*N/A*
BIS_fnc_moduleCuratorAddCameraArea*N/A*
BIS_fnc_moduleCuratorAddEditableObjects*N/A*
BIS_fnc_moduleCuratorAddEditingArea*N/A*
BIS_fnc_moduleCuratorAddEditingAreaPlayers*N/A*
BIS_fnc_moduleCuratorAddIcon*N/A*
BIS_fnc_moduleCuratorAddPoints*N/A*
BIS_fnc_moduleCuratorSetAttributes*N/A*
BIS_fnc_moduleCuratorSetCamera*N/A*
BIS_fnc_moduleCuratorSetCoefs*N/A*
BIS_fnc_moduleCuratorSetCostsDefault*N/A*
BIS_fnc_moduleCuratorSetCostsSide*N/A*
BIS_fnc_moduleCuratorSetCostsVehicleClass*N/A*
BIS_fnc_moduleCuratorSetEditingAreaType*N/A*
BIS_fnc_moduleCuratorSetObjectCost*N/A*

Modules - Firing Drills

BIS_fnc_moduleFDBalloonAirDestruction*N/A*
BIS_fnc_moduleFDBalloonWaterDestruction*N/A*
BIS_fnc_moduleFDCPClear*N/A*
BIS_fnc_moduleFDCPIn*N/A*
BIS_fnc_moduleFDCPOut*N/A*
BIS_fnc_moduleFDFadeMarkerGradually change the alpha of the given marker.
BIS_fnc_moduleFDSkeetDestruction*N/A*
BIS_fnc_moduleFDStatsClear*N/A*
BIS_fnc_moduleFiringDrill*N/A*

Modules - Live Feed

BIS_fnc_liveFeedModuleEffects<pre>/*
BIS_fnc_liveFeedModuleInitDisplay a live feed via a module.
BIS_fnc_liveFeedModuleSetSourceSet a live feed's source via a module.
BIS_fnc_liveFeedModuleSetTarget<pre>/*

Modules - Strategic

Modules - Time Trials

Movement

BIN_fnc_addRotation
BIN_fnc_addTranslation
BIN_fnc_curatorInit
BIN_fnc_editMoveProperties
BIN_fnc_findNearestGrid
BIN_fnc_findPathA* search algorithm. Uses hard-coded Manhattan distance to measure distance.
BIN_fnc_getGridCollisions//_bboxZ = (abs (_bbox select 0 select 2) + abs (_bbox select 1 select 2)) + _cellSizeZHalf*0;
BIN_fnc_getGridMap
BIN_fnc_getGridPath
BIN_fnc_getRotation
BIN_fnc_moduleMovementGrid
BIN_fnc_moveInit
BIN_fnc_moveModule
BIN_fnc_moveObject
BIN_fnc_moveTo
BIN_fnc_moveToModelSpace
BIN_fnc_moveToOnArc
BIN_fnc_setMoveProperties
BIN_fnc_setObjectGrid
BIN_fnc_translationDone

Multiplayer

BIS_fnc_addScoreAdds a set amount of points to the score of a unit *(MP only)*
BIS_fnc_adminReturns the admin state of a client the function is called on. Complements admin script command and used for self check on a local client.
BIS_fnc_didJIPReturn whether or not the local player joined the game while it was already in progress.
BIS_fnc_endMissionServerEnds the mission properly for all players in a multiplayer environment.
BIS_fnc_estimatedTimeLeftSet mission countdown.
BIS_fnc_execRemoteThis function is now an alias to BIS_fnc_MP.
BIS_fnc_getNetModeReturns the current net mode as a string.
BIS_fnc_getUnitByUIDReturns player-controlled unit (if any) according to the provided player UID.
BIS_fnc_groupFromNetIdExtends MP-only groupFromNetId functionality to SP
BIS_fnc_initMultiplayerMultiplayer mission init, executed automatically upon mission start.
BIS_fnc_initPlayable*N/A*
BIS_fnc_listPlayersReturns a list of *currently played* units, alive or dead.
BIS_fnc_MPSend function for remote execution (and executes locally if conditions are met).
BIS_fnc_MPexecExecute received remote execution. This function is used by BIS_fnc_MP and should not be called directly.
BIS_fnc_netIdExtends MP-only netId functionality to SP
BIS_fnc_objectFromNetIdExtends MP-only objectFromNetId functionality to SP
BIS_fnc_onPlayerConnectedExecutes a function on server every time a player connects the mission.

Object Manipulation

BIN_fnc_setRagdollSet the provided unit in ragdoll state (pushed by an invisible object).
BIS_fnc_absSpeedReturns absolute speed of a vehicle in kilometres per hour (km/h).
BIS_fnc_adjustSimpleObjectAdjust simple object vertical position, animations and selection according to provided data.
BIS_fnc_allSynchronizedObjectsReturn all synchronised objects, including those synced to synced and so on.
BIS_fnc_allTurretsReturns all vehicle turrets from config with options. Does what allTurrets command does, except the param is vehicle's config classname.
BIS_fnc_animateFlagSmoothly animates given flag from current position on the flag pole to the given position. When flag animation is done, the scripted event handler…
BIS_fnc_animTypeFunction that returns a categorized array using a single string with the animation name.
BIS_fnc_assignPlayerRoleEnsures the player can only get in the specific vehicle role.
BIS_fnc_attachToRelativeAttaches an object to another, preserving their relative position and orientation.
BIS_fnc_boundingBoxCornerReturns position of all four bounding box corners OR Returns position of the nearest corner to the given position
BIS_fnc_boundingBoxDimensionsReturns the sizes of the three dimensions of an object's bounding box.
BIS_fnc_boundingBoxMarkerCreates marker on object with size of objects' bounding box.
BIS_fnc_boundingCircleReturns size of bounding circle (calculated from X and Y coordinates). This is actually the 2D horizontal diagonal length of the boundingBox.
BIS_fnc_carAlarmPlay car alarm effect.
BIS_fnc_cargoTurretIndexReturn cargo index of a person turret and the other way around.
BIS_fnc_createSimpleObjectCreates non-simulated framerate and network performance friendly object - a Simple Object - and applies different adjustments to fake non-existing…
BIS_fnc_crewCountFunction that counts amount of seats, both for crew and cargo seats.
BIS_fnc_drawBoundingBoxDraws bounding box around given objects.
BIS_fnc_findLookAtGiven target location, calculates orientation vectors facing direction
BIS_fnc_fireMakes a unit or a vehicle fire given muzzle. Make sure that there is some ammo to fire, and, in case of a unit, the weapon with given muzzle is…
BIS_fnc_getNameReturns name of a unit. Name of unit is stored in it is namespace so it can be retrieved later, mainly for when unit dies. Name is stored in the…
BIS_fnc_getObjectBBDGet object boundingBoxReal max values and store them with setVariable ["BIS_EGSpectator_objectBBD", [maxWidth, maxLength, maxHeight]] for later calls.
BIS_fnc_getPitchBankReturns the pitch and bank of an object, in degrees. Yaw can be found using the getDir command.
BIS_fnc_getTurretsReturns vehicle turrets.
BIS_fnc_getUnitInsigniaGet a unit's uniform insignia class set with BIS_fnc_setUnitInsignia.
BIS_fnc_initVirtualUnitInitialize virtual unit. Disable it, turn the camera upwards and save its correct side.
BIS_fnc_inTriggerDetects whether position is within area or calculates distance to the nearest edge of trigger area by using optional params.
BIS_fnc_isBuildingEnterableCheck whether a building or structure has available positions defined within model.
BIS_fnc_isInFrontOfCheck if an object is in front of another object (in the front 180°)
BIS_fnc_isUnitVirtualReturn if unit is virtual (used for example for Zeus players).
BIS_fnc_moveActionReturn current move action (used in playAction, playActionNow and switchAction)
BIS_fnc_moveInMoves a unit into vehicle. Compatible with assignedVehicleRole output.
BIS_fnc_neutralizeUnitNeutralize an object by intrinsic means: - soldiers are blown up by mine - vehicles are shelled by artillery - air units are hit by AA missile -…
BIS_fnc_objectHeightReturn object height defined by its bounding box and eventual offset fix. For the following classes an offset is used.
BIS_fnc_objectsGrabberConverts a set of placed objects to an object array (as a String) for the DynO mapper.
BIS_fnc_objectsMapperTakes an array of data about a dynamic object template and creates the objects.
BIS_fnc_objectTypeReturn object category and type.
BIS_fnc_objectVarReturn a unique object variable. The variable is preserved after unit respawn.
BIS_fnc_playerNameReturn current profile's name. Deprecated since Arma 3, use profileName instead.
BIS_fnc_prepareAOSpawns random patrols and/or vehicles in trigger areas with proper names. Side selected in the triggers "Activation" listbox will determine the side…
BIS_fnc_rankParamsReturn information about military rank.
BIS_fnc_replaceWithSimpleObjectReplaces a normal object with a Simple Object. Object must not contain any crew and must be placed on the ground.
BIS_fnc_returnGroupComposition<pre> /* File: returnGroupComp.sqf
BIS_fnc_scriptedMoveForces a unit to turn towards and walk to provided destination(s). Will not work on player. When Group is used as argument, the function will be…
BIS_fnc_selectCrewReturn an appropriate crew type for a certain vehicle.
BIS_fnc_setHeightSet an object's altitude.
BIS_fnc_setHitPointDamageSets damage to HitPoint with dependency or not.
BIS_fnc_setIdentitySets the unit's identity.
BIS_fnc_setObjectRotationSet object rotation.
BIS_fnc_setObjectShotParents*N/A*
BIS_fnc_setObjectTextureSet object textures.
BIS_fnc_setPitchBankRotate an object, giving it the specified pitch and bank, in degrees.
BIS_fnc_setRankSet rank of vehicle crew.
BIS_fnc_setUnitInsigniaSets unit insignia (e.g., shoulder insignia on soldiers). See Arma 3: Unit Insignia for more details and a list of official insignias.
BIS_fnc_setVehicleMassSet mass relative to the default vehicle mass (default mass being vehicle mass on first execution of this function).
BIS_fnc_simpleObjectDataGet complete data needed for simple object creation.
BIS_fnc_spawnCrewFunction to fill all crew positions in a vehicle, including turrets. In dummy mode no objects are created and the returned array contains only ones;…
BIS_fnc_spawnEnemyConstantly spawns enemies around a player according to array of enemy classes. The units will try to hunt down the player.
BIS_fnc_spawnGroupFunction which handles the spawning of a dynamic group of characters. The composition of the group can be passed to the function.
BIS_fnc_spawnObjectsCreate a stack of objects at given position or on top of given object (eg. table).
BIS_fnc_spotterMake spotter report target distance to sniper. Will only stop if one of the two units dies.
BIS_fnc_stalkContinuously set WP of one group to a different group to hunt it. It does not change the group's behaviour.
BIS_fnc_switchLampSwitch streetlamp on/off.
BIS_fnc_synchronizedObjectsGet all objects of given type directly synchronised to the given object. Works in Eden Editor too.
BIS_fnc_synchronizedObjectsQueueReturn sequence of all synchronized objects forming either line or circle.
BIS_fnc_teamColorConvert number to color team name or color.
BIS_fnc_textureVehicleIconChecks whether icon is defined in CfgVehicleIcons and if so, returns the icon.
BIS_fnc_turretConfigReturns vehicle turret config for the turret given by the turret path.
BIS_fnc_vehicleCrewTurretsReturns vehicle crew turrets, which will be filled with crew if createVehicleCrew command is executed on the vehicle. If vehicle class is passed as…

Old Man

OO

BIS_fnc_addClassOORegistering a class for the OO scripting shell.
BIS_fnc_createObjectOOInstantiates an object of a certain class.
BIS_fnc_validateParametersOOValidating the parameters of a certain method in a class.

Phone

Positions

BIS_fnc_ambientBlacklistCheck if area is blacklisted. Blacklist triggers are to be named 'bis_ambientBlacklist_#', where # is number from 0 to 99.
BIS_fnc_ambientBlacklistAddAdd a new ambient blacklist trigger
BIS_fnc_buildingPositionsGet all available positions within a building or structure.
BIS_fnc_findOverwatchSelects a position that provides overwatch onto another position.
BIS_fnc_findSafePosThis function generates position on a map according to several given parameters (see diagram).
BIS_fnc_gridToPosConverts grid coordinates to world position.
BIS_fnc_isPosBlacklistedFunction checks a blacklist and sees if the given position is in it or not.
BIS_fnc_locationDescriptionReturn location description (e.g. "NE of Agia Marina")
BIS_fnc_nearestPositionFunction to find the nearest Object or position from a list, when compared to a given reference.
BIS_fnc_nearestRoadFind the nearest road segment to certain position, within given radius.
BIS_fnc_positionReturns PositionAGL, unless passed argument is Array, then the same array is returned.
BIS_fnc_posToGridConverts array position to map grid position.
BIS_fnc_randomPosSelects random position according to given params within given area
BIS_fnc_randomPosIntersectionReturns random 2D position inside the intersection of two circles. [-1,-1] is returned if the circles do not intersect.
BIS_fnc_relPosReturns a position that is a specified distance and compass direction from the passed position or object.
BIS_fnc_relPosObjectPlace an object relative to another object, like a *setRelPos* command.

Priority Queue

BIS_fnc_priorityQueue_GetHighestPriorityGet the highest priority in the queue
BIS_fnc_priorityQueue_GetLowestPriorityGet the highest priority in the queue
BIS_fnc_priorityQueue_Init/*
BIS_fnc_priorityQueue_IsEmpty/*
BIS_fnc_priorityQueue_IsFullChecks if the Queue is full
BIS_fnc_priorityQueue_PopItem/*
BIS_fnc_priorityQueue_PushItem/*

Probe

BIN_fnc_probeAnimBIN_fnc_probeAnim
BIN_fnc_probeCoreDelete
BIN_fnc_probeCoreEffectsBIN_fnc_probeCoreEffects [probeCore] call BIN_fnc_probeCoreEffects
BIN_fnc_probeCoreInit
BIN_fnc_probeCoreLegsDestroyed
BIN_fnc_probeCoreUpdate
BIN_fnc_probeDelete
BIN_fnc_probeHitpointBIN_fnc_probeHitpoint
BIN_fnc_probeVeinHitpointBIN_fnc_probeVeinHitpoint

Probing

Program Flow

BIS_fnc_callExecute given code with or without parameter.
BIS_fnc_CPWaitUntilFunction waits until condition becomes true. Condition is checked with given interval.
BIS_fnc_execFSMExecute the scripted FSM. Shell for execFSM command
BIS_fnc_execVMexecVM desired script with desired argument(s). This function is only really useful when combined with BIS_fnc_MP to execute a script remotely.
BIS_fnc_haltHalts current function and all its parents and logs an error message.
BIS_fnc_loopLoop stacked code/function with timing and conditional control. Code and conditions are executed in non-scheduled environment.
BIS_fnc_runLaterStack code/function that should be run later, after some time/frames or/and custom condition. Internally calls BIS_fnc_loop.
BIS_fnc_spawnExecute given code with or without parameter.
BIS_fnc_spawnOrderedSpawns given function and executes it in the order it was called in case multiple calls are made. If mutex name is not specified, function name is…

Puzzles

Radio

BIS_fnc_channelNumToRadioChannelIDConverts chat channel number, used in currentChannel, enableChannel, etc to radio channel id, used in radioChannelAdd, radioChannelSetLabel, etc.
BIS_fnc_diagRadioTracks played radio sentences.
BIS_fnc_radioChannelIDToChannelNumConverts radio channel id, used in radioChannelAdd, radioChannelSetLabel, etc to chat channel number, used in currentChannel, enableChannel, etc.
BIS_fnc_radioSetChannelSet a specific or random music channel.
BIS_fnc_radioSetPlaylistSet a random music playlist for the current set channel (default "Rock"). Musics with "genre" set in CfgMusic are selected and shuffled.
BIS_fnc_radioSetTrackSet a specific or random music track.

Respawn

BIS_fnc_addRespawnInventoryAdd a respawn inventory for respawn menu.
BIS_fnc_addRespawnPositionAdd a respawn position for the Arma 3 Respawn Menu.
BIS_fnc_drawRespawnPositionsDraws respawn positions on the map which were added by BIS_fnc_addRespawnPosition.
BIS_fnc_getRespawnInventoriesReturn respawn inventories available for the given target.
BIS_fnc_getRespawnMarkersReturns all respawn markers for given side.
BIS_fnc_getRespawnPositionsReturn scripted respawn positions available for the given unit.
BIS_fnc_initRespawn*N/A*
BIS_fnc_initRespawnBackpackInit respawn backpack. Whover "assembles" it will receive a new respawn position. When backpack object has 'respawnNearbyPlayers' attribute set to 1,…
BIS_fnc_missionRespawnTypeReturn respawn type defined in Description.ext. Can return as Number (e.g 1) or String (e.g "BIRD").
BIS_fnc_moduleRespawnInventorySet respawn loadouts a curator can assign to players
BIS_fnc_moduleRespawnPosition*N/A*
BIS_fnc_moveToRespawnPositionMove given unit to given respawn position. Units moved to height >= 30m will start on parachute. Position [0,0,0] is blacklisted. This function must…
BIS_fnc_removeRespawnInventoryRemove a respawn inventory added by BIS_fnc_addRespawnInventory.
BIS_fnc_removeRespawnPositionRemove a respawn position added by BIS_fnc_addRespawnPosition.
BIS_fnc_respawnBackpackHandles respawn camps functionality. Whoever "assembles" a camp from backpack it will receive a new respawn position.
BIS_fnc_respawnBase
BIS_fnc_respawnConfirmShows a message box which the user needs to accept in order to respawn.
BIS_fnc_respawnCounterSet or execute respawn counter params.
BIS_fnc_respawnEndMissionEnd a mission if all players are dead *and* there are no more respawn tickets (if any).
BIS_fnc_respawnGroupCamera script used by the "group respawn" template - when the player dies and gets transferred to the new group member.
BIS_fnc_respawnInstant
BIS_fnc_respawnManagerAll checkpoints must be markers with name prefix BIS_checkpointnr
BIS_fnc_respawnMenuInventoryHandles respawn inventory menu.
BIS_fnc_respawnMenuPositionShows respawn menu. Closes it if the player is alive.
BIS_fnc_respawnMenuSpectatorHandles the spectator mode.
BIS_fnc_respawnNoneCreate a death screen.
BIS_fnc_respawnRoundsDisable respawn until players of only one side (including its allies) remains, then respawn everyone at once. When "Rounds" respawn is used by only…
BIS_fnc_respawnSeagull*N/A*
BIS_fnc_respawnSide*N/A*
BIS_fnc_respawnSpectator*N/A*
BIS_fnc_respawnTicketsManage respawn tickets used by Tickets respawn template.
BIS_fnc_respawnTimePenaltySet or execute respawn time penalty
BIS_fnc_respawnWave*N/A*
BIS_fnc_selectRespawnTemplateSelect respawn template from CfgRespawnTemplates and execute its script / function. Internal use.
BIS_fnc_setRespawnDelayIncrease the respawn time based on a condition
BIS_fnc_setRespawnInventorySet respawn loadouts.
BIS_fnc_showRespawnMenuTriggers the respawn screen in the given mode
BIS_fnc_showRespawnMenuDisableItemDisables respawn loadout, role or position for Arma 3: Respawn. - Only role or only loadout can be limited at one moment, if there is limit for both,…
BIS_fnc_showRespawnMenuDisableItemCheck*N/A*
BIS_fnc_showRespawnMenuDisableItemDraw*N/A*
BIS_fnc_showRespawnMenuHeader*N/A*
BIS_fnc_showRespawnMenuInventory*N/A*
BIS_fnc_showRespawnMenuInventoryDetails*N/A*
BIS_fnc_showRespawnMenuInventoryItems*N/A*
BIS_fnc_showRespawnMenuInventoryLimit*N/A*
BIS_fnc_showRespawnMenuInventoryLimitRefresh*N/A*
BIS_fnc_showRespawnMenuInventoryLimitRespawn*N/A*
BIS_fnc_showRespawnMenuInventoryList*N/A*
BIS_fnc_showRespawnMenuInventoryLoadout*N/A*
BIS_fnc_showRespawnMenuInventoryMetadataGets or sets inventory menu loadout metadata for class CfgRespawnInventory
BIS_fnc_showRespawnMenuPosition*N/A*
BIS_fnc_showRespawnMenuPositionList*N/A*
BIS_fnc_showRespawnMenuPositionMap*N/A*
BIS_fnc_showRespawnMenuPositionMapDraw
BIS_fnc_showRespawnMenuPositionMapHandle*N/A*
BIS_fnc_showRespawnMenuPositionMetadata
BIS_fnc_showRespawnMenuPositionName
BIS_fnc_showRespawnMenuPositionRefresh*N/A*
BIS_fnc_updatePlayerArrayUpdates dead player objects to their current respawned objects.

Revive

BIS_fnc_disableReviveDisable revive on given unit.
BIS_fnc_reenableReviveEnable revive on given unit. Revive system needs to be initialized and running.
BIS_fnc_reviveAllowedReturns true if unit is in general able to revive someone.
BIS_fnc_reviveBleedOutMake a unit bleed out over time while incapacitated.
BIS_fnc_reviveDamageResetResets player's damage data and received damage.
BIS_fnc_reviveDebugDebug script for revive system.
BIS_fnc_reviveEhDammagedunit: Object - Object the event handler is assigned to hitSelection: String - Name of the selection where the unit was damaged damage: Number -…
BIS_fnc_reviveEhHandleDamageShould be excuted by HandleDamage event handler. See example. Handles damage calculation.
BIS_fnc_reviveEhHandleHealHandles healing of unit. Unit gets fully healed after 10 seconds if current damage is smaller than initial damage, e.g. a medic healed the unit.
BIS_fnc_reviveEhKilledShould be called from Killed event handler. Handles what happens if unit dies if revive system is enabled.
BIS_fnc_reviveEhRespawnSets unit's state to respawned. Should probably only be called on respawn event.
BIS_fnc_reviveEnabledReturns is revive is enabled or not for the unit.
BIS_fnc_reviveGet3dIconsReturns structured text that can be displayed in 'Hold Action' tech as animated unconscious state icon.
BIS_fnc_reviveGetActionIconReturns structured text that can be displayed in 'Hold Action' tech as animated unconscious state icon.
BIS_fnc_reviveIconControlManage the adding, removing, and effects applied to 3D icons used for visualizing incapacitated units.
BIS_fnc_reviveInitInitialize the Revive system on all machines.
BIS_fnc_reviveIsValidCheck if player can perform revive action on given unit.
BIS_fnc_reviveIsValidSecureCheck if player can perform secure action on given unit.
BIS_fnc_reviveOnBeingRevivedUsed to execute specific code locally on every client whenever "being revived" flag changes.
BIS_fnc_reviveOnForcingRespawnUsed to execute specific code localy on every client whenever 'forcing respawn' flag changes.
BIS_fnc_reviveOnStateUsed to execute specific code localy on every client whenever unit's state changes.
BIS_fnc_reviveOnStateJIPUsed to execute state specific code localy on client that is JIPping.
BIS_fnc_reviveSecureUnitMake player secured (killed without execution penalties) by _source unit.

RichCurve

BIS_fnc_richCurve_computeComputes curve data
BIS_fnc_richCurve_computeCurveArcLengthComputes curve arc length
BIS_fnc_richCurve_computeKeysGet's keys assigned to given curve
BIS_fnc_richCurve_computeOwnerTimelineStores owner timeline
BIS_fnc_richCurve_computeSimulatedObjectsGet's all simulated objects
BIS_fnc_richCurve_getCurveLengthCalculates distance between all keys, returning the total length
BIS_fnc_richCurve_getCurvePointsReturns the computed curve points
BIS_fnc_richCurve_getCurveValueFloatGet's curve value at given time
BIS_fnc_richCurve_getCurveValueVectorGet's curve value at given time
BIS_fnc_richCurve_getFirstKeyGet's the first key on given curve
BIS_fnc_richCurve_getKeyFromIndexGet's the key in given index of given curve
BIS_fnc_richCurve_getKeyIndexGet's the index of given key in given curve
BIS_fnc_richCurve_getKeysGet's keys assigned to given curve
BIS_fnc_richCurve_getKeysAtTimeGet's keys (prev / next) at given time
BIS_fnc_richCurve_getKeyTimeReturns given key time in alpha
BIS_fnc_richCurve_getLastKeyGet's the last key on given curve
BIS_fnc_richCurve_getLookAtPositionReturns the look at position of this curve, [0.0, 0.0, 0.0] if not set
BIS_fnc_richCurve_getNextKeyGet's the next key from given key, null if none exists
BIS_fnc_richCurve_getOrientationModeReturns orientation mode for objects animated by this curve
BIS_fnc_richCurve_getOwnerTimelineReturns a curve's simulated objects
BIS_fnc_richCurve_getPreviousKeyGet's the previous key from given key, null if none exists
BIS_fnc_richCurve_getSimulatedObjectsReturns a curve's simulated objects
BIS_fnc_richCurve_getTimeRangeReturns min / max time range of given curve
BIS_fnc_richCurve_isTimeInSecondsWhether the time of the keys belonging to this curve are in seconds
BIS_fnc_richCurve_numKeysReturns number of keys registered with given curve
BIS_fnc_richCurve_resetClears all curves (and deletes them)
BIS_fnc_richCurve_resetKeysEventStateReset's flag on all keys about handled events
BIS_fnc_richCurve_setKeysSet's keys assigned to given curve
BIS_fnc_richCurve_setOrientationModeSet's the curve's orientation mode

Scenes

BIS_fnc_initWorldSceneInitialize world scene
BIS_fnc_miscAnimSetting up the animations with correct positions for object - choose correct performance. For ex. fixingTowingTractor (read the description).
BIS_fnc_sceneAreaClearanceRemoves object clutter within a set trigger, for use within cutscenes.
BIS_fnc_sceneCheckWeaponsChecks if participants have not missing weapon or have not it selected before scene Function works as a toggle: - 1st run of script: running in SETUP…
BIS_fnc_sceneCreateSceneTriggerCreate trigger for scene which can interrupt scene with name passed during creating the trigger. Scene name is saved in format BIS_SceneIntDetector%1…
BIS_fnc_sceneCreateSoundEntities
BIS_fnc_sceneGetObjectsThis function gets objects (but centre object) positions and direction relative to the choosen object and copies the result to the clipboard via…
BIS_fnc_sceneGetParticipantsgets members of unit's group who are in unit's range.
BIS_fnc_sceneGetPositionByAngle<pre> /* * * version: 1.0 * name: sceneGetPositionByAngle * description: returns new calculated position of object from angle and distance from…
BIS_fnc_sceneIntruderDetectorChecks if there are intruders during scene. All intruders during scene will be disabled if they will get into the detector trigger. Checking is…
BIS_fnc_sceneMiscStuffDoes the basic minor stuff for scene - cinema borders, map is denied etc.
BIS_fnc_sceneRotateCompute new object coordinates from given center and angle from MOTION BUILDER
BIS_fnc_sceneSetAnimationsForGroupPlays a range of animations for a specific set of units, intended for use during cutscenes.
BIS_fnc_sceneSetBehaviourEnables / disables a specific set of AI units, usable for cutscenes.
BIS_fnc_sceneSetObjectsThis function sets objects positions and direction relative to the chosen object.
BIS_fnc_sceneSetPosFormationAdjusts units into a pre-determined formation, using a few variables. Part of S.C.E.N.E.S function group.
BIS_fnc_unitCaptureRecords movement data of input unit over a specified period of time. Simplified. Pressing the <kbd>Esc</kbd> key, the duration ending, or the unit…
BIS_fnc_unitCaptureFiringRecords weapon fire data of input unit over a specified period of time. Pressing the <kbd>ESC</kbd> key, the duration ending, or the unit dying ends…
BIS_fnc_unitCaptureSimpleRecords movement data of input unit over a specified period of time. Simplified. Pressing the <kbd>Esc</kbd> key, the duration ending, or the unit…
BIS_fnc_unitPlayPlays back input movement data on input unit.
BIS_fnc_unitPlayFiringPlays back input weapon fire data on input unit.
BIS_fnc_unitPlaySimplePlays back input movement data on input unit. Simplified.
BIS_fnc_zzRotate

Scripts

BIS_fnc_dataTerminalAnimateAnimate a Data Terminal ("Land_DataTerminal_01_F").
BIS_fnc_dataTerminalColorSet Data Terminal colors for its different steps. Steps are: 1. closed terminal 1. opening terminal 1. emitting terminal.
BIS_fnc_doorChanges animation phase of given door.
BIS_fnc_doorCloseClose a door with an animated doorhandle.
BIS_fnc_doorNoHandleClose*N/A*
BIS_fnc_doorNoHandleOpen*N/A*
BIS_fnc_doorOpenOpen a door with an animated doorhandle.
BIS_fnc_firedBombDemineFunction used inside the IDAP showcase.
BIS_fnc_hatchClose*N/A*
BIS_fnc_hatchOpen*N/A*
BIS_fnc_laptopInitAdds an Easter egg to the laptop, that is active only if the mission date is set to 2001-06-22.
BIS_fnc_laptopPlayVideoPlays an easter egg video on the screen of an old laptop.
BIS_fnc_lockedDoorNoHandleOpen*N/A*
BIS_fnc_lockedDoorOpen*N/A*
BIS_fnc_objectInventoryAnimatedCloseAnimates an object being closed, for example a drawer. The counter set by BIS_fnc_objectInventoryAnimatedOpen gets reset when this function is called.
BIS_fnc_objectInventoryAnimatedOpenAnimates an object being opened, for example a drawer. It also sets a counter which prevents animation to be played multiple time if more than one…
BIS_fnc_singleWingSlideDoorClose*N/A*
BIS_fnc_singleWingSlideDoorOpen*N/A*
BIS_fnc_twoWingDoorNoHandleClose*N/A*
BIS_fnc_twoWingDoorNoHandleOpen*N/A*
BIS_fnc_twoWingDoorOneHandleClose*N/A*
BIS_fnc_twoWingDoorOneHandleOpen*N/A*
BIS_fnc_twoWingDoorTwoHandleClose*N/A*
BIS_fnc_twoWingDoorTwoHandleOpen*N/A*
BIS_fnc_twoWingSlideDoorClose*N/A*
BIS_fnc_twoWingSlideDoorOpen*N/A*

Sides

BIS_fnc_areFriendlyFunction that takes two Sides and compares them, returning whether they are friendly or not.
BIS_fnc_enemySidesReturns sides hostile to the given side / object.
BIS_fnc_friendlySidesReturns sides allied to the given side / object.
BIS_fnc_FTLmanagerFTL (Friendly To Local) manager tracks relationship between player and civilian side.
BIS_fnc_getFactionsGets list and sides of current factions.
BIS_fnc_objectSideReturns object side as defined in config (i.e. not affected by dynamic changing like rating)
BIS_fnc_playerSideFactionReturn representative faction of the given side. Faction of the first detected player is used.
BIS_fnc_respectRESpect - The Effective Calculation Process.
BIS_fnc_sideColorReturns colour of define side either as Array in format RGBA or the name of the colour as String
BIS_fnc_sideIDReturn config side number. - 0 = opfor (east) - 1 = blufor (west) - 2 = independent (resistance) - 3 = civilian - 4 = sideUnknown - 5 = sideEnemy - 6…
BIS_fnc_sideIsEnemyDetermines if side B is enemy to side A the way the game engine does it. The relationship table can be found here: Side Relations.
BIS_fnc_sideIsFriendlyDetermines if side B is friendly to side A the way the game engine does it. The relationship table can be found here: Side Relations.
BIS_fnc_sideNameReturns localized side name. - 0 / opfor (east) = "OPFOR" - 1 / blufor (west) = "BLUFOR" - 2 / independent (resistance) = "Independent" - 3 /…
BIS_fnc_sideNameUnlocalizedReturns unlocalized side name.
BIS_fnc_sideTypeReturns side type based on side ID. See BIS_fnc_sideID for more information.
BIS_fnc_tridentClient*N/A*
BIS_fnc_tridentExecuteExecute a code based on Trident relationship.
BIS_fnc_tridentGetRelationshipGets the relationship of competing Trident sides. The value slowly decreases towards 0.
BIS_fnc_tridentHandleDamageRegister a unit as Trident unit. When competing sides are still friendly and the unit is killed by the competing side, the killer won't be punsihed…
BIS_fnc_tridentSetRelationshipSet relationship of competing Trident sides. When the value reaches threshold, side relationship will change. The value slowly decreases towards 0.

Sound

BIN_fnc_createScriptedSoundSource
BIN_fnc_createScriptedSoundSourceVehicle<pre>
BIN_fnc_getCharacterSounds
BIN_fnc_playAlternatingSound
BIN_fnc_setCustomSoundController
BIN_fnc_soundDrone
BIS_fnc_jukeboxPlays music, depending on the player group status.
BIS_fnc_musicRandomly play provided tracks defined in CfgMusic and does a 3 seconds fade out. This function takes accTime into account. See also BIS_fnc_jukebox.
BIS_fnc_playEndMusicPlay mission end music (when it is nearing the end)
BIS_fnc_playMusicPlays given song.
BIS_fnc_playSoundPlays given sound. Identical to playSound.
BIS_fnc_sayMessageMake a speaker say a message.
BIS_fnc_setCustomSoundController

Spectator

BIS_fnc_EGObjectiveVisualizerPart of the EG Spectator Mode.
BIS_fnc_EGObjectiveVisualizerDrawPart of the EG Spectator Mode.
BIS_fnc_EGSpectatorSpectator instance.
BIS_fnc_EGSpectatorCameraPart of the EG Spectator Mode.
BIS_fnc_EGSpectatorCameraPrepareTarget
BIS_fnc_EGSpectatorCameraResetTarget
BIS_fnc_EGSpectatorCameraSetTarget
BIS_fnc_EGSpectatorCameraTick
BIS_fnc_EGSpectatorDraw2D
BIS_fnc_EGSpectatorDraw3D
BIS_fnc_EGSpectatorGetUnitsToDraw

Strategic

BIS_fnc_ORBATAddGroupOverlayRegister texture(s) to be displayed over CfgORBAT group.
BIS_fnc_ORBATAnimateAnimates an ORBAT viewer.
BIS_fnc_ORBATConfigPreviewOpens config viewer and shows CfgORBAT. Used to retrieve CfgOrbat data
BIS_fnc_ORBATGetGroupParamsReturns group params from CfgORBAT.
BIS_fnc_ORBATOpenOpens the ORBAT Viewer.
BIS_fnc_ORBATRemoveGroupOverlayUnregister texture(s) to be displayed over CfgORBAT group.
BIS_fnc_ORBATSetGroupFadeSet fade value of CfgORBAT group and all groups below it.
BIS_fnc_ORBATSetGroupParamsOverrides group params from CfgORBAT. See ORBAT Viewer for a detailed explanation.
BIS_fnc_ORBATTooltipAnimates an ORBAT viewer.
BIS_fnc_strategicMapAnimateAnimates a Strategic Map.
BIS_fnc_strategicMapMouseButtonClickInternal function used by BIS_fnc_strategicMapOpen.
BIS_fnc_strategicMapOpenCreates a strategic map.

Strings

BIS_fnc_alignTabsAlign two columns divided by tabs. A tab counts for 8 characters.
BIS_fnc_filterStringRemoves characters from a string based on the list of allowed characters.
BIS_fnc_inStringFind a string within a string.
BIS_fnc_isLocalizedChecks if string is localized. Obsolete variant before isLocalized command was introduced.
BIS_fnc_localizeChecks if passed string is localization key and if so, return the localized text. Else, returns the passed string itself.
BIS_fnc_numberDigitsBreak number into array of digits.
BIS_fnc_numberTextConvert a number into string (avoiding scientific notation).
BIS_fnc_ordinalNumberReturn number as ordinal number (e.g. 1 become "1st")
BIS_fnc_parseNumberReturn number from expression
BIS_fnc_phoneticalWordConvert number to NATO phonetical alphabet word (e.g. 2 becomes "Bravo") or letter of alphabet.
BIS_fnc_romanNumeralConvert integer to roman numerals (e.g. 42 becomes "XLII").
BIS_fnc_secondsToStringConvert seconds to formatted string.
BIS_fnc_sortAlphabeticallyAlphabetically sort an array of strings without modifying the original. See also sort.
BIS_fnc_splitStringSplits given string according to given separator(s).
BIS_fnc_timeToStringThis function returns a 24-hour time as a string (or array) from a decimal.
BIS_fnc_trimStringGet a substring out of the string.

Supports

BIS_fnc_addSupportLinkAdds support types during a mission.
BIS_fnc_changeSupportRadioChannelChanges the radio channel for Support module-related protocol.
BIS_fnc_fireSupportMortar/artillery fire support.
BIS_fnc_fireSupportClusterVirtual fire support - cluster shell.
BIS_fnc_fireSupportVirtualFires virtual mortar/artillery fire support.
BIS_fnc_limitSupportLimits support runs during a mission.
BIS_fnc_removeSupportLinkRemoves support types during a mission.
BIS_fnc_supplydropScript for para-drop of objects. Spawns waitUntil that handles ground hit (detaching of object from parachute). Used by supplydrop service.
BIS_fnc_supplydropServiceSupply drop service - controls approach and departure of transporting air vehicle and actual cargo drop. Used by Supply drop support request.
BIS_fnc_transportServiceTransportation system

Systems

BIS_fnc_activateAddonsActivate addons upon mission start. Doesn't work when the mission is already running.
BIS_fnc_animatedBriefingPlays the Animated Briefings. Basically, it is a wrap function for the BIS_fnc_eventTimeline function.
BIS_fnc_animatedOpening
BIS_fnc_animatedScreen
BIS_fnc_animatePictureTranslates (relative or absolute), scales (relative or absolute), and sets the alpha over time on the provided control.
BIS_fnc_counterModify the given counter, create it if does not exist.
BIS_fnc_deleteCounterDelete the provided counter added by BIS_fnc_counter.
BIS_fnc_dynamicGroupsFunction that adds dynamic groups to the mission as seen in End Game. Function needs to be initialized on server and client. Clients can then use…
BIS_fnc_eventTimelineUniversal system for playing sequential events defined by time.
BIS_fnc_getCloudletParamsReturn particle params of CfgCloudlets class.
BIS_fnc_haloMakes a High Altitude Low Opening (HALO) parachute jump.
BIS_fnc_initExpoDisable parts of the main menu during public presentation. Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>U</kbd> to toggle the lock.
BIS_fnc_initModulesWait until all modules using the Arma 3: Module Framework are initialised.
BIS_fnc_instructorFigure<pre> /* Version: 0.1 Name: Instructor Figure DESCRIPTION: www. PARAMETERS: 1) function called - string, list of functions: - Init - Destroy 2)…
BIS_fnc_locationsCreates or registers location logics (used in various modules, like Ambient Civilians, Ambient Civilian Vehicles or Warfare 2).
BIS_fnc_missionSelectorFunction that draws clickable, hoverable and animated icons on the map that execute a user-defined code when pressed.
BIS_fnc_openFieldManualOpens Field Manual in briefing (SP, MP Server, MP Client) and players's map or journal. Selects the topic and hint passed as parameters. Can apply a…
BIS_fnc_scaleAndTranslateTranslates, scales (with pivot) and fades a picture control over time.
BIS_fnc_setPPeffectTemplateApply post-process effects according to template from CfgPostprocessTemplates.
BIS_fnc_skirmishTriggerAn internally used .fsm.
BIS_fnc_startLoadingScreenRegister a loading screen. Start the loading when it is the first one registered.

Tasks

BIS_fnc_animateTaskWaypointPlays an animation that pushes the active task waypoint up and down.
BIS_fnc_basicTask
BIS_fnc_deleteTaskDeletes given task.
BIS_fnc_missionTasksHeader function of local mission tasks. Automatically declares following variables: _taskID: STRING _taskState: STRING _taskExists: BOOL
BIS_fnc_missionTasksLocal
BIS_fnc_setTaskSet task parameters.
BIS_fnc_setTaskLocal
BIS_fnc_sharedObjectives
BIS_fnc_taskAlwaysVisibleReturns true if task is forced to be always visible (default: false).
BIS_fnc_taskAttackThis function adds a Seek and Destroy waypoint on defined position to the group and set its behaviour to "AWARE". If the group has other waypoints,…
BIS_fnc_taskChildrenReturn a task's sub-tasks.
BIS_fnc_taskCompletedChecks if task is completed.
BIS_fnc_taskCreateCreate a task.
BIS_fnc_taskCurrentReturns unit's current task.
BIS_fnc_taskDefendGroup will man nearby static defenses within a 100 metre radius of the defense position and guard the position. Some units will man weapons, others…
BIS_fnc_taskDescriptionReturn a task's description.
BIS_fnc_taskDestinationReturn a task's destination.
BIS_fnc_taskExistsReturn true if a task exists.
BIS_fnc_taskHandlerautomatically sets tasks as current
BIS_fnc_taskHintShows a task hint.
BIS_fnc_taskParentReturn a sub-task's parent task.
BIS_fnc_taskPatrolCreate a random patrol of several waypoints around a given position.
BIS_fnc_taskRealFind the actual task associated with a task name assigned to a unit.
BIS_fnc_taskSetAlwaysVisibleFlags task to be or not to be always visible.
BIS_fnc_taskSetCurrentSet a task to current. Identical to assigning a task.
BIS_fnc_taskSetDescriptionSet a task description.
BIS_fnc_taskSetDestinationSet a task's destination.
BIS_fnc_taskSetStateSet a task's state.
BIS_fnc_taskSetTypeSets task type to given task.
BIS_fnc_taskStateReturns task's state.
BIS_fnc_tasksUnitGrab all tasks currently created for a given unit.
BIS_fnc_taskTypeReturns type of given task.
BIS_fnc_taskTypeIconReturns path to the icon texture associated with given task type.
BIS_fnc_taskVarReturns task's variable name.

Timeline

BIS_fnc_eventTimelineUniversal system for playing sequential events defined by time.
BIS_fnc_timeline_cleanupDestroys timeline and all related objects.
BIS_fnc_timeline_deletedDeletes given timeline and updates.
BIS_fnc_timeline_finishCalled when timeline finishes playing (reaches it is end).
BIS_fnc_timeline_getAlphaGet's current alpha in given timeline.
BIS_fnc_timeline_getCurrentTimeThe current time of this timeline.
BIS_fnc_timeline_getInterpModeReturns the timeline interp mode index.
BIS_fnc_timeline_getLengthThe time left of given timeline.
BIS_fnc_timeline_getPlayFromStartWhether timeline is flagged as play from start on scenario begin.
BIS_fnc_timeline_getPlayRateReturns the play rate of this timeline.
BIS_fnc_timeline_getPlayTimeThe time at which timeline started playing.
BIS_fnc_timeline_getPositionReturns the position of given timeline.
BIS_fnc_timeline_getSimulatedCurvesReturns the simulated curves of a timeline.
BIS_fnc_timeline_getStopTimeThe time at which timeline stopped playing
BIS_fnc_timeline_getTimeLeftThe time left of given timeline.
BIS_fnc_timeline_initInitialized a timeline.
BIS_fnc_timeline_isFinishedReturns whether given timeline has finished.
BIS_fnc_timeline_isLoopingReturns whether given timeline is in loop mode.
BIS_fnc_timeline_isPausedReturns whether given timeline is paused.
BIS_fnc_timeline_isPlayingWhether given timeline is playing (can be paused at same time!)
BIS_fnc_timeline_isReverseWhether given timeline is in reverse mode
BIS_fnc_timeline_playPlay given timeline if currently not playing. If we are playing and paused, we unpause.
BIS_fnc_timeline_setInterpModeSet's the interpolation mode of the timeline.
BIS_fnc_timeline_setLengthSet's the length of this timeline in seconds.
BIS_fnc_timeline_setLoopSet's this timeline playback loop mode
BIS_fnc_timeline_setPausePauses or unpauses timeline.
BIS_fnc_timeline_setPlayRateSets playrate of timeline.
BIS_fnc_timeline_setPositionSets position of timeline.
BIS_fnc_timeline_setReverseChange direction of timeline.
BIS_fnc_timeline_simulateCurvesSets this timeline playback as reverse or not.
BIS_fnc_timeline_stopStops a timeline.
BIS_fnc_timeline_tickTicks a timeline.

Timeline3DEN

BIS_fnc_timeline_edenAttributesChangedAttributes change in EDEN for a timeline
BIS_fnc_timeline_edenConnectionChanged3DEN connections of a timeline is changed
BIS_fnc_timeline_edenDeletedTimeline is deleted
BIS_fnc_timeline_edenDraggedEntity is dragged in 3DEN
BIS_fnc_timeline_edenInitTime line is initialized in 3den
BIS_fnc_timeline_edenIsSelectedWhether this timeline is selected in 3den

TXScan

BIN_fnc_clearTXScanClears TXScan drawing
BIN_fnc_createTXScanCreates a scan with the name defined as class in CfgTXScans or from given params. If name doesn't exists in config and params are not provided,…
BIN_fnc_cropTXScanCrops given scan
BIN_fnc_deleteTXScanDeletes scan with given name from extension and the map
BIN_fnc_diag_TXScanAdds user action menu to the player with different TXScan diag options
BIN_fnc_drawTXScanDraws TXScan with given name
BIN_fnc_getAllTXScansReturns array of names of all TXScans stored in extension
BIN_fnc_getTXScanAngleReturns TXScan angle
BIN_fnc_getTXScanDrawDataReturns draw data for given TXScan
BIN_fnc_getTXScanPolygonReturns current intersection polygon for given scan
BIN_fnc_getTXScanPolygonDetailsReturns estimated area and perimeter of the given scan polygon
BIN_fnc_getTXScanPositionGets stored TXScan transmitter position
BIN_fnc_getTXScanPrecisionReturns stored TXScan precision
BIN_fnc_getTXScanSaveDataReturns array with given TXScan data which is used for saving/loading
BIN_fnc_getTXScanWorldBoundsReturns currently set boundaries of active area
BIN_fnc_loadTXScanStateLoads TXScan data from global saved variables into extension
BIN_fnc_preInitTXScanShould be called from preInit, contains saving/loading functions as well as default initisalization
BIN_fnc_saveTXScanStateSaves TXScan data into global variables so that it can be serialised and then loaded from game save when needed
BIN_fnc_scanTXIntersects current scan polygon (or map square if no scan exists) with triangle originated from RX position and returns the triangle
BIN_fnc_setTXScanAngleSets TXScan angle
BIN_fnc_setTXScanPolygonPre-sets intersection polygon for given scan. Can only be done with newly created scans since once the first scan is made, the polygon cannot be…
BIN_fnc_setTXScanPositionSets TXScan transmitter position
BIN_fnc_setTXScanPrecisionSets TXScan precision
BIN_fnc_setTXScanWorldBoundsSets map bounds in which scans could be carried out. Default [0,0,worldSize,worldSize]
BIN_fnc_updateTXScanDrawDataRetrieves draw data for TXScan and updates drawing

Variables

BIS_fnc_areEqualThis function returns true if all of the passed data elements are of the same type and value. One or more elements can be passed.
BIS_fnc_areEqualNotNilCompares all elements of passed array between each other and returns true is all are defined and identical.
BIS_fnc_getServerVariableFetch a variable saved on server. Used when you want to share variables only to specific clients to prevent large traffic. Must be run in scheduled…
BIS_fnc_setServerVariableSet variable stored only on server. Clients can the download it using BIS_fnc_getServerVariable. Used when you want to share variables only to…
BIS_fnc_swapVarsSwaps the values of two variables passed as String.
BIS_fnc_variableSpaceAddAdd element to variable from someone's variable space.
BIS_fnc_variableSpaceRemoveRemove element from variable from someone's variable space.

Vectors

BIN_fnc_eulerToVector
BIN_fnc_matrixMultiply
BIN_fnc_matrixTranspose
BIN_fnc_vectorToEuler
BIS_fnc_clampVectorClamps vector values between provided min/max boundaries.
BIS_fnc_crossProductReturn the cross product of two 3D vectors.
BIS_fnc_dotProductDot product of two vectors.
BIS_fnc_findLookAtGiven target location, calculates orientation vectors facing direction
BIS_fnc_interpolateVectorInterpolates vector to target, scaled by distance. Starts very fast and smoothes out.
BIS_fnc_interpolateVectorConstantInterpolates vector to target linearly.
BIS_fnc_isEqualVectorChecks whether two vectors are equal with given tolerance.
BIS_fnc_lerpVectorGiven two different vectors A and B, think of a straight line drawn between them, *alpha* saying how far along that line is the wanted vector.
BIS_fnc_magnitudeReturns the magnitude of an array of numbers. The vector can have any number of elements.
BIS_fnc_magnitudeSqrReturns the square magnitude of an array of numbers. The vector can have any number of elements.
BIS_fnc_multiplySquareMatrixByVector
BIS_fnc_rotateVector2DThis function returns a 2D vector rotated a specified number of degrees around the origin.
BIS_fnc_rotateVector3DRotates the vector around the given axis by the given angle
BIS_fnc_transformVectorDirAndUpRotates both vectorDir and vectorUp on 3 axes: z (yaw), x (pitch) and y (roll). Positive angle direction is according to the right hand rule.
BIS_fnc_unitVectorUnit Vector
BIS_fnc_vectorAddReturns the sum of two vectors.
BIS_fnc_vectorDiffReturns a vector that is the difference between two vectors.
BIS_fnc_vectorDirAndUpRelativeReturns vectorDirAndUp of object 1 relative to object 2
BIS_fnc_vectorDivideDivides vector by scalar, by dividing all vector elements.
BIS_fnc_vectorFromXToYReturns a unit vector that 'points' from *vector1* to *vector2*. This is a very useful function as it can be used with the velocity command to move…
BIS_fnc_vectorMultiplyMultiplies 3D vector by a scalar.

Vehicles

BIS_fnc_baseVehicleReturns base vehicle (i.e., vehicle which is not just derivative of other with different textures / animations).
BIS_fnc_deleteVehicleCrewDeletes specific crew member directly from the vehicle.
BIS_fnc_exportVehicleExport vehicle settings
BIS_fnc_ffvUpdateUpdate Firing From Vehicle feature depending on condition defined in turret's config.
BIS_fnc_garageSplendid™ Virtual Arsenal Garage.
BIS_fnc_getVehicleCustomizationReturn vehicle customization settings.
BIS_fnc_groupVehiclesReturns all vehicles a group possesses, assigned vehicles can be included.
BIS_fnc_initVehicleThis function changes the textures, animation sources and/or mass of a given vehicle.
BIS_fnc_initVehicleCrewMoves units into vehicle seats. When units don't exist, it will create them in a group of vehicle's side.
BIS_fnc_initVehicleKartCustomise given kart and its driver.
BIS_fnc_loadVehicleLoad vehicle appearance saved with BIS_fnc_saveVehicle.
BIS_fnc_missileLaunchPositionFixWorkaround fix for ATGM/SAM launch positions
BIS_fnc_returnVehicleTurretsReturn the path to all turrets and sub-turrets in a vehicle.
BIS_fnc_saveVehicleSave vehicle's params (textures, animations, crew).
BIS_fnc_spawnVehicleFunction to spawn a certain vehicle type with all crew (including turrets). The vehicle can either become part of an existing group or create a new…
BIS_fnc_unflipThingCalled by unflip thing action. Can be used to unflip vehicle without transition. The caller is made invincible during flipping and the original…
BIS_fnc_unflipVehicleCan be used to unflip a vehicle or a turret, without transition.
BIS_fnc_vehicleRolesReturns vehicle roles.

VR

BIS_fnc_VRCourseBallistics1
BIS_fnc_VRCourseBallistics2
BIS_fnc_VRCourseBallistics3
BIS_fnc_VRCourseBallistics4
BIS_fnc_VRCourseCommandingActions1
BIS_fnc_VRCourseCommandingActions2
BIS_fnc_VRCourseCommandingActions3
BIS_fnc_VRCourseCommandingBehaviour1
BIS_fnc_VRCourseCommandingBehaviour2
BIS_fnc_VRCourseCommandingBehaviour3
BIS_fnc_VRCourseCommandingMovement1
BIS_fnc_VRCourseCommandingMovement2
BIS_fnc_VRCourseCommandingVehicles1
BIS_fnc_VRCourseCommandingVehicles2
BIS_fnc_VRCourseCommandingVehicles3
BIS_fnc_VRCourseHeliAdvanced1
BIS_fnc_VRCourseHeliAdvanced2
BIS_fnc_VRCourseHeliAdvanced3
BIS_fnc_VRCourseHeliAdvanced4
BIS_fnc_VRCourseHeliAdvanced5
BIS_fnc_VRCourseHeliAdvanced6
BIS_fnc_VRCourseHeliBasics1
BIS_fnc_VRCourseHeliBasics2
BIS_fnc_VRCourseHeliBasics3
BIS_fnc_VRCourseHeliSlingload1
BIS_fnc_VRCourseHeliWeapons1
BIS_fnc_VRCourseHeliWeapons2
BIS_fnc_VRCourseHeliWeapons3
BIS_fnc_VRCourseHeliWeapons4
BIS_fnc_VRCourseLaunchers1
BIS_fnc_VRCourseLaunchers2
BIS_fnc_VRCourseLaunchers3
BIS_fnc_VRCoursePlaceables1
BIS_fnc_VRCoursePlaceables2
BIS_fnc_VRCoursePlaceables3
BIS_fnc_VRCourseTargetDesignation1
BIS_fnc_VRCourseTargetDesignation2
BIS_fnc_VRCourseTargetDesignation3
BIS_fnc_VRCourseWeaponHandlingA1
BIS_fnc_VRCourseWeaponHandlingA2
BIS_fnc_VRCourseWeaponHandlingA3
BIS_fnc_VRCourseWeaponHandlingB1
BIS_fnc_VRCourseWeaponHandlingB2
BIS_fnc_VRCourseWeaponHandlingB3
BIS_fnc_VRCourseWeaponHandlingC1
BIS_fnc_VRCourseWeaponHandlingC2
BIS_fnc_VRDrawBorderVisualizes area border (used primarily for VR missions).
BIS_fnc_VRDrawGridVisualizes surface grid (used primarily for VR missions).
BIS_fnc_VREffectKilledDelete body of a virtual soldier after he's killed.
BIS_fnc_VRFadeInFade In effect for VR.
BIS_fnc_VRFadeOutFade Out effect for VR.
BIS_fnc_VRHitpartInitialize hit effects on VR targets.
BIS_fnc_VRSpawnEffectVR (unit) spawn effect.
BIS_fnc_VRSpawnSelectorSpawns the course selector (used primarily for VR missions).
BIS_fnc_VRTimerTimer for VR and time trials. The following missionNamespace variables can be used: - `BIS_stopTimer`: set to true to stop the timer.

Warlords

BIS_fnc_WLAICore*N/A*
BIS_fnc_WLAIPathSegmentationSets up a path and behavior for AI to a specific sector.
BIS_fnc_WLAIPurchases*N/A*
BIS_fnc_WLAircraftArrivalSpawns a requested aircraft and makes it land properly.
BIS_fnc_WLAirdropSpawns a requested asset and drops it on a specific location.
BIS_fnc_WLAISectorScanSector scan routine for AI.
BIS_fnc_WLArsenalFilter*N/A*
BIS_fnc_WLCalculateIncomeRecalculate CP income for a specific side.
BIS_fnc_WLCalculateSectorConnectionsEvaluates sector grid so it can be drawn on map.
BIS_fnc_WLClientInitSystem init (client-side).
BIS_fnc_WLDebugDebug logging.
BIS_fnc_WLDefenceSetupRequested static weapon positionining routine.
BIS_fnc_WLDropPurchaseAirdrop location selection routine.
BIS_fnc_WLFundsInfoFunds & sector status UI handle
BIS_fnc_WLGarrisonRetreat*N/A*
BIS_fnc_WLInitSystem init.
BIS_fnc_WLInSectorAreaChecks if the given unit is inside a specific sector.
BIS_fnc_WLLoadoutApplyReapply a saved loadout.
BIS_fnc_WLLoadoutGrabSave a loadout for later.
BIS_fnc_WLMostVotedSectorEvaluates which sector was most voted for.
BIS_fnc_WLNavalArrivalSpawns a requested naval asset.
BIS_fnc_WLOpenArsenalOpens Arsenal interface.
BIS_fnc_WLOSDManages temporary info in hints.
BIS_fnc_WLOutlineIconsHandles icons selection visualization in map.
BIS_fnc_WLParseAssetList*N/A*
BIS_fnc_WLPlayersTrackingKeeps track of player unit & its marker.
BIS_fnc_WLPlayersTrackingServerManage connecting and disconnecting players.
BIS_fnc_WLPurchaseMenuPurchase interface handle.
BIS_fnc_WLRandomPosRectReturns a random position in rectangle area.
BIS_fnc_WLRecalculateServicesRefreshes a side's available services.
BIS_fnc_WLRemovalHandleUnits & vehicles garbage collector.
BIS_fnc_WLReputationCalculate player's reputiation (how rapidly they lose subordinates).
BIS_fnc_WLRequestFastTravelFast travel routine.
BIS_fnc_WLRequestFundsTransferFunds transfer routine.
BIS_fnc_WLRequestPurchaseHandles proper purchase subroutine based on asset type.
BIS_fnc_WLRequestSectorScanSector scan routine (selection part).
BIS_fnc_WLRequestVotingResetVoting reset routine.
BIS_fnc_WLSectorFundsPayoff*N/A*
BIS_fnc_WLSectorHandle*N/A*
BIS_fnc_WLSectorHandleServer*N/A*
BIS_fnc_WLSectorIconUpdateHandles sector icons.
BIS_fnc_WLSectorInitSpawns sector garrison based on its size, sends a patrolling vehicle if feasible.
BIS_fnc_WLSectorListingKeeps track of sectors status for a given side.
BIS_fnc_WLSectorPopulateSpawns sector garrison.
BIS_fnc_WLSectorScanHandle*N/A*
BIS_fnc_WLSectorsCommonInitSectors init (client-side).
BIS_fnc_WLSectorSelectionEndSector voting termination subroutine.
BIS_fnc_WLSectorSelectionHandle*N/A*
BIS_fnc_WLSectorSelectionHandleServer*N/A*
BIS_fnc_WLSectorSelectionStartInitializes sector voting.
BIS_fnc_WLSectorsSetupSectors init (server-side).
BIS_fnc_WLSectorTaskHandle*N/A*
BIS_fnc_WLSectorUpdateSector update after its owner changed.
BIS_fnc_WLSeizingBarHandleHandles the seizing bar element in UI.
BIS_fnc_WLSendResponseTeamSpawns and manages response teams.
BIS_fnc_WLShowInfoHints buffer.
BIS_fnc_WLSideToFactionReturns the primary faction for a given side.
BIS_fnc_WLSmoothTextDisplay given text smoothly.
BIS_fnc_WLSoundMsgPlay a given announcer message.
BIS_fnc_WLSubroutine_purchaseMenuAssetAvailability*N/A*
BIS_fnc_WLSubroutine_purchaseMenuGetUIScale*N/A*
BIS_fnc_WLSubroutine_purchaseMenuHandleDLC*N/A*
BIS_fnc_WLSubroutine_purchaseMenuRefresh*N/A*
BIS_fnc_WLSubroutine_purchaseMenuSetAssetDetails*N/A*
BIS_fnc_WLSubroutine_purchaseMenuSetItemsList*N/A*
BIS_fnc_WLSyncedTimeReturns time synced between server and clients
BIS_fnc_WLSyncTimeIntroduces a synchronized time value for server and clients. OBSOLETE NOW AFTER SERVERTIME FIX
BIS_fnc_WLUpdateAORecalculates AO info (sector distribution).
BIS_fnc_WLVarsInitInit variables.
BIS_fnc_WLVehicleHandleKeeps track of spawned vehicles.
BIS_fnc_WLVotingBarHandleHandles the voting bar element in UI.

Waypoints

BIN_fnc_wpAddScript
BIN_fnc_wpDroneMove
BIS_fnc_scriptedWaypointTypeReturn CfgWaypoints type of scripted waypoint. Returns empty string/config when waypoint is not scripted Returns "Custom"/CfgWaypoints root when…
BIS_fnc_wpArtilleryLet group members fire artillery barrage on waypoint position. Units must have magazine type.
BIS_fnc_wpDemineScripted "CLEAR MINES" Advanced Waypoint. The script needs a unit with the abiility to demine (engineer or explosive specialist trait and a toolkit).
BIS_fnc_wpLandLet group members land at the waypoint position.
BIS_fnc_wpPatrol
BIS_fnc_wpRelax
BIS_fnc_wpSuppress

Weapons

BIS_fnc_addWeaponAdds a weapon to the specified unit, with magazine classnames taken from the weapon's config (in CfgWeapons).
BIS_fnc_baseWeaponDetermines base weapon class, with no attachments.
BIS_fnc_classWeaponReturns class of weapon given by string.
BIS_fnc_compatibleMagazinesGets all compatible magazines for selected weapons. Function looks both for magazines listed in `magazines` array and compatible `magazineWells`.
BIS_fnc_fireMakes a unit or a vehicle fire given muzzle. Make sure that there is some ammo to fire, and, in case of a unit, the weapon with given muzzle is…
BIS_fnc_magazinesEntityTypeReturn object's magazines as defined in config. Scans also turrets and pylons.
BIS_fnc_packStaticWeaponThis function will make weapon team pack a static weapon. The weapon crew will pack carried weapon (or given weapon if different) and follow leader.…
BIS_fnc_unpackStaticWeaponThis function will move given support team to the given weapon position. The weapon crew will unpack carried weapon and start watching given target…
BIS_fnc_weaponAddonReturn addon from CfgPatches to which a given weapon class belongs to.
BIS_fnc_weaponComponentsReturns array with classname of the parent weapon (without attachments), followed by classnames of all its attachments.
BIS_fnc_weaponDirectionRelativeReturns relative direction vector of given weapon for the given vehicle
BIS_fnc_weaponsEntityTypeReturn object's weapons as defined in config. Scans also turrets and pylons.

Functions

AI Human

Aircraft Carrier

Aircraft Functionality

Ambient

Arrays

Behavior

Bitwise

Boat Recovery

Briefing

Broken Functions

Camera

Camera3DEN

Campaign

CampaignLobby

CampaignManager

Cargo Platform

Checkpoint

Collisions

Combat

CombatPatrol

Communication Menu

Configs

Contact

ControlPoint

ControlPoint3DEN

Conversations

Curator

CuratorChallenges

Curve3DEN

Database

Decon Shower

Destroyer

Diagnostic

Diary

Eden Editor

Effects

EM Interface

Environment

Event Handlers

Feedback

Geometry

GUI

Helicopters

IDWMap

Interaction

Interpolation

Inventory

Key

Key3DEN

KeyframeAnimation

Live Feed

Map and Markers

Math

Mission Parameters

Missions

Modules

Modules - CBRN

Modules - Curator

Modules - Firing Drills

Modules - Live Feed

Modules - Strategic

Modules - Time Trials

Movement

Multiplayer

Object Manipulation

Old Man

OO

Phone

Positions

Priority Queue

Probe

Probing

Program Flow

Puzzles

Radio

Respawn

Revive

RichCurve

Scenes