Difference between revisions of "DisplayFloatyMessage"
From Dragon Age Toolset Wiki
(Generated by Sunjammer's Dragon Age Script Paser) |
m (Updating link) |
||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | |||
{{dafunction | {{dafunction | ||
|name=DisplayFloatyMessage | |name=DisplayFloatyMessage | ||
Line 6: | Line 5: | ||
|param1name=oCreature | |param1name=oCreature | ||
|param1desc=The creature to display the floaty over | |param1desc=The creature to display the floaty over | ||
+ | |param1default= | ||
|param2type=string | |param2type=string | ||
|param2name=sMessage | |param2name=sMessage | ||
|param2desc=The text of the message | |param2desc=The text of the message | ||
+ | |param2default= | ||
|param3type=int | |param3type=int | ||
|param3name=nStyle | |param3name=nStyle | ||
− | |param3desc=The visual style of the floaty | + | |param3desc=The visual style of the floaty. See [[FLOATY_*]]. |
+ | |param3default=FLOATY_MESSAGE | ||
|param4type=int | |param4type=int | ||
|param4name=nColour | |param4name=nColour | ||
|param4desc=The text colour, in hex (eg. 0xff0000 is red) | |param4desc=The text colour, in hex (eg. 0xff0000 is red) | ||
+ | |param4default=16777215 | ||
|param5type=float | |param5type=float | ||
|param5name=nDuration | |param5name=nDuration | ||
|param5desc=If specified, the floaty will be displayed for the indicated seconds. Note: If the time is zero, the floaty message is still displayed momentarily, as there is a fade in and fade out animation. Also If the floaty message sports a style of "FLOATY_HIT" or "FLOATY_CRITICAL_HIT" the duration is completely ignored, this is controlled through ActionScript! | |param5desc=If specified, the floaty will be displayed for the indicated seconds. Note: If the time is zero, the floaty message is still displayed momentarily, as there is a fade in and fade out animation. Also If the floaty message sports a style of "FLOATY_HIT" or "FLOATY_CRITICAL_HIT" the duration is completely ignored, this is controlled through ActionScript! | ||
+ | |param5default=0.5 | ||
|returntype=void | |returntype=void | ||
|returndesc= | |returndesc= | ||
Line 26: | Line 30: | ||
== Description == | == Description == | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
− | Displays an animated message or number floating over a creature | + | Displays an animated message or number floating over a creature indicating damage taken, critical hits, etc. |
− | indicating damage taken, critical hits, etc. | + | |
<!-- == Remarks == --> | <!-- == Remarks == --> |
Latest revision as of 20:10, 3 August 2011
Displays a floating message over a creature
void DisplayFloatyMessage(
object oCreature,
string sMessage,
int nStyle = FLOATY_MESSAGE,
int nColour = 16777215,
float nDuration = 0.5
);
object oCreature,
string sMessage,
int nStyle = FLOATY_MESSAGE,
int nColour = 16777215,
float nDuration = 0.5
);
- Parameters:
- oCreature
- The creature to display the floaty over
- sMessage
- The text of the message
- nStyle
- The visual style of the floaty. See FLOATY_*.
- nColour
- The text colour, in hex (eg. 0xff0000 is red)
- nDuration
- If specified, the floaty will be displayed for the indicated seconds. Note: If the time is zero, the floaty message is still displayed momentarily, as there is a fade in and fade out animation. Also If the floaty message sports a style of "FLOATY_HIT" or "FLOATY_CRITICAL_HIT" the duration is completely ignored, this is controlled through ActionScript!
- Returns:
- Nothing.
- Source:
- script.ldf
Description
Displays an animated message or number floating over a creature indicating damage taken, critical hits, etc.