getSpeech

From RPTools Wiki
(Redirected from GetSpeech)
Jump to navigation Jump to search

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

getSpeech() Function

Introduced in version 1.3b48
Returns the requested Speech value from the Current Token.

Usage

getSpeech(id)
getSpeech(id, tokenRef)

Parameters

  • id - String ID for the desired speech.
  • tokenRef - Either the token id or Token Name of the token to list the desired speech from.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

Example

Get the speech with the ID signature_line.
<b>[h: myline = getSpeech("signature_line")]</b>

Returns:

It's clobberin time!