ActionSpeakString(string, int)

From NWN Lexicon
Jump to: navigation, search
Information icon.png This article is in need of examples. You can help the NWN Lexicon by showing how to use this code effectively.

Causes an object to speak.

void ActionSpeakString(
    string sStringToSpeak,
    int nTalkVolume = TALKVOLUME_TALK
);

Parameters

sStringToSpeak
String to be spoken
nTalkVolume
A TALKVOLUME_* constant representing the channel on which to speak the string. (Default: TALKVOLUME_TALK)

Description

Adds to the caller's action queue an action that will cause the caller to speak sStringToSpeak. nTalkVolume determines how loud the string will be spoken when the action is processed.

Remarks

This differs from SpeakString(), which causes the caller to speak immediately. Note that the caller must have an action queue for this to do anything (for example, triggers do not process actions).

See SpeakString for more information about talk volumes.

Version

1.22

See Also

functions:  SpeakString
constants:  TALKVOLUME_* Constants


 author: Charles Feduke, editor: Jasperre, additional contributor(s): Drake Coker