Main Page   Modules   File List   File Members  

LuaPing.cpp File Reference


Detailed Description

Functions to create visual Ping Helpers.

System: Scar

>


Functions

udword Ping_AddPoint (const char *pingName, const char *templateName, const char *volumeName)
 add the named ping using the template name to the named volume, returns the id of the ping for later use.

udword Ping_AddSobGroup (const char *pingName, const char *templateName, const char *sobGroupName)
 add a ping which covers all the ships in the sobgroup, returns the id of the ping for later use.

void Ping_Remove (udword pingID)
 remove the ping with the given id, the id is returned when you create a ping

void Ping_LabelVisible (udword pingID, bool bVisible)
 set the visibility of the text label for the given ping

void Ping_AddDescription (udword pingID, udword lineNum, const char *description)
 add a description to the given ping, the description can be a localised string


Function Documentation

udword Ping_AddPoint const char *    pingName,
const char *    templateName,
const char *    volumeName
 

add the named ping using the template name to the named volume, returns the id of the ping for later use.

the ping name can be a localised string id the template name is the name of the luaconfig table for the ping in data/ui/pings/pings.lua "objective", "anomaly", "hyperspaceIn" are all valid templates

udword Ping_AddSobGroup const char *    pingName,
const char *    templateName,
const char *    sobGroupName
 

add a ping which covers all the ships in the sobgroup, returns the id of the ping for later use.

the ping name can be a localised string id the template name is the name of the luaconfig table for the ping in data/ui/pings/pings.lua "objective", "anomaly", "hyperspaceIn" are all valid templates


Generated on Fri Oct 31 04:05:39 2003 for Scar by doxygen1.3-rc3