Difference between revisions of "VN fnc showSubtitle"

From Savage Game Design Wiki
Jump to navigation Jump to search
m (Text replacement - "]]; |p1n=" to "]] |p1n=")
(Page filling)
Line 1: Line 1:
−
[[Category:TODO]]
 
 
{{Function
 
{{Function
  
 
|v= 1.00
 
|v= 1.00
  
−
|author= Thomas Ryan, updated by Karel Moricky, edited by Ethan Johnson
+
|author= Ethan Johnson, from {{Biki|BIS_fnc_showSubtitle}}
  
 
|a=
 
|a=
  
−
|e=
+
|e= local
  
 
|g1= vn_subtitle_functions
 
|g1= vn_subtitle_functions
  
−
|d= <pre>/*
+
|d= Displays a subtitle at the bottom of the screen. See {{Biki|BIS_fnc_showSubtitle}}.
−
Author: Thomas Ryan, updated by Karel Moricky, edited by Ethan Johnson
 
  
−
Description:
+
|s= [from, text, useTitleRsc, useCamPos] call [[VN_fnc_showSubtitle]]
−
Displays a subtitle at the bottom of the screen.
 
  
−
Parameters:
+
|p1n= from
−
_this select 0: STRING - Name of the person speaking.
+
|p1t= string
−
_this select 1: STRING - Contents of the subtitle.
+
|p1d= speaker's display name
 +
|p1v= ""
  
−
Returns:
+
|p2n= text
−
SCRIPT - Script controlling the displayed subtitle.
+
|p2t= string
−
*/
+
|p2d= subtitle content
 +
|p2v= ""
  
−
#define POS_W (0.4 * safeZoneW)
+
|p3n= useTitleRsc
−
#define POS_H (safeZoneH)
+
|p3t= boolean
−
#define POS_X (0.5 - POS_W / 2)
+
|p3d= forces {{Biki|titleRsc}} usage for subtitles
−
#define POS_Y (safeZoneY + (7/8) * safeZoneH)
+
|p3v= {{Biki|false}}
−
#define POS_Y_CAM (safeZoneY + (31/32) * safeZoneH)
 
  
−
</pre><small>''(Placeholder description extracted from the function header by '''LM_exportFunctionsToWiki.sqf''')''</small>
+
|p4n= useCamPos
 +
|p4t= boolean
 +
|p4d= forces the text to the bottom of the {{Biki|SafeZone}}
 +
|p4v= {{Biki|false}}
  
−
|s= [] call [[VN_fnc_showsubtitle]]
+
|r1t= script
 +
|r1d= script controlling the displayed subtitle
  
−
|p1n=
+
|x1= <code>[name player, "Wow, it's so warm here!"] call VN_fnc_showSubtitle;</code>
−
|p1t=
 
−
|p1d=
 
−
|p1v=
 
−
 
 
−
|p2n=
 
−
|p2t=
 
−
|p2d=
 
−
|p2v=
 
−
 
 
−
|r1t=
 
−
|r1d=
 
−
 
 
−
|x1= <code>-</code>
 
 
}}
 
}}

Revision as of 19:35, 21 January 2021

← back to Functions Introduced in S.O.G. Prairie Fire v1.00
by Ethan Johnson, from BIS_fnc_showSubtitle
Argument(s): n/a
Effect(s): local

Description

Displays a subtitle at the bottom of the screen. See BIS_fnc_showSubtitle.

Syntax

Syntax
[from, text, useTitleRsc, useCamPos] call VN_fnc_showSubtitle
Parameters
from: String - (Optional, default "") speaker's display name
text: String - (Optional, default "") subtitle content
useTitleRsc: Boolean - (Optional, default false) forces titleRsc usage for subtitles
useCamPos: Boolean - (Optional, default false) forces the text to the bottom of the SafeZone
Return value
Script (Handle) - script controlling the displayed subtitle

Examples

Example 1
[name player, "Wow, it's so warm here!"] call VN_fnc_showSubtitle;
Retrieved from "https://wiki.sogpf.com/index.php?title=VN_fnc_showSubtitle&oldid=4000"