Portrait

Advanced

Clear Portrait Animation

• Clears an animation on a portrait.

Destroy Portrait

• Destroys the specified portrait.

Destroy All Portraits

• Destroys all portraits.

Force Portrait Transition On/Off

• 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

• Tells a portrait to play an animation.

Turn Portrait Background On/Off

• Turns a portrait's background on or off.

Set Portrait Border Texture

• Sets the border texture for a portrait.

Turn Portrait Border On/Off

• Turns a portrait's border on or off.

Set Portrait Camera

• Sets the portrait camera using string values.

Set Portrait Channel

• 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

• Turns a portrait's fullscreen on or off.

Set Portrait Light

• Sets the light for a portrait.

Set Portrait Model

• Sets the model for a portrait.

Set Portrait Model And Play Animation

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

Set Portrait Mouse Target

• 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

• Mutes or unmutes the portrait.

Turn Portrait Offscreen On/Off

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

Pause/Unpause Portrait

• Pauses or unpauses the animation in the specified portrait.

Set Portrait Position

• Sets a portrait's position on the screen.

Set Portrait Render Type

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

Set Portrait Size

• Sets the size of a portrait.

Set Portrait Team Color

• Set the team color of the specified portrait.

Set Portrait Tint Color

• Set the tint color of the specified portrait.

Set Portrait Transition Model

• Sets a portrait's transistion model.

Turn Portrait Transition On/Off

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

Wait For Portrait To Load

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

Basic

Create Portrait

• Creates a portrait on the screen.

Last Created Portrait

• Returns the last created portrait.

Show/Hide Portrait

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

Portrait Is Visible

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

Useful Portraits

Cinematic Portrait

• Returns the cinematic portrait at the specified position.

Fullscreen Portrait

• Returns the fullscreen portrait.

Game Portrait

• Returns the game portrait.

Planet Panel Portrait

• Returns the planet panel portrait.