ACE3/docs/wiki/framework/slideshow-framework.md
jonpas 65df821e2b Add wiki ACEX sections and merge Mission Makers and Framework sections (#4307)
* Update documentation guidelines

* Add version info part 1

* Add version info part 2

* Add removed in version to frontmatter and tag testmissions as removed

* Add version info part 3

* Seaparate ACE3 and ACEX Features/Framework menus, Add ACEX Headless documentation

* Add ACEX support to extract_dependencies.py

* Merge useful-functions into frameworks

* Move class-names to main menu

* Prettify class-names table titles

* Fix table of contents on documentation guidelines and tips

* Merge mission-tools into frameworks

* Merge modules into frameworks

* Rename to Frameworks (plural)

* Fix capitalization in class-names

* Improve wiki menu positioning

* Add 'mod' to documentation guidelines

* Update frameworks sections description for new content

* Update wiki menu descriptions

* Fix class-names 4 digit versions

* More places for descriptions

* Include documentation in PRs if applicable note

* Add short ACE3 and ACEX description page, outlining the difference
2016-09-08 21:19:07 +02:00

2.2 KiB

layout title description group order parent mod version
wiki Slideshow Framework Explains how to set-up slideshows. framework 5 wiki ace
major minor patch
3 2 0

1. Overview

Slideshow is a very powerful tool for mission makers and platoon leaders giving them the power to project images on some objects.

Slideshow is setup through a module or function.

Important notes:

  • Only objects with hiddenSelection 0 can be used as "screens".
  • If you set a duration the remotes will be disabled (if the remotes are disabled ace_interaction is not needed).
  • You can have multiple sets of images on different screens by using multiple modules/function calls.
  • It is advisable images resolution sizes are powers of 2 (eg. 512x512) to avoid graphical glitches in them.
Note:

Mission MUST be in a PBO format (not bare folder) when used on a dedicated server with slideshow images inside a mission due to an issue to prevent errors.

2. Scripting

2.1 Create Slideshow

ace_slideshow_fnc_createSlideshow

Arguments Type Optional (default value)
0 Screen Objects Array Required
1 Controller Objects Array Required (screen objects are used if empty [], none are available with automatic transitions)
2 Image Paths Array Required (paths must use backslash \)
3 Action Names Array Required
4 Slide Duration Number Optional (default: 0, 0 disables automatic transitions)
R None None Return value

2.1.1 Example

[[object1, object2], [controller1], ["images\image1.paa", "images\image2.paa"], ["Action1", "Action2"], 5] call ace_slideshow_fnc_createSlideshow;

Arguments Explanation
0 [object1, object2] Objects on which images will be projected on
1 [controller1] Objects with which slideshow can be controlled
2 ["images\image1.paa", "images\image2.paa"] Paths to images projected on screen objects
3 ["Action1", "Action2"] Action names for interaction menu if automatic transitions are not enabled
4 5 5s slide duration before change to next image