# Force Portrait Transition On/Off
Grammar — Force Portrait transition onOff with instant set to instant
Flags —Native
|Action
Forces the transition model of the portrait to on or off. Forcing it on will cause it to render until it is no longer forced on. If the instant parameter is set to false, the transition will play it’s birth (on) or death (off) animation.
# Arguments
int
[ portrait ] — Portraitbool
[ preset::OnOffOption ] — On/Offbool
— Instant
Returns — void
native void PortraitForceTransition(
int p,
bool isVisible,
bool isInstant,
);
# Related
Category: Portrait / Advanced
- [F] —
void
— Destroy All Portraits — ( PortraitDestroyAll ) - [F] —
void
— Destroy Portrait — ( PortraitDestroy ) - [F] —
void
— Play Portrait Animation — ( libNtve_gf_PortraitSetAnim ) - [F] —
void
— Set Portrait Camera — ( PortraitSetCamera ) - [F] —
void
— Set Portrait Border Texture — ( PortraitSetBorderTexture ) - [F] —
void
— Set Portrait Light — ( PortraitSetLight ) - [F] —
void
— Set Portrait Model — ( PortraitSetModel ) - [F] —
void
— Set Portrait Model And Play Animation — ( PortraitSetModelAnim ) - [F] —
void
— Set Portrait Position — ( PortraitSetPosition ) - [F] —
void
— Set Portrait Size — ( PortraitSetSize ) - [F] —
void
— Set Portrait Transition Model — ( PortraitSetTransitionModel ) - [F] —
void
— Set Portrait Mouse Target — ( PortraitSetMouseTarget ) - [F] —
void
— Set Portrait Channel — ( PortraitSetChannel ) - [F] —
void
— Set Portrait Render Type — ( PortraitSetRenderType ) - [F] —
void
— Mute/Unmute Portrait — ( PortraitSetMuted ) - [F] —
void
— Pause/Unpause Portrait — ( PortraitSetPaused ) - [F] —
void
— Set Portrait Tint Color — ( PortraitSetTintColor ) - [F] —
void
— Set Portrait Team Color — ( PortraitSetTeamColor ) - [F] —
void
— Set Portrait Actor — ( PortraitSetActor ) - [F] —
void
— Turn Portrait Border On/Off — ( PortraitSetBorderVisible ) - [F] —
void
— Turn Portrait Background On/Off — ( PortraitSetBackgroundVisible ) - [F] —
void
— Turn Portrait Fullscreen On/Off — ( PortraitSetFullscreen ) - [F] —
void
— Turn Portrait Offscreen On/Off — ( PortraitSetOffscreen ) - [F] —
void
— Turn Portrait Transition On/Off — ( PortraitUseTransition ) - [F] —
void
— Force Portrait Transition On/Off — ( PortraitForceTransition ) - [F] —
void
— Clear Portrait Animation — ( libNtve_gf_ClearPortraitAnimation ) - [F] —
void
— Wait For Portrait To Load — ( PortraitWaitForLoad )
# Examples
# campaigns/liberty.sc2campaign
// L10343
PortraitForceTransition(PortraitGetPlanetPanel(), true, true)
// L10346
PortraitForceTransition(PortraitGetPlanetPanel(), false, false)
// L25283
PortraitForceTransition(PortraitGetPlanetPanel(), true, true)
// L10343
PortraitForceTransition(PortraitGetPlanetPanel(), true, true)
// L10346
PortraitForceTransition(PortraitGetPlanetPanel(), false, false)
// L25283
PortraitForceTransition(PortraitGetPlanetPanel(), true, true)
// L14878
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), true, false)
// L14880
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), false, false)
// L14882
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), true, false)
// L14884
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), false, false)
// L14886
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), true, false)
// L14888
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), false, false)
// L14890
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), true, false)
// L14878
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), true, false)
// L14880
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), false, false)
// L14882
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), true, false)
// L14884
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), false, false)
// L14886
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), true, false)
// L14888
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), false, false)
// L14890
PortraitForceTransition(libNtve_gf_CinematicPortrait(libNtve_ge_CinematicPortraitPosition_CenterLeft), true, false)