Functions by Functionality – Category

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "\[\[Eden( |_)Editor\]\]" to "Eden Editor")
 
(28 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Hatnote|See also: [[Scripting Commands by Functionality]]}}
{| class="wikitable sortable" width = "100%"
__NOTOC__
|-
== Introduction ==
! Function Group !! Description !! Examples !! Only for !! #Functions / #Subcategories
This page has been created to help you find the appropriate functions when you are dealing with specific scripting situations (e.g. all functions that have to do with triggers, or to control unit behaviour, etc.).
|-
 
| style="width: 8%" | [[:Category:Function Group: Ambient|Ambient]] || Functions to fill a mission with life. || [[BIS_fnc_ambientAnim]], [[BIS_fnc_ambientFlyby]] || || {{PAGESINCATEGORY:Function Group: Ambient|pages}}
Keep in mind that there can be cases where certain functions may appear in more than one category.
|-
 
| [[:Category:Function Group: Arrays|Arrays]] || Functions to manipulate arrays. || [[BIS_fnc_arrayInsert]], [[BIS_fnc_arrayFindDeep]] || || {{PAGESINCATEGORY:Function Group: Arrays|pages}} / {{PAGESINCATEGORY:Function Group: Arrays|subcats}}
{{Informative|Non-categorised functions can be found in [[:Category:Function Group: Uncategorised]].}}
|-
{{Informative|Command groups might differ from the categories used ingame in the [[Arma 3 Functions Viewer]].}}
| [[:Category:Function Group: Bitwise|Bitwise]] || Functions for bitwise operations and working with flags. || [[BIS_fnc_bitwiseAND]], [[BIS_fnc_decodeFlags8]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Bitwise|pages}}
 
|-
<div class="floating-box fnc">
| [[:Category:Function Group: Briefing|Briefing]] || Functions to create briefings. || [[BIS_fnc_briefingAnimate]], [[BIS_fnc_briefingInit]] || || {{PAGESINCATEGORY:Function Group: Briefing|pages}}
==[[:Category:Function Group: Actions|Actions]]==
|-
'''Description.'''
| [[:Category:Function Group: Broken Functions|Broken Functions]] || Functions which do not work or have no effect at all. || - || || {{PAGESINCATEGORY:Function Group: Broken Functions|pages}}
;e.g.
|-
:[[BIS_fnc_packStaticWeapon]]
| [[:Category:Function Group: Camera|Camera]] || Functions to manipulate cameras. || [[BIS_fnc_camera_deleted]], [[BIS_fnc_camera_getFocus]] || || {{PAGESINCATEGORY:Function Group: Camera|pages}}
:[[BIS_fnc_unpackStaticWeapon]]
|-
</div>
| [[:Category:Function Group: Campaign|Campaign]] || Mostly functions used in the APEX Protocol campaign. Also see [[:Category:Function Group: CampaignLobby|CampaignLobby]] and [[:Category:Function Group: CampaignManager|CampaignManager]]. || [[BIS_fnc_EXP_camp_addTickets]], [[BIS_fnc_isCampaign]] || || {{PAGESINCATEGORY:Function Group: Campaign|pages}} / {{PAGESINCATEGORY:Function Group: Campaign|subcats}}
 
|-
<div class="floating-box fnc">
| [[:Category:Function Group: Combat|Combat]] || Functions used to manipulate AI in combat. || [[BIS_fnc_fire]], [[BIS_fnc_stalk]] || || {{PAGESINCATEGORY:Function Group: Combat|pages}}
==[[:Category:Function Group: Ambient|Ambient]]==
|-
'''Description.'''
| [[:Category:Function Group: CombatPatrol|CombatPatrol]] || Functions used in the [[Arma 3 MP Combat Patrol]] game mode. || [[BIS_fnc_CPDummy]], [[BIS_fnc_CPInit]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: CombatPatrol|pages}}
;e.g.
|-
:[[BIS_fnc_ambientAnim]]
| [[:Category:Function Group: Communication Menu|Communication Menu]] || Functions used to add or remove entries from the communication menu. || [[BIS_fnc_addCommMenuItem]], [[BIS_fnc_commsMenuToggleAvailability]] || || {{PAGESINCATEGORY:Function Group: Communication Menu|pages}}
:[[BIS_fnc_ambientFlyby]]
|-
:[[BIS_fnc_animalBehaviour]]
| [[:Category:Function Group: Configs|Configs]] || Functions to work with configs. || [[BIS_fnc_getCfgSubClasses]], [[BIS_fnc_getCfg]] || || {{PAGESINCATEGORY:Function Group: Configs|pages}}
:[[BIS_fnc_ambientBlacklist]]
|-
</div>
| [[:Category:Function Group: Contact|Contact]] || Functions used in the [[Arma 3 Contact]] campaign. Many of them cannot be used ouside of the Contact DLC. || [[BIN_fnc_inDangerZone]], [[BIN_fnc_showSimpleNotification]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Contact|pages}} / {{PAGESINCATEGORY:Function Group: Contact|subcats}}
 
|-
<div class="floating-box fnc">
| [[:Category:Function Group: Conversations|Conversations]] || Functions used with [[Conversations]]. || [[BIS_fnc_kbTell]], [[BIS_fnc_kbMenu]] || || {{PAGESINCATEGORY:Function Group: Conversations|pages}}
==[[:Category:Function Group: Animals|Animals]]==
|-
'''Description.'''
| [[:Category:Function Group: Curator|Curator (Zeus)]] || [[Arma 3: Curator|Curator]] ([[Arma 3 Zeus|Zeus]]) related functions. For modules see [[:Category:Function Group: Modules - Curator|Modules - Curator]]. || [[BIS_fnc_curatorHint]], [[BIS_fnc_isCurator]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Curator|pages}} / {{PAGESINCATEGORY:Function Group: Scripts|subcats}}
;e.g.
|-
:[[BIS_fnc_moduleAnimals]]
| [[:Category:Function Group: Database|Database]] || Functions to create and change databases. || [[BIS_fnc_dbClassId]], [[BIS_fnc_dbSymbolClass]] || {{arma3}} and {{tkoh}} || {{PAGESINCATEGORY:Function Group: Database|pages}}
</div>
|-
 
| [[:Category:Function Group: Diagnostic|Diagnostic]] || Debug functions. || [[BIS_fnc_debugConsoleExec]], [[BIS_fnc_fps]] || || {{PAGESINCATEGORY:Function Group: Diagnostic|pages}}
<div class="floating-box fnc">
|-
==[[:Category:Function Group: Arrays|Arrays]]==
| [[:Category:Function Group: Eden Editor|Eden Editor]] || [[:Category:Eden Editor|Eden Editor]] related functions. || [[BIS_fnc_3DENIntel]], [[BIS_fnc_3DENTutorial]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Eden Editor|pages}}
'''Description.'''
|-
;e.g.
| [[:Category:Function Group: Effects|Effects]] || Functions to manipulate various effects like guns firing. || [[BIS_fnc_effectFired]], [[BIS_fnc_healthEffects]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Effects|pages}}
:[[BIS_fnc_arrayPush]]
|-
:[[BIS_fnc_findExtreme]]
| [[:Category:Function Group: Environment|Environment]] || Functions to change the environment e.g., time, weather || [[BIS_fnc_calculateDateTime]], [[BIS_fnc_interpolateWeather]] ||  || {{PAGESINCATEGORY:Function Group: Environment|pages}}
:[[BIS_fnc_returnNestedElement]]
|-
:[[BIS_fnc_randomIndex]]
| [[:Category:Function Group: Event Handlers|Event Handlers]] || Functions to work with Event Handlers || [[BIS_fnc_addScriptedEventHandler]], [[BIS_fnc_onLoad]] ||  || {{PAGESINCATEGORY:Function Group: Event Handlers|pages}}
:[[BIS_fnc_sortBy]]
|-
</div>
| [[:Category:Function Group: Feedback|Feedback]] || Functions used to give the player feedback about his status. || [[BIS_fnc_bloodEffect]], [[BIS_fnc_radialRed]] ||  || {{PAGESINCATEGORY:Function Group: Feedback|pages}}
 
|-
<div class="floating-box fnc">
| [[:Category:Function Group: GUI|GUI]] || GUI related function. || [[BIS_fnc_getIDC]], [[BIS_fnc_ctrlSetScale]] ||  || {{PAGESINCATEGORY:Function Group: GUI|pages}}
==[[:Category:Function Group: Briefing|Briefing]]==
|-
'''Description.'''
| [[:Category:Function Group: Interaction|Interaction]] || Functions to allow player to interact with objects. || [[BIS_fnc_holdKey]], [[BIS_fnc_keyHold]] ||  || {{PAGESINCATEGORY:Function Group: Interaction|pages}}
;e.g.
|-
:[[BIS_fnc_briefingAnimate]]
| [[:Category:Function Group: Inventory|Inventory]] || Inventory related functions. || [[BIS_fnc_saveInventory]], [[BIS_fnc_hasItem]] ||  || {{PAGESINCATEGORY:Function Group: Inventory|pages}}
:[[BIS_fnc_briefingInit]]
|-
</div>
| [[:Category:Function Group: KeyframeAnimation|KeyframeAnimation]] || Functions related to the [[Arma 3 Key Frame Animation]] system. || [[BIS_fnc_keyframeAnimation_deltaTime]], [[BIS_fnc_keyframeAnimation_init]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: KeyframeAnimation|pages}} / {{PAGESINCATEGORY:Function Group: KeyframeAnimation|subcats}}
 
|-
<div class="floating-box fnc">
| [[:Category:Function Group: Live Feed|Live Feed]] || Functions related live feed system. || [[BIS_fnc_liveFeed]], [[BIS_fnc_liveFeedEffects]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Live Feed|pages}}
==[[:Category:Function Group: CAS|CAS]]==
|-
'''Description.'''
| [[:Category:Function Group: Map and Markers|Map and Markers]] || Functions to be used with markers or the map. || [[BIS_fnc_drawAO]], [[BIS_fnc_blinkMarker]] || || {{PAGESINCATEGORY:Function Group: Map and Markers|pages}}
;e.g.
|-
:[[BIS_fnc_moduleCAS]]
| [[:Category:Function Group: Math|Math]] || Math related functions. See also: [[:Category:Function Group: Geometry|Geometry]], [[:Category:Function Group: Interpolation|Interpolation]] and [[:Category:Function Group: Vectors|Vectors]]. || [[BIS_fnc_pow]], [[BIS_fnc_nearestNum]] || || {{PAGESINCATEGORY:Function Group: Math|pages}} / {{PAGESINCATEGORY:Function Group: Math|subcats}}
</div>
|-
 
| [[:Category:Function Group: Mission Parameters|Mission Parameters]] || Functions for [[Mission Parameters]]. || [[BIS_fnc_getParamValue]], [[BIS_fnc_initParams]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Mission Parameters|pages}}
<div class="floating-box fnc">
|-
==[[:Category:Function Group: Combat|Combat]]==
| [[:Category:Function Group: Missions|Missions]] || Functions to get information about missions or manipulate the mission flow. || [[BIS_fnc_singleMissionConfig]], [[BIS_fnc_countdown]] || || {{PAGESINCATEGORY:Function Group: Missions|pages}}
'''Description.'''
|-
;e.g.
| [[:Category:Function Group: Modules|Modules]] || Functions used by modules. Make sure to check the subcategories as well. [[Arma 3: Old Man Systems]] modules are in [[:Category:Function Group: Old Man|Function Group: Old Man]]. || [[BIS_fnc_singleMissionConfig]], [[BIS_fnc_countdown]] || || {{PAGESINCATEGORY:Function Group: Modules|pages}} / {{PAGESINCATEGORY:Function Group: Modules|subcats}}
:[[BIS_fnc_enemyDetected]]
|-
:[[BIS_fnc_enemyTargets]]
| [[:Category:Function Group: Multiplayer|Multiplayer]] || Functions designed for multiplayer missions. || [[BIS_fnc_admin]], [[BIS_fnc_listPlayers]] || || {{PAGESINCATEGORY:Function Group: Multiplayer|pages}}
</div>
|-
 
| [[:Category:Function Group: Object Manipulation|Object Manipulation]] || Get or set various different properties of units, vehicles and other objects. Also check out the subcategories for very object specific functions. || [[BIS_fnc_attachToRelative]], [[BIS_fnc_neutralizeUnit]] || || {{PAGESINCATEGORY:Function Group: Object Manipulation|pages}} / {{PAGESINCATEGORY:Function Group: Object Manipulation|subcats}}
<div class="floating-box fnc">
|-
==[[:Category:Function Group: Configs|Configs]]==
| [[:Category:Function Group: Old Man|Old Man]] || Functions used by the [[Arma 3 Apex: Old Man]] scenario. || [[BIS_fnc_OM_credits]], [[BIS_fnc_OM_init]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Old Man|pages}} / {{PAGESINCATEGORY:Function Group: Old Man|subcats}}
'''Description.'''
|-
;e.g.
| [[:Category:Function Group: OO|OO]] || Function for '''O'''bject '''O'''riented (OO) scripting. || [[BIS_fnc_addClassOO]], [[BIS_fnc_createObjectOO]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: OO|pages}}
:[[BIS_fnc_loadClass]]
|-
:[[BIS_fnc_returnParents]]
| [[:Category:Function Group: Positions|Positions]] || Functions to work with positions. || [[BIS_fnc_position]], [[BIS_fnc_buildingPositions]] || || {{PAGESINCATEGORY:Function Group: Positions|pages}}
:[[BIS_fnc_getCfgDataPool]]
|-
:[[BIS_fnc_getCfgData]]
| [[:Category:Function Group: Priority Queue|Priority Queue]] || Functions to set up and manipulate a priority queue. || [[BIS_fnc_priorityQueue_GetLowestPriority]], [[BIS_fnc_priorityQueue_Init]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Priority Queue|pages}}
</div>
|-
 
| [[:Category:Function Group: Program Flow|Program Flow]] || Functions used to execute scripts or handle their flow. || [[BIS_fnc_spawn]], [[BIS_fnc_call]] || || {{PAGESINCATEGORY:Function Group: Program Flow|pages}}
<div class="floating-box fnc">
|-
==[[:Category:Function Group: Conversations|Conversations]]==
| [[:Category:Function Group: Radio|Radio]] || Radio related functions. || [[BIS_fnc_diagRadio]], [[BIS_fnc_radioSetChannel]] || {{arma3}} and {{tkoh}} || {{PAGESINCATEGORY:Function Group: Radio|pages}}
'''Description.'''
|-
;e.g.
| [[:Category:Function Group: Respawn|Respawn]] || Functions used to set up and manipulate the respawn functionality. See [[Arma 3: Respawn]]. || [[BIS_fnc_addRespawnInventory]], [[BIS_fnc_respawnSeagull]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Respawn|pages}}
:[[BIS_fnc_genericSentence]]
|-
:[[BIS_fnc_genericSentenceInit]]
| [[:Category:Function Group: Revive|Revive]] || Functions used to set up and manipulate the revive functionality. See [[Arma 3: Revive]]. || [[BIS_fnc_disableRevive]], [[BIS_fnc_reviveInit]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Revive|pages}}
:[[BIS_fnc_kbCreateDummy]]
|-
:[[BIS_fnc_kbTopicConfig]]
|-
</div>
| [[:Category:Function Group: RichCurve|Rich Curve]] || Functions used to work with rich curves. || [[BIS_fnc_richCurve_getCurveLength]], [[BIS_fnc_richCurve_getKeysAtTime]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: RichCurve|pages}}
 
|-
<div class="floating-box fnc">
| [[:Category:Function Group: Scenes|Scenes]] || Set up scenes with these funcitons. || [[BIS_fnc_sceneAreaClearance]], [[BIS_fnc_sceneMiscStuff]] || || {{PAGESINCATEGORY:Function Group: Scenes|pages}}
==[[:Category:Function Group: Curator|Curator]]==
|-
'''Description.'''
| [[:Category:Function Group: Scripts|Scripts]] || Scripts on these page usually only have one very specific functionality and usually can not be used for anything else. || [[BIS_fnc_dataTerminalAnimate]], [[BIS_fnc_lockedDoorOpen]] || || {{PAGESINCATEGORY:Function Group: Scripts|pages}} / {{PAGESINCATEGORY:Function Group: Scripts|subcats}}
;e.g.
|-
:[[BIS_fnc_drawCuratorRespawnMarkers]]
| [[:Category:Function Group: Sides|Sides]] || Side related functions. || [[BIS_fnc_areFriendly]], [[BIS_fnc_playerSideFaction]] || || {{PAGESINCATEGORY:Function Group: Sides|pages}}
:[[BIS_fnc_moduleCuratorSetAttributes]]
|-
:[[BIS_fnc_moduleCuratorSetCamera]]
| [[:Category:Function Group: Sound|Sound]] || Functions to play music or set up sounds. || [[BIS_fnc_jukebox]], [[BIS_fnc_music]] || || {{PAGESINCATEGORY:Function Group: Sound|pages}}
:[[BIS_fnc_curatorWaypointPlaced]]
|-
:[[BIS_fnc_addCuratorAreaFromTrigger]]
| [[:Category:Function Group: Spectator|Spectator]] || An overview of functions used by the [[EG Spectator Mode]]. || [[BIS_fnc_EGSpectator]], [[BIS_fnc_EGSpectatorCamera]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Spectator|pages}}
</div>
|-
 
| [[:Category:Function Group: Strategic|Strategic]] || Functions for the strategic map and ORBAT feature. || [[BIS_fnc_ORBATOpen]], [[BIS_fnc_strategicMapOpen]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Strategic|pages}}
<div class="floating-box fnc">
|-
==[[:Category:Function Group: CuratorChallenges|CuratorChallenges]]==
| [[:Category:Function Group: Strings|Strings]] || Functions to work with strings. || [[BIS_fnc_filterString]], [[BIS_fnc_splitString]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Strings|pages}}
'''Description.'''
|-
;e.g.
| [[:Category:Function Group: Supports|Supports]] || Functions to set up support requests. || [[BIS_fnc_addSupportLink]], [[BIS_fnc_fireSupport]] || || {{PAGESINCATEGORY:Function Group: Supports|pages}}
:[[BIS_fnc_addCuratorChallenge]]
|-
:[[BIS_fnc_curatorChallengeIlluminate]]
| [[:Category:Function Group: Systems|Systems]] || Functions for various systems like [[Arma 3: Dynamic Groups]]. || [[BIS_fnc_dynamicGroups]], [[BIS_fnc_missionSelector]] || || {{PAGESINCATEGORY:Function Group: Systems|pages}}
:[[BIS_fnc_curatorChallengeSpawnLightning]]
|-
:[[BIS_fnc_manageCuratorChallenges]]
| [[:Category:Function Group: Tasks|Tasks]] || Functions to create tasks for player and AI. See [[Arma 3: Task Framework]]. || [[BIS_fnc_taskAttack]], [[BIS_fnc_taskSetType]] || || {{PAGESINCATEGORY:Function Group: Tasks|pages}}
</div>
|-
<!--
| [[:Category:Function Group: Timeline|Timeline]] || Functions to create a timeline with events. || [[BIS_fnc_timeline_init]], [[BIS_fnc_timeline_isPaused]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: Timeline|pages}}
<div class="floating-box fnc">
|-
==[[:Category:Function Group: CuratorLite|CuratorLite]]==
| [[:Category:Function Group: Uncategorised|Uncategorised]] || Functions which have no defined category. || {{n/a}} || || {{PAGESINCATEGORY:Function Group: Uncategorised|pages}}
'''Description.'''
|-
;e.g.
| [[:Category:Function Group: Variables|Variables]] || Compare and set variables. || [[BIS_fnc_areEqual]], [[BIS_fnc_setServerVariable]] || || {{PAGESINCATEGORY:Function Group: Variables|pages}}
:None
|-
</div>
| [[:Category:Function Group: Vehicles|Vehicles]] || Functions to work with vehicles. || [[BIS_fnc_absSpeed]], [[BIS_fnc_initVehicle]] || || {{PAGESINCATEGORY:Function Group: Vehicles|pages}}
-->
|-
 
| [[:Category:Function Group: VR|VR]] || Functions used by the Virtual Reality missions from the {{arma3}} Bootcamp update. Mostly FSMs. || [[BIS_fnc_VRCourseBallistics1]], [[BIS_fnc_VRCourseHeliWeapons2]] || {{arma3}} || {{PAGESINCATEGORY:Function Group: VR|pages}}
<div class="floating-box fnc">
|-
==[[:Category:Function Group: Database|Database]]==
| [[:Category:Function Group: Warlords|Warlords]] || [[Arma 3 MP Warlords]] functions. || [[BIS_fnc_WLAICore]], [[BIS_fnc_WLSendResponseTeam]]  || {{arma3}} || {{PAGESINCATEGORY:Function Group: Warlords|pages}}
'''Description.'''
|-
;e.g.
| [[:Category:Function Group: Waypoints|Waypoints]] || Functions to work with waypoints. || [[BIS_fnc_wpRelax]], [[BIS_fnc_wpTimed]] || || {{PAGESINCATEGORY:Function Group: Waypoints|pages}}
:[[BIS_fnc_dbImportConfig]]
|-
:[[BIS_fnc_dbValueRemove]]
| [[:Category:Function Group: Weapons|Weapons]] || Weapon related functions. || [[BIS_fnc_compatibleMagazines]], [[BIS_fnc_weaponAddon]] || || {{PAGESINCATEGORY:Function Group: Weapons|pages}}
:[[BIS_fnc_dbValueReturn]]
|}
:[[BIS_fnc_dbValueSet]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Debug|Debug]]==
'''Description.'''
;e.g.
:[[BIS_fnc_codePerformance]]
:[[BIS_fnc_functionPath]]
:[[BIS_fnc_halt]]
:[[BIS_fnc_isDemo]]
:[[BIS_fnc_shutdown]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Diagnostic|Diagnostic]]==
'''Description.'''
;e.g.
:[[BIS_fnc_diagAnim]]
:[[BIS_fnc_diagBulletCam]]
:[[BIS_fnc_diagKnownTargets]]
:[[BIS_fnc_diagRadio]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Eden Editor|Eden Editor]]==
'''Description.'''
;e.g.
:[[BIS_fnc_3DENCamera]]
:[[BIS_fnc_3DENExportOldSQM]]
:[[BIS_fnc_3DENIntel]]
:[[BIS_fnc_3DENShowMessage]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Effects|Effects]]==
'''Description.'''
;e.g.
:[[BIS_fnc_effectFired]]
:[[BIS_fnc_effectFiredRocket]]
:[[BIS_fnc_effectKilledAirDestruction]]
:[[BIS_fnc_moduleEffectsBubbles]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Environment|Environment]]==
'''Description.'''
;e.g.
:[[BIS_fnc_destroyCity]]
:[[BIS_fnc_moduleSkiptime]]
:[[BIS_fnc_sandstorm]]
:[[BIS_fnc_setFog]]
:[[BIS_fnc_setOvercast]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Events|Events]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleDate]]
:[[BIS_fnc_moduleGenericRadio]]
:[[BIS_fnc_moduleSaveGame]]
:[[BIS_fnc_moduleVolume]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Feedback|Feedback]]==
'''Description.'''
;e.g.
:[[BIS_fnc_bloodEffect]]
:[[BIS_fnc_damagePulsing]]
:[[BIS_fnc_fatigueEffect]]
:[[BIS_fnc_indicateBleeding]]
:[[BIS_fnc_healing]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Geometry|Geometry]]==
'''Description.'''
;e.g.
:[[BIS_fnc_dirTo]]
:[[BIS_fnc_distance2D]]
:[[BIS_fnc_inAngleSector]]
:[[BIS_fnc_isInsideArea]]
:[[BIS_fnc_relativeDirTo]]
:[[BIS_fnc_relPos]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: GroupModifiers|GroupModifiers]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleCombatGetIn]]
:[[BIS_fnc_moduleGroupID]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: GUI|GUI]]==
'''Description.'''
;e.g.
:[[BIS_fnc_3Dcredits]]
:[[BIS_fnc_credits]]
:[[BIS_fnc_GUIeditor]]
:[[BIS_fnc_typeText]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Helicopters|Helicopters]]==
'''Description.'''
;e.g.
:[[BIS_fnc_helicopterCanFly]]
:[[BIS_fnc_helicopterDamage]]
:[[BIS_fnc_helicopterSeat]]
:[[BIS_fnc_helicopterType]]
</div>
 
<!--
<div class="floating-box fnc">
==[[:Category:Function Group: Heliport|Heliport]]==
'''Description.'''
;e.g.
:None
</div>
-->
<div class="floating-box fnc">
==[[:Category:Function Group: Hints|Hints]]==
'''Description.'''
;e.g.
:[[BIS_fnc_advHint]]
:[[BIS_fnc_advHintArg]]
:[[BIS_fnc_advHintCall]]
:[[BIS_fnc_advHintCredits]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Intel|Intel]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleCreateDiaryRecord]]
:[[BIS_fnc_moduleDiary]]
:[[BIS_fnc_moduleHQ]]
:[[BIS_fnc_moduleTaskCreate]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Inventory|Inventory]]==
'''Description.'''
;e.g.
:[[BIS_fnc_addWeapon]]
:[[BIS_fnc_baseWeapon]]
:[[BIS_fnc_deleteInventory]]
:[[BIS_fnc_invAdd]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: LiveFeed|LiveFeed]]==
'''Description.'''
;e.g.
:[[BIS_fnc_liveFeedModuleEffects]]
:[[BIS_fnc_liveFeedModuleInit]]
:[[BIS_fnc_liveFeedModuleSetSource]]
:[[BIS_fnc_liveFeedModuleSetTarget]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Map|Map]]==
'''Description.'''
;e.g.
:[[BIS_fnc_drawAO]]
:[[BIS_fnc_mapSize]]
:[[BIS_fnc_markerToTrigger]]
:[[BIS_fnc_markWaypoints]]
:[[BIS_fnc_randomPosTrigger]]
:[[BIS_fnc_worldArea]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Mines|Mines]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleMine]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Misc|Misc]]==
'''Description.'''
;e.g.
:[[BIS_fnc_addStackedEventHandler]]
:[[BIS_fnc_buildingPositions]]
:[[BIS_fnc_listPlayers]]
:[[BIS_fnc_posToGrid]]
:[[BIS_fnc_runLater]]
:[[BIS_fnc_traceBullets]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Missions|Missions]]==
'''Description.'''
;e.g.
:[[BIS_fnc_basicTask]]
:[[BIS_fnc_forceEnd]]
:[[BIS_fnc_missionHandlers]]
:[[BIS_fnc_missionTasks]]
:[[BIS_fnc_singleMissionConfig]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: MissionTypes|MissionTypes]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleMPTypeDefense]]
:[[BIS_fnc_moduleMPTypeGameMaster]]
:[[BIS_fnc_moduleMPTypeSectorControl]]
:[[BIS_fnc_moduleMPTypeSeize]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: ModuleFiringDrills|ModuleFiringDrills]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleFDCPClear]]
:[[BIS_fnc_moduleFDCPIn]]
:[[BIS_fnc_moduleFDCPOut]]
:[[BIS_fnc_moduleFiringDrill]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Modules|Modules]]==
'''Description.'''
;e.g.
:[[BIS_fnc_initModules]]
:[[BIS_fnc_moduleExecute]]
:[[BIS_fnc_moduleModules]]
:[[BIS_fnc_moduleTriggers]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: ModuleTimeTrials|ModuleTimeTrials]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleTimeTrial]]
:[[BIS_fnc_moduleTTCPIn]]
:[[BIS_fnc_moduleTTCPOut]]
:[[BIS_fnc_moduleTTCPTrigger]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: MP|Multiplayer]]==
'''Description.'''
;e.g.
:[[BIS_fnc_call]]
:[[BIS_fnc_execVM]]
:[[BIS_fnc_MP]]
:[[BIS_fnc_MPexec]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Multiplayer|Multiplayer]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleBleedTickets]]
:[[BIS_fnc_moduleCountdown]]
:[[BIS_fnc_moduleRespawnTickets]]
:[[BIS_fnc_moduleSector]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Numbers|Numbers]]==
'''Description.'''
;e.g.
:[[BIS_fnc_countdown]]
:[[BIS_fnc_cutDecimals]]
:[[BIS_fnc_greatestNum]]
:[[BIS_fnc_randomNum]]
:[[BIS_fnc_roundNum]]
:[[BIS_fnc_sortNum]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Objectives|Objectives]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleObjective]]
:[[BIS_fnc_moduleObjectiveFind]]
:[[BIS_fnc_moduleObjectiveSector]]
:[[BIS_fnc_moduleObjectiveTarget]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: ObjectModifiers|ObjectModifiers]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleAI]]
:[[BIS_fnc_moduleDoorOpen]]
:[[BIS_fnc_moduleMode]]
:[[BIS_fnc_moduleShowHide]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Objects|Objects]]==
'''Description.'''
;e.g.
:[[BIS_fnc_boundingBoxDimensions]]
:[[BIS_fnc_boundingCircle]]
:[[BIS_fnc_getTurrets]]
:[[BIS_fnc_objectType]]
:[[BIS_fnc_spawnObjects]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: OO|OO]]==
'''Description.'''
;e.g.
:[[BIS_fnc_addClassOO]]
:[[BIS_fnc_createObjectOO]]
:[[BIS_fnc_validateParametersOO]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Params|Params]]==
'''Description.'''
;e.g.
:[[BIS_fnc_getParamValue]]
:[[BIS_fnc_initParams]]
:[[BIS_fnc_paramCountdown]]
:[[BIS_fnc_paramDaytime]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Radio|Radio]]==
'''Description.'''
;e.g.
:[[BIS_fnc_radioSetChannel]]
:[[BIS_fnc_radioSetPlaylist]]
:[[BIS_fnc_radioSetTrack]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Respawn|Respawn]]==
'''Description.'''
;e.g.
:[[BIS_fnc_addRespawnInventory]]
:[[BIS_fnc_addRespawnPosition]]
:[[BIS_fnc_getRespawnInventories]]
:[[BIS_fnc_respawnSeagull]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Scenes|Scenes]]==
'''Description.'''
;e.g.
:[[BIS_fnc_sceneCheckWeapons]]
:[[BIS_fnc_sceneGetObjects]]
:[[BIS_fnc_sceneSetBehaviour]]
:[[BIS_fnc_sceneSetObjects]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Sides|Sides]]==
'''Description.'''
;e.g.
:[[BIS_fnc_areFriendly]]
:[[BIS_fnc_enemySides]]
:[[BIS_fnc_friendlySides]]
:[[BIS_fnc_sideName]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Sites|Sites]]==
'''Description.'''
;e.g.
:[[BIS_fnc_animalSiteSpawn]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Skirmish|Skirmish]]==
'''Description.'''
;e.g.
:[[BIS_fnc_skirmishTrigger]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Spawning|Spawning]]==
'''Description.'''
;e.g.
:[[BIS_fnc_ObjectsGrabber]]
:[[BIS_fnc_ObjectsMapper]]
:[[BIS_fnc_prepareAO]]
:[[BIS_fnc_selectCrew]]
:[[BIS_fnc_spawnCrew]]
:[[BIS_fnc_spawnVehicle]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Strategic|Strategic]]==
'''Description.'''
;e.g.
:[[BIS_fnc_getUnitInsignia]]
:[[BIS_fnc_ORBATAnimate]]
:[[BIS_fnc_ORBATOpen]]
:[[BIS_fnc_ORBATTooltip]]
:[[BIS_fnc_setUnitInsignia]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: StrategicMap|StrategicMap]]==
'''Description.'''
;e.g.
:[[BIS_fnc_moduleStrategicMapImage]]
:[[BIS_fnc_moduleStrategicMapInit]]
:[[BIS_fnc_moduleStrategicMapMission]]
:[[BIS_fnc_moduleStrategicMapOpen]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Strings|Strings]]==
'''Description.'''
;e.g.
:[[BIS_fnc_alignTabs]]
:[[BIS_fnc_filterString]]
:[[BIS_fnc_inString]]
:[[BIS_fnc_phoneticalWord]]
:[[BIS_fnc_splitString]]
:[[BIS_fnc_trimString]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Supports|Supports]]==
'''Description.'''
;e.g.
:[[BIS_fnc_addSupportLink]]
:[[BIS_fnc_changeSupportRadioChannel]]
:[[BIS_fnc_limitSupport]]
:[[BIS_fnc_removeSupportLink]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Systems|Systems]]==
'''Description.'''
;e.g.
:[[BIS_fnc_RespawnManager]]
:[[BIS_fnc_respect]]
:[[BIS_fnc_supplydrop]]
:[[BIS_fnc_supplydropService]]
:[[BIS_fnc_transportService]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Tasks|Tasks]]==
'''Description.'''
;e.g.
:[[BIS_fnc_deleteTask]]
:[[BIS_fnc_setTask]]
:[[BIS_fnc_taskCreate]]
:[[BIS_fnc_taskState]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Variables|Variables]]==
'''Description.'''
;e.g.
:[[BIS_fnc_areEqual]]
:[[BIS_fnc_getServerVariable]]
:[[BIS_fnc_loadFunctions]]
:[[BIS_fnc_setServerVariable]]
:[[BIS_fnc_swapVars]]
:[[BIS_fnc_variableSpaceAdd]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Vectors|Vectors]]==
'''Description.'''
;e.g.
:[[BIS_fnc_magnitude]]
:[[BIS_fnc_rotateVector2D]]
:[[BIS_fnc_unitVector]]
:[[BIS_fnc_vectorFromXToY]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Vehicles|Vehicles]]==
'''Description.'''
;e.g.
:[[BIS_fnc_absSpeed]]
:[[BIS_fnc_missileLaunchPositionFix]]
:[[BIS_fnc_vehicleRoles]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: VR|VR]]==
'''Description.'''
;e.g.
:[[BIS_fnc_VRCourseBallistics1]]
:[[BIS_fnc_VRCourseCommandingActions1]]
:[[BIS_fnc_VRCourseCommandingBehaviour1]]
:[[BIS_fnc_VRCourseCommandingMovement1]]
:[[BIS_fnc_VRCourseCommandingVehicles1]]
</div>
 
<div class="floating-box fnc">
==[[:Category:Function Group: Waypoints|Waypoints]]==
'''Description.'''
;e.g.
:[[BIS_fnc_scriptedWaypointType]]
:[[BIS_fnc_wpFastRope]]
:[[BIS_fnc_wpLand]]
:[[BIS_fnc_wpPatrol]]
:[[BIS_fnc_wpSuppress]]
</div>
 
<br clear="all">


[[Category:Functions]]
[[Category:Functions]]

Latest revision as of 14:24, 9 July 2023

Function Group Description Examples Only for #Functions / #Subcategories
Ambient Functions to fill a mission with life. BIS_fnc_ambientAnim, BIS_fnc_ambientFlyby 13
Arrays Functions to manipulate arrays. BIS_fnc_arrayInsert, BIS_fnc_arrayFindDeep 42 / 1
Bitwise Functions for bitwise operations and working with flags. BIS_fnc_bitwiseAND, BIS_fnc_decodeFlags8 Arma 3 17
Briefing Functions to create briefings. BIS_fnc_briefingAnimate, BIS_fnc_briefingInit 4
Broken Functions Functions which do not work or have no effect at all. - 23
Camera Functions to manipulate cameras. BIS_fnc_camera_deleted, BIS_fnc_camera_getFocus 16
Campaign Mostly functions used in the APEX Protocol campaign. Also see CampaignLobby and CampaignManager. BIS_fnc_EXP_camp_addTickets, BIS_fnc_isCampaign 19 / 2
Combat Functions used to manipulate AI in combat. BIS_fnc_fire, BIS_fnc_stalk 7
CombatPatrol Functions used in the Arma 3 MP Combat Patrol game mode. BIS_fnc_CPDummy, BIS_fnc_CPInit Arma 3 9
Communication Menu Functions used to add or remove entries from the communication menu. BIS_fnc_addCommMenuItem, BIS_fnc_commsMenuToggleAvailability 7
Configs Functions to work with configs. BIS_fnc_getCfgSubClasses, BIS_fnc_getCfg 22
Contact Functions used in the Arma 3 Contact campaign. Many of them cannot be used ouside of the Contact DLC. BIN_fnc_inDangerZone, BIN_fnc_showSimpleNotification Arma 3 102 / 11
Conversations Functions used with Conversations. BIS_fnc_kbTell, BIS_fnc_kbMenu 14
Curator (Zeus) Curator (Zeus) related functions. For modules see Modules - Curator. BIS_fnc_curatorHint, BIS_fnc_isCurator Arma 3 38 / 1
Database Functions to create and change databases. BIS_fnc_dbClassId, BIS_fnc_dbSymbolClass Arma 3 and Take On Helicopters 22
Diagnostic Debug functions. BIS_fnc_debugConsoleExec, BIS_fnc_fps 77
Eden Editor Eden Editor related functions. BIS_fnc_3DENIntel, BIS_fnc_3DENTutorial Arma 3 29
Effects Functions to manipulate various effects like guns firing. BIS_fnc_effectFired, BIS_fnc_healthEffects Arma 3 15
Environment Functions to change the environment e.g., time, weather BIS_fnc_calculateDateTime, BIS_fnc_interpolateWeather 19
Event Handlers Functions to work with Event Handlers BIS_fnc_addScriptedEventHandler, BIS_fnc_onLoad 13
Feedback Functions used to give the player feedback about his status. BIS_fnc_bloodEffect, BIS_fnc_radialRed 14
GUI GUI related function. BIS_fnc_getIDC, BIS_fnc_ctrlSetScale 88
Interaction Functions to allow player to interact with objects. BIS_fnc_holdKey, BIS_fnc_keyHold 13
Inventory Inventory related functions. BIS_fnc_saveInventory, BIS_fnc_hasItem 36
KeyframeAnimation Functions related to the Arma 3 Key Frame Animation system. BIS_fnc_keyframeAnimation_deltaTime, BIS_fnc_keyframeAnimation_init Arma 3 9 / 9
Live Feed Functions related live feed system. BIS_fnc_liveFeed, BIS_fnc_liveFeedEffects Arma 3 5
Map and Markers Functions to be used with markers or the map. BIS_fnc_drawAO, BIS_fnc_blinkMarker 55
Math Math related functions. See also: Geometry, Interpolation and Vectors. BIS_fnc_pow, BIS_fnc_nearestNum 24 / 3
Mission Parameters Functions for Mission Parameters. BIS_fnc_getParamValue, BIS_fnc_initParams Arma 3 18
Missions Functions to get information about missions or manipulate the mission flow. BIS_fnc_singleMissionConfig, BIS_fnc_countdown 22
Modules Functions used by modules. Make sure to check the subcategories as well. Arma 3: Old Man Systems modules are in Function Group: Old Man. BIS_fnc_singleMissionConfig, BIS_fnc_countdown 121 / 6
Multiplayer Functions designed for multiplayer missions. BIS_fnc_admin, BIS_fnc_listPlayers 17
Object Manipulation Get or set various different properties of units, vehicles and other objects. Also check out the subcategories for very object specific functions. BIS_fnc_attachToRelative, BIS_fnc_neutralizeUnit 69 / 5
Old Man Functions used by the Arma 3 Apex: Old Man scenario. BIS_fnc_OM_credits, BIS_fnc_OM_init Arma 3 40 / 3
OO Function for Object Oriented (OO) scripting. BIS_fnc_addClassOO, BIS_fnc_createObjectOO Arma 3 3
Positions Functions to work with positions. BIS_fnc_position, BIS_fnc_buildingPositions 16
Priority Queue Functions to set up and manipulate a priority queue. BIS_fnc_priorityQueue_GetLowestPriority, BIS_fnc_priorityQueue_Init Arma 3 7
Program Flow Functions used to execute scripts or handle their flow. BIS_fnc_spawn, BIS_fnc_call 9
Radio Radio related functions. BIS_fnc_diagRadio, BIS_fnc_radioSetChannel Arma 3 and Take On Helicopters 4
Respawn Functions used to set up and manipulate the respawn functionality. See Arma 3: Respawn. BIS_fnc_addRespawnInventory, BIS_fnc_respawnSeagull Arma 3 59
Revive Functions used to set up and manipulate the revive functionality. See Arma 3: Revive. BIS_fnc_disableRevive, BIS_fnc_reviveInit Arma 3 23
Rich Curve Functions used to work with rich curves. BIS_fnc_richCurve_getCurveLength, BIS_fnc_richCurve_getKeysAtTime Arma 3 29
Scenes Set up scenes with these funcitons. BIS_fnc_sceneAreaClearance, BIS_fnc_sceneMiscStuff 23
Scripts Scripts on these page usually only have one very specific functionality and usually can not be used for anything else. BIS_fnc_dataTerminalAnimate, BIS_fnc_lockedDoorOpen 26 / 1
Sides Side related functions. BIS_fnc_areFriendly, BIS_fnc_playerSideFaction 20
Sound Functions to play music or set up sounds. BIS_fnc_jukebox, BIS_fnc_music 13
Spectator An overview of functions used by the EG Spectator Mode. BIS_fnc_EGSpectator, BIS_fnc_EGSpectatorCamera Arma 3 11
Strategic Functions for the strategic map and ORBAT feature. BIS_fnc_ORBATOpen, BIS_fnc_strategicMapOpen Arma 3 12
Strings Functions to work with strings. BIS_fnc_filterString, BIS_fnc_splitString Arma 3 16
Supports Functions to set up support requests. BIS_fnc_addSupportLink, BIS_fnc_fireSupport 10
Systems Functions for various systems like Arma 3: Dynamic Groups. BIS_fnc_dynamicGroups, BIS_fnc_missionSelector 21
Tasks Functions to create tasks for player and AI. See Arma 3: Task Framework. BIS_fnc_taskAttack, BIS_fnc_taskSetType 34
Timeline Functions to create a timeline with events. BIS_fnc_timeline_init, BIS_fnc_timeline_isPaused Arma 3 32
Uncategorised Functions which have no defined category. N/A 0
Variables Compare and set variables. BIS_fnc_areEqual, BIS_fnc_setServerVariable 7
Vehicles Functions to work with vehicles. BIS_fnc_absSpeed, BIS_fnc_initVehicle 18
VR Functions used by the Virtual Reality missions from the Arma 3 Bootcamp update. Mostly FSMs. BIS_fnc_VRCourseBallistics1, BIS_fnc_VRCourseHeliWeapons2 Arma 3 55
Warlords Arma 3 MP Warlords functions. BIS_fnc_WLAICore, BIS_fnc_WLSendResponseTeam Arma 3 71
Waypoints Functions to work with waypoints. BIS_fnc_wpRelax, BIS_fnc_wpTimed 23
Weapons Weapon related functions. BIS_fnc_compatibleMagazines, BIS_fnc_weaponAddon 12

Subcategories

This category has the following 59 subcategories, out of 59 total.

F