GUI
87 functions. Also as Markdown for agents.
- 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.