Briefing
62 scripting commands. Also as Markdown for agents.
- allDiaryRecordsReturns array with all Diary Records for the given subject available to the given person. See Diary for the explanation on the available subjects and…
- allDiarySubjectsReturns array with all Diary subjects available to the given person. See Diary for the explanation on the available subjects and their structure.
- briefingNameReturns the name of the current briefing/scenario name.
- cancelSimpleTaskDestinationCancels a simple task destination.
- createDiaryLinkCreates a link to the given diary entry.
- createDiaryRecordCreates a Diary entry. Supported tags and their parameters:
- createDiarySubjectCreates a new subject in the Diary.
- createSimpleTaskCreates a new Task and adds it to the Diary.
- createTaskCreate a new AI task (subtask of parentTask). Type is name of registered task type.
- currentTaskReturn current task of given person.
- currentTasksReturns array with all uncompleted tasks for the given agent. getVariable could be used on Task to get the following special local variables from the…
- debriefingTextReturns debriefing text of provided end.
- diaryRecordNullA non-existent Diary Record. To compare non-existent objects use isNull or isEqualTo:
- diarySubjectExistsChecks whether given subject is present in the Diary of given player.
- disableDebriefingStatsDisable debriefing score table.
- enableDebriefingStatsEnable debriefing score table.
- getDebriefingTextA getter for setDebriefingText.
- objStatusSets the status of an objective that was defined in briefing.html.
- onBriefingGroupSelect a sound declared in the Description.ext of the mission to be played the first time the Group tab is selected in the briefing.
- onBriefingNotesSelect a sound declared in the Description.ext of the mission to be played the first time the Notes tab is selected in the briefing.
- onBriefingPlanSelect a sound declared in the Description.ext of the mission to be played the first time the Plan tab is selected in the briefing.
- onBriefingTeamSwitchSelect a sound defined in the CfgSounds of the mission to be played the first time the TeamSwitch tab is selected in the briefing.
- priorityReturn the priority of the task.
- processDiaryLinkOpens the Diary screen on the subject/record specified by link. To get a valid link format, use createDiaryLink.
- registeredTasksReturns array with all registered task types for the given agent. The values are the names set in `CfgTasks` classes `name` property and are the same…
- registerTaskRegisters a new task type. Parameters are defined in the given config class (subclass of `CfgTasks`)
- removeDiaryRecordRemove a log record.
- removeDiarySubjectRemoves a page and all its subjects from the Diary.
- removeSimpleTaskRemove a simple task from the list of simple tasks.
- selectDiarySubjectSelects a subject page in the diary. The subject page is selected but the command does not open the map by default, which could be opened with…
- sendTaskCreate a new AI task (subtask of parentTask). Type is name of registered task type.
- sendTaskResultSend a result of the task to the task sender.
- setCurrentTaskSet the task as a current task of the person.
- setDebriefingTextSets debriefing title, text, subtitle, picture and background for a mission ending.
- setDiaryRecordTextSet text of a log record.
- setDiarySubjectPictureSets a picture to be displayed on the right of the Diary subject. The picture can also be set during custom Diary subject creation, but this command…
- setSimpleTaskAlwaysVisibleSets task's visibility.
- setSimpleTaskCustomDataSet custom data for the task. Tooltip will be drawn in task list on the right side. Description will be drawn in task description panel on the bottom.
- setSimpleTaskDescriptionAttach descriptions to the simple task.
- setSimpleTaskDestinationAttach a destination to the simple task. Overrides setSimpleTaskTarget
- setSimpleTaskTargetAttach a target to the simple task. Overrides setSimpleTaskDestination.
- setSimpleTaskTypeAttach type to the simple task. See Default Task Types.
- setTaskMarkerOffsetSets the task marker position in model space.
- setTaskResultSet a result of the task.
- setTaskStateSet the state of a given task.
- simpleTasksReturn all simple tasks assigned to given unit.
- taskAlwaysVisibleReturns true if the task is flagged to be always visible or false if not.
- taskChildrenReturn the child tasks of the specified task.
- taskCompletedReturn if task is completed. (state Succeeded, Failed or Canceled)
- taskCustomDataReturns custom data attached to the local task or an empty array if there are no custom data attached.
- taskDescriptionReturns the sub-parts of the task description.
- taskDestinationReturns the position of the task (as specified by destination parameter in config).
- taskHintShows info about new, changed or failed task. The text can contain several lines. `\n` is used to set a line return.
- taskMarkerOffsetReturns model space position for the task marker
- taskNameReturns the name of the given task.
- taskNullA non-existing Task. To compare non-existent tasks use isNull or isEqualTo:
- taskParentReturns the parent task of the specified task.
- taskResultSend a result of the task to the task sender.
- taskStateReturns the current state of a task.
- taskTypeReturns the type of the given task. A new task returns "Default" for the type.
- typeReturns a string of a Location's class name or Task's name (same as taskName).
- unregisterTaskUnregisters a task type from given agent. The task type is the name given in `CfgTasks` classes in `name` property. Also available from…