# Cinematic Mode

Grammar — Turn cinematic mode onOff for players over duration seconds
FlagsAction

Turns on/off cinematic mode for a player(s). Cinematic mode hides the normal gameplay UI. When cinematic mode is turned on, the state of the gameplay UI is cached, and when cinematic mode is turned off, the state of the gameplay UI is restored from that cache. Therefore, changing visibility settings of gameplay UI elements while cinematic mode is turned on will have no effect. This mode will also mute certain sound channels.

# Arguments

  • bool [ preset::OnOffOption ] — On/Off
  • playergroup — Players
  • fixed — Duration

Returns — void

void libNtve_gf_CinematicMode(
	bool lp_onOff,
	playergroup lp_players,
	fixed lp_duration,
);

Category: Cinematics / Cinematic Mode

# Examples

# campaigns/liberty.sc2campaign

MapScript.galaxy

// L1332
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L1459
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L996
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L1157
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L1338
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L2818
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate)
// L2945
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.0)
// L1613
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate)
// L1836
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L1532
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate)
// L1738
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L2004
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate)
// L2211
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.0)
// L2301
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationDefault)
// L2497
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.0)
// L945
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L1107
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L1274
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L2660
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate)
// L2809
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L1368
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L1455
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.0)
// L1009
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L1177
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L1347
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L2805
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate)
// L2965
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.0)
// L1311
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L1396
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.0)
// L8644
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate)
// L8906
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationImmediate)
// L889
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L892
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.5)
// L5683
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L6244
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L758
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L763
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.5)
// L4730
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5343
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L938
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L942
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.5)
// L5951
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L6527
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L3522
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L3904
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L4446
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L4675
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L971
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L978
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.5)
// L5599
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5822
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L896
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L901
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.5)
// L5101
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5444
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5594
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L5656
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L749
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L759
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.5)
// L5080
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5481
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5705
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L5816
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5937
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L6295
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L6494
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L6557
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L6836
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L7025
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L11100
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L11256
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L11442
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L11595
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L11761
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L11976
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L12104
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L12174
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L12458
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L12685
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L4631
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L4897
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5058
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationDefault)
// L5161
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L5304
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5444
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L5508
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5700
libNtve_gf_CinematicMode(false, PlayerGroupAll(), lv_fadeDuration)
// L5760
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L749
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L758
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.5)
// L4650
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L4839
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L840
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L852
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 1.5)
// L4601
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L5077
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L11841
libNtve_gf_CinematicMode(true, PlayerGroupAll(), c_transitionDurationImmediate)
// L11871
libNtve_gf_CinematicMode(false, PlayerGroupAll(), c_transitionDurationImmediate)
// L11890
libNtve_gf_CinematicMode(true, PlayerGroupAll(), 0.0)
// L11897
libNtve_gf_CinematicMode(false, PlayerGroupAll(), 0.0)