Differences

This shows you the differences between two versions of the page.

--- scripting:reference:cutscenes:caption [2012/04/06 00:08] – mit
+++ scripting:reference:cutscenes:caption [2025/05/28 16:35] (current) – external edit 127.0.0.1
@@ Line 7: / Line 7: @@
 ===== Creation Parameters =====
-Example : ''Caption( 0.5, 0.8, "This is my caption text", 1, 1.0, 2.0, 5.0, 6.0 )''
+Example : ''Caption( 0.5, 0.8, "This is my caption text", 1, 1.0, 2.0, 5.0, 6.0 )'' \\
-: X Position
-: Y Position
-: Text
-: Flags
-: Start Time
-: Fade In End Time
-: Fade Out Start Time
-: Fade Out End Time
+''1 : X Position \\
+: Y Position \\
+: Text \\
+: Flags \\
+: Start Time (Seconds)\\
+: Fade In End Time (Seconds)\\
+: Fade Out Start Time (Seconds)\\
+: Fade Out End Time (Seconds)\\
+''
 ===== Member Functions =====
@@ Line 29: / Line 29: @@
 ===== Example =====
+Here is a simple example demonstrating captions - It displays a bit of text from 10 to 18 seconds, then a different bit from 30 to 38 seconds. Note that we can use different methods to set the fade in and out times - which to use is mostly a matter of preference.
+<codedoc>
+section( 1 )
+{
+    caption = Caption( 0.5, 0.65, "This is a rock", 1, 10, 12, 16, 18 );
+    caption = Caption( 0.5, 0.65, "but this is a special rock", 1 );
+    caption.FadeIn( 30, 32 );
+    caption.FadeOut( 36, 38 );
+}
+</codedoc>