feat: captions api

Author: iamsirenstorm

p2ce/caption.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @packageDocumentation
+ * Captioning Interface
+ */
+
+interface Caption {
+    bLowPriority: boolean;
+    bSFX: boolean;
+    nNoRepeat: number;
+    nDelay: number;
+    flLifetimeOverride: number;
+    text: string;
+    options: Map<string, string>;
+}
+
+interface GlobalEventNameMap {
+    BadCaptionRequest: (token: string, lifetime: number) => void;
+    DisplayCaptionRequest: (token: string, caption: Caption, lifetime: number) => void;
+    DisplayRawCaptionRequest: (text: string, lifetime: number) => void;
+    CaptionTick: (time: number) => void;
+}

shared/panels.d.ts

@@ -451,6 +451,12 @@ declare interface Label extends AbstractPanel<'Label'> {
 	SetLocalizationString(text: string): void;
 
 	SetProceduralTextThatIPromiseIsLocalizedAndEscaped(text: string, allowDialogVariables: boolean): void;
+
+	/**
+	 * Approximates the height this label would have
+	 * if the passed in text was set, given a pre-determined width.
+	 */ 
+	GetHeightForText(width: number, text: string): number;
 }
 
 declare interface Movie extends AbstractPanel<'Movie'> {