Method PostString

Namespace

Anvil.API

Assembly

NWN.Anvil.dll

PostString(string, int, int, ScreenAnchor, float, Color?, Color?, int, string)

Displays a message on the player's screen.
The message is always displayed on top of whatever is on the screen, including UI elements.

public void PostString(string message, int xPos, int yPos, ScreenAnchor anchor, float life, Color? start = null, Color? end = null, int id = 0, string font = "")

Parameters

message string

The message to print.

xPos int

The x coordinate relative to anchor.

yPos int

The y coordinate relative to anchor.

anchor ScreenAnchor

The screen anchor/origin point.

life float

Duration to show ControlledCreature string in seconds.

start Color?

The starting color of ControlledCreature text (default: white).

end Color?

The color of the text to fade to as it nears the end of the lifetime (default: white).

id int

An optional numeric ID for ControlledCreature string. If not set to 0, subsequent calls to PostString will remove the text with the same ID.

font string

If specified, the message will be rendered with the specified font instead of the default console font.