getSpeech: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page GetSpeech to getSpeech: Converting page titles to lowercase)
 
(6 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=getSpeech
|name=getSpeech
|version=1.3b48
|description=
|description=
Returns the [[Token:speech|speech]] value from the [[Token:Current Token|Current Token]].
Returns the requested [[Introduction to Tokens#Speech|Speech]] value from the [[Current Token]].


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: speech = getSpeech(name)]
getSpeech(id)
</source>
</syntaxhighlight>
 
'''Parameters'''
{{param|id|String ID for the desired speech.}}
 
|example=
Get the speech with the ID ''signature_line''.
<syntaxhighlight lang="mtmacro" line>
<b>[h: myline = getSpeech("signature_line")]</b>
</syntaxhighlight>
Returns:
<b>It's clobberin time!</b>
}}
}}
[[Category:Token Function]]
[[Category:Speech Function]]

Latest revision as of 22:55, 9 February 2023

 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)

Parameters

  • id - String ID for the desired speech.

Example

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

Returns:

It's clobberin time!