Functions by Functionality: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Started adding examples - got bored - will carry on later. Need to fix CSS)
(Added examples to every category to have at least 4 (if category has 4 or less commands, all were made into examples). I picked out the commands that I think would be the most useful or most used)
Line 35: Line 35:
;e.g.
;e.g.
:[[BIS_fnc_arrayPush]]
:[[BIS_fnc_arrayPush]]
:[[BIS_fnc_findExtreme]]
:[[BIS_fnc_returnNestedElement]]
:[[BIS_fnc_returnNestedElement]]
:[[BIS_fnc_randomIndex]]
:[[BIS_fnc_randomIndex]]
:[[BIS_fnc_findExtreme]]
:[[BIS_fnc_sortBy]]
:[[BIS_fnc_sortBy]]
</div>
</div>
Line 80: Line 80:
:[[BIS_fnc_genericSentence]]
:[[BIS_fnc_genericSentence]]
:[[BIS_fnc_genericSentenceInit]]
:[[BIS_fnc_genericSentenceInit]]
:[[BIS_fnc_kbCreateDummy]]
:[[BIS_fnc_kbTopicConfig]]
:[[BIS_fnc_kbTopicConfig]]
</div>
</div>
Line 99: Line 100:
;e.g.
;e.g.
:[[BIS_fnc_addCuratorChallenge]]
:[[BIS_fnc_addCuratorChallenge]]
:[[BIS_fnc_curatorChallengeIlluminate]]
:[[BIS_fnc_curatorChallengeSpawnLightning]]
:[[BIS_fnc_manageCuratorChallenges]]
:[[BIS_fnc_manageCuratorChallenges]]
</div>
</div>
Line 106: Line 109:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:None
</div>
</div>


Line 126: Line 129:
:[[BIS_fnc_functionPath]]
:[[BIS_fnc_functionPath]]
:[[BIS_fnc_halt]]
:[[BIS_fnc_halt]]
:[[BIS_fnc_isDemo]]
:[[BIS_fnc_shutdown]]
</div>
</div>


Line 132: Line 137:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_diagAnim]]
:[[BIS_fnc_diagBulletCam]]
:[[BIS_fnc_diagKnownTargets]]
:[[BIS_fnc_diagRadio]]
</div>
</div>


Line 139: Line 147:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_effectFired]]
:[[BIS_fnc_effectFiredRocket]]
:[[BIS_fnc_effectKilledAirDestruction]]
:[[BIS_fnc_moduleEffectsBubbles]]
</div>
</div>


Line 146: Line 157:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_destroyCity]]
:[[BIS_fnc_moduleSkiptime]]
:[[BIS_fnc_sandstorm]]
:[[BIS_fnc_setFog]]
:[[BIS_fnc_setOvercast]]
</div>
</div>


Line 153: Line 168:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleDate]]
:[[BIS_fnc_moduleGenericRadio]]
:[[BIS_fnc_moduleSaveGame]]
:[[BIS_fnc_moduleVolume]]
</div>
</div>


Line 160: Line 178:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_bloodEffect]]
:[[BIS_fnc_damagePulsing]]
:[[BIS_fnc_fatigueEffect]]
:[[BIS_fnc_indicateBleeding]]
:[[BIS_fnc_healing]]
</div>
</div>


Line 167: Line 189:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_dirTo]]
:[[BIS_fnc_distance2D]]
:[[BIS_fnc_inAngleSector]]
:[[BIS_fnc_isInsideArea]]
:[[BIS_fnc_relativeDirTo]]
:[[BIS_fnc_relPos]]
</div>
</div>


Line 174: Line 201:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleCombatGetIn]]
:[[BIS_fnc_moduleGroupID]]
</div>
</div>


Line 181: Line 209:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_3Dcredits]]
:[[BIS_fnc_credits]]
:[[BIS_fnc_GUIeditor]]
:[[BIS_fnc_typeText]]
</div>
</div>


Line 188: Line 219:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_helicopterCanFly]]
:[[BIS_fnc_helicopterDamage]]
:[[BIS_fnc_helicopterSeat]]
:[[BIS_fnc_helicopterType]]
</div>
</div>


Line 195: Line 229:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:None
</div>
</div>


Line 202: Line 236:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_advHint]]
:[[BIS_fnc_advHintArg]]
:[[BIS_fnc_advHintCall]]
:[[BIS_fnc_advHintCredits]]
</div>
</div>


Line 209: Line 246:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleCreateDiaryRecord]]
:[[BIS_fnc_moduleDiary]]
:[[BIS_fnc_moduleHQ]]
:[[BIS_fnc_moduleTaskCreate]]
</div>
</div>


Line 216: Line 256:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_addWeapon]]
:[[BIS_fnc_baseWeapon]]
:[[BIS_fnc_deleteInventory]]
:[[BIS_fnc_invAdd]]
</div>
</div>


Line 223: Line 266:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleLightning]]
</div>
</div>


Line 230: Line 273:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_liveFeedModuleEffects]]
:[[BIS_fnc_liveFeedModuleInit]]
:[[BIS_fnc_liveFeedModuleSetSource]]
:[[BIS_fnc_liveFeedModuleSetTarget]]
</div>
</div>


Line 237: Line 283:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_drawAO]]
:[[BIS_fnc_mapSize]]
:[[BIS_fnc_markerToTrigger]]
:[[BIS_fnc_markWaypoints]]
:[[BIS_fnc_randomPosTrigger]]
:[[BIS_fnc_worldArea]]
</div>
</div>


Line 244: Line 295:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleMine]]
</div>
</div>


Line 251: Line 302:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_addStackedEventHandler]]
:[[BIS_fnc_buildingPositions]]
:[[BIS_fnc_listPlayers]]
:[[BIS_fnc_PosToGrid]]
:[[BIS_fnc_runLater]]
:[[BIS_fnc_traceBullets]]
</div>
</div>


Line 258: Line 314:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_basicTask]]
:[[BIS_fnc_forceEnd]]
:[[BIS_fnc_missionHandlers]]
:[[BIS_fnc_missionTasks]]
:[[BIS_fnc_singleMissionConfig]]
</div>
</div>


Line 265: Line 325:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleMPTypeDefense]]
:[[BIS_fnc_moduleMPTypeGameMaster]]
:[[BIS_fnc_moduleMPTypeSectorControl]]
:[[BIS_fnc_moduleMPTypeSeize]]
</div>
</div>


Line 272: Line 335:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleFDCPClear]]
:[[BIS_fnc_moduleFDCPIn]]
:[[BIS_fnc_moduleFDCPOut]]
:[[BIS_fnc_moduleFiringDrill]]
</div>
</div>


Line 279: Line 345:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_initModules]]
:[[BIS_fnc_moduleExecute]]
:[[BIS_fnc_moduleModules]]
:[[BIS_fnc_moduleTriggers]]
</div>
</div>


Line 286: Line 355:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleTimeTrial]]
:[[BIS_fnc_moduleTTCPIn]]
:[[BIS_fnc_moduleTTCPOut]]
:[[BIS_fnc_moduleTTCPTrigger]]
</div>
</div>


Line 293: Line 365:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_call]]
:[[BIS_fnc_execVM]]
:[[BIS_fnc_MP]]
:[[BIS_fnc_MPexec]]
</div>
</div>


Line 300: Line 375:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleBleedTickets]]
:[[BIS_fnc_moduleCountdown]]
:[[BIS_fnc_moduleRespawnTickets]]
:[[BIS_fnc_moduleSector]]
</div>
</div>


Line 307: Line 385:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_countdown]]
:[[BIS_fnc_cutDecimals]]
:[[BIS_fnc_greatestNum]]
:[[BIS_fnc_randomNum]]
:[[BIS_fnc_roundNum]]
:[[BIS_fnc_sortNum]]
</div>
</div>


Line 314: Line 397:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleObjective]]
:[[BIS_fnc_moduleObjectiveFind]]
:[[BIS_fnc_moduleObjectiveSector]]
:[[BIS_fnc_moduleObjectiveTarget]]
</div>
</div>


Line 321: Line 407:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleAI]]
:[[BIS_fnc_moduleDoorOpen]]
:[[BIS_fnc_moduleMode]]
:[[BIS_fnc_moduleShowHide]]
</div>
</div>


Line 328: Line 417:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_boundingBoxDimensions]]
:[[BIS_fnc_boundingCircle]]
:[[BIS_fnc_getTurrets]]
:[[BIS_fnc_objectType]]
:[[BIS_fnc_spawnObjects]]
</div>
</div>


Line 335: Line 428:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_addClassOO]]
:[[BIS_fnc_createObjectOO]]
:[[BIS_fnc_validateParametersOO]]
</div>
</div>


Line 342: Line 437:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_getParamValue]]
:[[BIS_fnc_initParams]]
:[[BIS_fnc_paramCountdown]]
:[[BIS_fnc_paramDaytime]]
</div>
</div>


Line 349: Line 447:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_radioSetChannel]]
:[[BIS_fnc_radioSetPlaylist]]
:[[BIS_fnc_radioSetTrack]]
</div>
</div>


Line 356: Line 456:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_addRespawnInventory]]
:[[BIS_fnc_addRespawnPosition]]
:[[BIS_fnc_getRespawnInventories]]
:[[BIS_fnc_respawnSeagull]]
</div>
</div>


Line 363: Line 466:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_sceneCheckWeapons]]
:[[BIS_fnc_sceneGetObjects]]
:[[BIS_fnc_sceneSetBehaviour]]
:[[BIS_fnc_sceneSetObjects]]
</div>
</div>


Line 370: Line 476:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_areFriendly]]
:[[BIS_fnc_enemySides]]
:[[BIS_fnc_friendlySides]]
:[[BIS_fnc_sideName]]
</div>
</div>


Line 377: Line 486:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_animalSiteSpawn]]
</div>
</div>


Line 384: Line 493:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_skirmishTrigger]]
</div>
</div>


Line 391: Line 500:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_ObjectsGrabber]]
:[[BIS_fnc_ObjectsMapper]]
:[[BIS_fnc_prepareAO]]
:[[BIS_fnc_selectCrew]]
:[[BIS_fnc_spawnCrew]]
:[[BIS_fnc_spawnVehicle]]
</div>
</div>


Line 398: Line 512:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_getUnitInsignia]]
:[[BIS_fnc_ORBATAnimate]]
:[[BIS_fnc_ORBATOpen]]
:[[BIS_fnc_ORBATTooltip]]
:[[BIS_fnc_setUnitInsignia]]
</div>
</div>


Line 405: Line 523:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_moduleStrategicMapImage]]
:[[BIS_fnc_moduleStrategicMapInit]]
:[[BIS_fnc_moduleStrategicMapMission]]
:[[BIS_fnc_moduleStrategicMapOpen]]
</div>
</div>


Line 412: Line 533:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_alignTabs]]
:[[BIS_fnc_filterString]]
:[[BIS_fnc_inString]]
:[[BIS_fnc_phoneticalWord]]
:[[BIS_fnc_splitString]]
:[[BIS_fnc_trimString]]
</div>
</div>


Line 419: Line 545:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_addSupportLink]]
:[[BIS_fnc_changeSupportRadioChannel]]
:[[BIS_fnc_limitSupport]]
:[[BIS_fnc_removeSupportLink]]
</div>
</div>


Line 426: Line 555:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_RespawnManager]]
:[[BIS_fnc_respect]]
:[[BIS_fnc_supplydrop]]
:[[BIS_fnc_supplydropService]]
:[[BIS_fnc_transportService]]
</div>
</div>


Line 433: Line 566:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_deleteTask]]
:[[BIS_fnc_setTask]]
:[[BIS_fnc_taskCreate]]
:[[BIS_fnc_taskState]]
</div>
</div>


Line 440: Line 576:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_target]]
</div>
</div>


Line 447: Line 583:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:None
</div>
</div>


Line 454: Line 590:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_areEqual]]
:[[BIS_fnc_getServerVariable]]
:[[BIS_fnc_loadFunctions]]
:[[BIS_fnc_setServerVariable]]
:[[BIS_fnc_swapVars]]
:[[BIS_fnc_variableSpaceAdd]]
</div>
</div>


Line 461: Line 602:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_magnitude]]
:[[BIS_fnc_rotateVector2D]]
:[[BIS_fnc_unitVector]]
:[[BIS_fnc_vectorFromXToY]]
</div>
</div>


Line 468: Line 612:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_absSpeed]]
:[[BIS_fnc_missileLaunchPositionFix]]
:[[BIS_fnc_vehicleRoles]]
</div>
</div>


Line 475: Line 621:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_VRCourseBallistics1]]
:[[BIS_fnc_VRCourseCommandingActions1]]
:[[BIS_fnc_VRCourseCommandingBehaviour1]]
:[[BIS_fnc_VRCourseCommandingMovement1]]
:[[BIS_fnc_VRCourseCommandingVehicles1]]
</div>
</div>


Line 482: Line 632:
'''Description.'''
'''Description.'''
;e.g.
;e.g.
:
:[[BIS_fnc_scriptedWaypointType]]
:[[BIS_fnc_wpFastRope]]
:[[BIS_fnc_wpLand]]
:[[BIS_fnc_wpPatrol]]
:[[BIS_fnc_wpSuppress]]
</div>
</div>



Revision as of 03:34, 24 December 2014


Introduction

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.).

Keep in mind that there can be cases where certain functions may appear in more than one category.

Animals

Description.

e.g.
BIS_fnc_moduleAnimals

CAS

Description.

e.g.
BIS_fnc_moduleCAS

CuratorLite

Description.

e.g.
None

Heliport

Description.

e.g.
None

Mines

Description.

e.g.
BIS_fnc_moduleMine

Sites

Description.

e.g.
BIS_fnc_animalSiteSpawn

Skirmish

Description.

e.g.
BIS_fnc_skirmishTrigger

Training

Description.

e.g.
BIS_fnc_target

Tutorial Functions

Description.

e.g.
None