map_so()

Purpose

Displays the specified string at the specified location

Syntax

void pascal map_so(int mapnr,int x,int y,
char DP4P data, int colour)

Parameters

int mapnr

The map to show the string

 

int x

Offset in 16ths of a standard character from the left side of the map

 

int y

Offset in 32nds of a standard character from the top of the map

 

char DP4P data

Pointer to the string which must be zero-terminated

 

int colour

Colour information, interpreted as follows:

 

Value

Meaning

 

0

The string inherits the map's colour scheme

 

-C_OBSCURE

The string inherits the map's colour scheme and is displayed in the disabled text colour

 

-C_OPTION

The string inherits the map's colour scheme and is displayed in the selected text colour

 

Other negative values

The string is diaplayed using the abs(colour) colour scheme on the database from which the map comes. Normally you would specify one of:

-C_REMARK, -C_WARNING or -C_ERROR

 

Positive values

The string is displayed using the appropriate indexes from the colour portion of the master palette, as for field_colour()

Description

The function map_so() displays the specified string in the specified map, at the specified offsets from the map's top left corner and in the specified colour scheme.

The displayed data becomes part of the map and is displayed until the map is cleared and refresh() is called.

Because of internal buffering performed by TRMW to improve performance the string will survive the sequence map_clear_from(mapnr) map_draw(mapnr,RETAIN).