Skip to content

Function; HW2_SubTitleEvent

Cloaked edited this page Jun 10, 2020 · 1 revision

**HW2_SubTitleEvent(<iActor>, <sText>, <fTime>)

Description**

This function must be called from within an event table. It displays at the left top of the screen an actor's image along with the specified text or pre-defined string. Use SubtitleAdd to call a similar function from a normal chunk (outside a table event).
Note: this function is defined in "data\scripts\scar\scar_util.lua".

Example

HW2_SubTitleEvent(Actor_FleetCommand, "I am fleet Command", 5)
HW2_SubTitleEvent(Actor_FleetIntel, "$40530", 5)

Arguments

<iActor>: the index number of the actor; it corresponds to the iThemeNumber used in addTheme.
Note: you can use the following variables in place of the actor's index number:

Actor_LocationCard
Actor_Talorn
Actor_AllShips3
Actor_AllShips2
Actor_AllShips
Actor_Bentusi
Actor_Chimera
Actor_Keeper
Actor_Makaan
Actor_FleetCommand
Actor_FleetIntel

<sText>: the text you want to be displayed; it can be a quoted string or the index of a localised string.
<fTime>: the length of time (in seconds) before the text disappears.

Scope

Related Pages

addTheme

Function Reference

SCAR (SCripting at Relic) Reference

Comments

Page Status

Updated Formatting? Initial
Updated for HWRM? Initial

Clone this wiki locally