setCharacterDrawMode

setCharacterDrawMode

Syntax:

setCharacterDrawMode (thisCharacter, mode);

Purpose:

Changes the way in which thisCharacter is displayed. Possible values for mode are:

NORMAL The character is drawn at full brightness with full visibility. This is equivalent to calling: setCharacterColourise (char, 0, 0, 0, 0); and setCharacterTransparency (char, 0);

TRANSPARENT1 The character is drawn at full brightness with 75% visibility. This is equivalent to calling: setCharacterColourise (char, 0, 0, 0, 0); and setCharacterTransparency (char, 64);

TRANSPARENT2 The character is drawn at full brightness with 50% visibility. This is equivalent to calling: setCharacterColourise (char, 0, 0, 0, 0); and setCharacterTransparency (char, 128);

TRANSPARENT Identical to TRANSPARENT2.

TRANSPARENT3 The character is drawn at full brightness with 25% visibility. This is equivalent to calling: setCharacterColourise (char, 0, 0, 0, 0); and setCharacterTransparency (char, 192);

INVISIBLE The character is not shown (note that the mouse will still react to it). This is equivalent to calling: setCharacterColourise (char, 0, 0, 0, 0); and setCharacterTransparency (char, 254);

SHADOW1 The character is drawn as a silhouette with 75% visibility. This is equivalent to calling: setCharacterColourise (char, 255, 0, 0, 0); and setCharacterTransparency (char, 64);

SHADOW2 The character is drawn at as a silhouette with 50% visibility. This is equivalent to calling: setCharacterColourise (char, 255, 0, 0, 0); and setCharacterTransparency (char, 128);

SHADOW Identical to SHADOW2.

SHADOW3 The character is drawn at as a silhouette with 25% visibility. This is equivalent to calling: setCharacterColourise (char, 255, 0, 0, 0); and setCharacterTransparency (char, 192);

DARK1 The character is drawn at 75% brightness with full visibility. This is equivalent to calling: setCharacterColourise (char, 64, 0, 0, 0); and setCharacterTransparency (char, 0);

DARK2 The character is drawn at 50% brightness with full visibility. This is equivalent to calling: setCharacterColourise (char, 128, 0, 0, 0); and setCharacterTransparency (char, 0);

DARK Identical to DARK2.

DARK3 The character is drawn at 25% brightness with full visibility. This is equivalent to calling: setCharacterColourise (char, 192, 0, 0, 0); and setCharacterTransparency (char, 0);

DARK4 The character is drawn as a silhouette with full visibility. This is equivalent to calling: setCharacterColourise (char, 255, 0, 0, 0); and setCharacterTransparency (char, 0);

BLACK Identical to DARK4.

FOGGY1 The character is drawn at 75% of its original colour, 25% medium grey. This is equivalent to calling: setCharacterColourise (char, 64, 128, 128, 128); and setCharacterTransparency (char, 0);

FOGGY2 The character is drawn at 50% of its original colour, 50% medium grey. This is equivalent to calling: setCharacterColourise (char, 128, 128, 128, 128); and setCharacterTransparency (char, 0);

FOGGY Identical to FOGGY2.

FOGGY3 The character is drawn at 25% of its original colour, 75% medium grey. This is equivalent to calling: setCharacterColourise (char, 192, 128, 128, 128); and setCharacterTransparency (char, 0);

FOGGY4 The character is drawn as a solid block of medium grey. This is equivalent to calling: setCharacterColourise (char, 255, 128, 128, 128); and setCharacterTransparency (char, 0);

GREY Identical to FOGGY4.

GRAY Identical to FOGGY4.

GLOW1 The character is drawn at 75% of its original colour, 25% bright white. This is equivalent to calling: setCharacterColourise (char, 64, 255, 255, 255); and setCharacterTransparency (char, 0);

GLOW2 The character is drawn at 50% of its original colour, 50% bright white. This is equivalent to calling: setCharacterColourise (char, 128, 255, 255, 255); and setCharacterTransparency (char, 0);

GLOW Identical to GLOW2.

GLOW3 The character is drawn at 25% of its original colour, 75% bright white. This is equivalent to calling: setCharacterColourise (char, 192, 255, 255, 255); and setCharacterTransparency (char, 0);

GLOW4 The character is drawn as a solid block of bright white. This is equivalent to calling: setCharacterColourise (char, 255, 255, 255, 255); and setCharacterTransparency (char, 0);

WHITE Identical to GLOW4.

If thisCharacter is an object type which is not currently represented on the screen as a character, the code has no effect. If thisCharacter has been hidden using the hideCharacter command, the character's draw mode is changed but the character is not made visible.

Return value:

TRUE if thisCharacter is an object type which is currently represented on the screen as a character, otherwise FALSE (i.e. TRUE if the call to the function was a success).