Animated Briefing – Arma 3
Jump to navigation
Jump to search
Argiolasric (talk | contribs) (Created page with "== Overview == The ''Animated Briefing'' framework allows you to create a briefing using the in-game map which features timeline-based, animated events such as moving markers,...") |
Argiolasric (talk | contribs) No edit summary |
||
| Line 41: | Line 41: | ||
| 2D ARRAY: see BIS_fnc_eventTimeline | | 2D ARRAY: see BIS_fnc_eventTimeline | ||
|- | |- | ||
| | | pointer | ||
| | | NUMBER: see BIS_fnc_eventTimeline | ||
|- | |||
| music | |||
| (OPTIONAL) - STRING: music to be played at the start of the briefings. Timeline events will be synced to music | |||
|- | |||
| hideMarkers | |||
| (OPTIONAL) - ARRAY: if passed, markers are hidden before starting the briefing and at the end of the briefing | |||
|- | |||
| showMarkers | |||
| (OPTIONAL) - ARRAY: array of markers which will be shown after the briefing has ended | |||
|- | |||
| endPosition | |||
| (OPTIONAL) - STRING: marker used for determining position and size of camera at the end of the briefing | |||
|- | |||
| canCloseMap | |||
| (OPTIONAL) - BOOL: value that determines whether or not the player will be able to close the map after the briefing is over | |||
|- | |||
| endUserCode | |||
| (OPTIONAL) - CODE: code to be executed at the end of the briefing | |||
|} | |||
=== BIS_fnc_eventTimeline === | |||
* Essential system of the Animated Briefings, but the function can be used for different purposes | |||
* It executes the code fragments at given time (keyframes) | |||
* It can play the events from start or from a defined position (index) | |||
* It can be interrupted from outside | |||
* user defined code can be executed onInterrupt or onFinished | |||
==== Parameters ==== | |||
{| class="wikitable" | |||
|- | |||
! Parameter | |||
! Description | |||
|- | |||
| timeline | |||
| 2D ARRAY: array with keyframes and code to be activated at a certain time | |||
|- | |||
| pointer | |||
| NUMBER: where to start playing (index) | |||
|- | |||
| music | |||
| (OPTIONAL) - STRING: music to be played which will provide the sync time for the timeline | |||
|- | |||
| codeInterrupt | |||
| (OPTIONAL) - CODE: code to be executed if the timeline is interrupted (missionNamespace setVariable ["BIS_fnc_eventTimeline_play", FALSE]) | |||
|- | |||
| codeStop | |||
| (OPTIONAL) - CODE or ARRAY: code or array of codes to be executed once the timeline is finshed. The codes are CALLed one after the other. | |||
|} | |} | ||
Revision as of 14:54, 28 November 2017
Overview
The Animated Briefing framework allows you to create a briefing using the in-game map which features timeline-based, animated events such as moving markers, blinking markers, zooming, and other marker-related features.
Features
- Easy to setup
- Timeline based
- Can be easily synced to music or dialogs
- Skippable
Framework
Reasons
Since Tac-Ops missions are focused on proper military approaches, the animated briefing should support this general idea. It should simulate a real briefing before an operation. The map is almost empty on the start and markers and drawings are placed on the map step by step supported by dialogs describing the situation.
Functionality
The standard map is used as the platform. Standard markers are placed on the map using some kind of animations. Showing, hiding, canceling, moving and stretching markers is done by set of functions which are part of the briefing's framework. The briefing can be easily synced to dialogs, such as a leader explaining a plan, or to music.
Systems
BIS_fnc_TO_AnimatedBriefing
- Enhanced version of the BIS_fnc_eventTimeline function
- Does the work with the event timeline simpler and get the start of the briefings consistent
- It does the initial setup
- speaker setup
- black-out / black-in
- opens map
- starts the event timeline by calling BIS_fnc_eventTimeline function
- holdKey setup (for skipping the briefing)
Parameters
| Parameter | Description |
|---|---|
| timeline | 2D ARRAY: see BIS_fnc_eventTimeline |
| pointer | NUMBER: see BIS_fnc_eventTimeline |
| music | (OPTIONAL) - STRING: music to be played at the start of the briefings. Timeline events will be synced to music |
| hideMarkers | (OPTIONAL) - ARRAY: if passed, markers are hidden before starting the briefing and at the end of the briefing |
| showMarkers | (OPTIONAL) - ARRAY: array of markers which will be shown after the briefing has ended |
| endPosition | (OPTIONAL) - STRING: marker used for determining position and size of camera at the end of the briefing |
| canCloseMap | (OPTIONAL) - BOOL: value that determines whether or not the player will be able to close the map after the briefing is over |
| endUserCode | (OPTIONAL) - CODE: code to be executed at the end of the briefing |
BIS_fnc_eventTimeline
- Essential system of the Animated Briefings, but the function can be used for different purposes
- It executes the code fragments at given time (keyframes)
- It can play the events from start or from a defined position (index)
- It can be interrupted from outside
- user defined code can be executed onInterrupt or onFinished
Parameters
| Parameter | Description |
|---|---|
| timeline | 2D ARRAY: array with keyframes and code to be activated at a certain time |
| pointer | NUMBER: where to start playing (index) |
| music | (OPTIONAL) - STRING: music to be played which will provide the sync time for the timeline |
| codeInterrupt | (OPTIONAL) - CODE: code to be executed if the timeline is interrupted (missionNamespace setVariable ["BIS_fnc_eventTimeline_play", FALSE]) |
| codeStop | (OPTIONAL) - CODE or ARRAY: code or array of codes to be executed once the timeline is finshed. The codes are CALLed one after the other. |