Triggers/Category Portrait

From SC2Mapster Wiki
Jump to: navigation, search

Advanced[edit | edit source]

Clear Portrait Animation[edit | edit source]

  • Action. Clears an animation on a portrait.

Destroy Portrait[edit | edit source]

  • Action. Destroys the specified portrait.

Destroy All Portraits[edit | edit source]

  • Action. Destroys all portraits.

Force Portrait Transition On/Off[edit | edit source]

  • 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.

Play Portrait Animation[edit | edit source]

  • Action. Tells a portrait to play an animation.

Turn Portrait Background On/Off[edit | edit source]

  • Action. Turns a portrait's background on or off.

Set Portrait Border Texture[edit | edit source]

  • Action. Sets the border texture for a portrait.

Turn Portrait Border On/Off[edit | edit source]

  • Action. Turns a portrait's border on or off.

Set Portrait Camera[edit | edit source]

  • Action. Sets the portrait camera using string values.

Set Portrait Channel[edit | edit source]

  • Action. Sets the render-to-texture channel for the specified portrait, which determines where the portrait textures can appear in the game.

Turn Portrait Fullscreen On/Off[edit | edit source]

  • Action. Turns a portrait's fullscreen on or off.

Set Portrait Light[edit | edit source]

  • Action. Sets the light for a portrait.

Set Portrait Model[edit | edit source]

  • Action. Sets the model for a portrait.

Set Portrait Model And Play Animation[edit | edit source]

  • Action. Sets the model for a portrait and plays an animation on it.

Set Portrait Mouse Target[edit | edit source]

  • Action. Sets whether the portrait is a valid mouse target or not. If the portrait is not a valid mouse target, mouse clicks will go through the portrait.

Mute/Unmute Portrait[edit | edit source]

  • Action. Mutes or unmutes the portrait.

Turn Portrait Offscreen On/Off[edit | edit source]

  • Action. Sets whether or not the specified portrait is rendered offscreen.

Pause/Unpause Portrait[edit | edit source]

  • Action. Pauses or unpauses the animation in the specified portrait.

Set Portrait Position[edit | edit source]

  • Action. Sets a portrait's position on the screen.

Set Portrait Render Type[edit | edit source]

  • Action. Sets the render type of the portrait to determine during which pass of the UI it should be rendered.

Set Portrait Size[edit | edit source]

  • Action. Sets the size of a portrait.

Set Portrait Team Color[edit | edit source]

  • Action. Set the team color of the specified portrait.

Set Portrait Tint Color[edit | edit source]

  • Action. Set the tint color of the specified portrait.

Set Portrait Transition Model[edit | edit source]

  • Action. Sets a portrait's transistion model.

Turn Portrait Transition On/Off[edit | edit source]

  • Action. Turns a portrait's transition to on or off.

Wait For Portrait To Load[edit | edit source]

  • Action. Waits until the specified portrait is finished loading. This may be necessary before some operations may be applied to the portrait.

Basic[edit | edit source]

Create Portrait[edit | edit source]

  • Action. Creates a portrait on the screen.

Last Created Portrait[edit | edit source]

  • Function. Returns the last created portrait.

Show/Hide Portrait[edit | edit source]

  • Action. Shows or hides the specified portrait for the specified player group.

Portrait Is Visible[edit | edit source]

  • Function. Returns true if the specified portrait is visible for the specified player.

Useful Portraits[edit | edit source]

Cinematic Portrait[edit | edit source]

  • Function. Returns the cinematic portrait at the specified position.

Fullscreen Portrait[edit | edit source]

  • Function. Returns the fullscreen portrait.

Game Portrait[edit | edit source]

  • Function. Returns the game portrait.

Planet Panel Portrait[edit | edit source]

  • Function. Returns the planet panel portrait.