Revision Difference
gui.AddCaption#561608
<function name="AddCaption" parent="gui" type="libraryfunc">
<description>Pushes text to the closed caption box.</description>⤶
<description>⤶
Pushes text to the closed caption box.⤶
<note>The function will not work, if the console command variable "closecaption" is set to 0.</note>⤶
</description>⤶
<realm>Client</realm>
<added>2023.09.19</added>
<args>
<arg name="text" type="string">The caption to emit. See [Closed Captions](https://developer.valvesoftware.com/wiki/Closed_Captions) for more info</arg>
<arg name="duration" type="number">How long the caption should stay for</arg>
<arg name="fromPlayer" type="boolean" default="false">Is this caption coming from the player?
This is used to give different colors to the caption to differentiate, for example, whether the SMG is fired by the player or NPC.</arg>
</args>
</function>
⤶
<example>⤶
<description>Prints "Hello World" in bold</description>⤶
<code>⤶
RunConsoleCommand("closecaption", "1") // To activate the caption⤶
gui.AddCaption("<B>Hello World!<B>", 5)⤶
</code>⤶
<output>⤶
</example>