Garry's Mod Wiki

Revision Difference

GM:OnCloseCaptionEmit#551669

<function name="OnCloseCaptionEmit" parent="GM" type="hook">⤶ <ishook>yes</ishook>⤶ <description>Called when a caption has been emitted to the closed caption box.</description>⤶ <realm>Client</realm>⤶ <added>2023.09.06</added>⤶ <args>⤶ <arg name="soundScript" type="string">The name of the soundscript, or `customLuaToken` if it's from <page>gui.AddCaption</page></arg>⤶ <arg name="duration" type="number">How long the caption should stay for</arg>⤶ <arg name="fromPlayer" type="boolean">Is this caption coming from the player?</arg>⤶ <arg name="fullText" type="string">The caption. Can be nil if its token is not registered</arg>⤶ </args>⤶ <rets>⤶ <ret name="" type="boolean">Return `true` to prevent the caption from appearing</ret>⤶ </rets>⤶ </function>