Function; Ping_AddDescription - HWRM/KarosGraveyard GitHub Wiki

Ping_AddDescription(<iPingIndex>, <iLineNum>, <sDescription>)

Description

Adds a description to a ping.

Example

Ping_AddDescription(ping_resource_operation_id, 0, "$40900")

Arguments

<iPingIndex>: the index number of the ping.
<iLineNum>: the line number of the description. Note: the target drones in M01 are an example of a multiple-line ping description.
<sDescription>: the text description of the ping. Can be a raw string or a localization ID.

Scope

Related Pages

Gamerule

Function Reference

SCAR (SCripting at Relic) Reference

Comments

iLineNum does mean "the line number of the description to add" :D
line 0 is the upper line, line 1 the second one, and so on - the target drones in M01 are an example of multiple line ping description

--SunTzu (2005-11-22 16:44:27)

Page Status

Updated Formatting? Initial
Updated for HWRM? Initial

⚠️ **GitHub.com Fallback** ⚠️