Difference between revisions of "Say"

Say (edit)

231 bytes added , 20:23, 10 May 2009

Updated to function template - included three more optional parameters in syntax

Anonymous user

@@ Line 1: / Line 1: @@
+{{Function
+ |CSWikiPage = Say
+ |origin = GECK1
+ |summary = [[Say]] makes an actor speak a single line of dialogue.
+ |referenceType = Actor
+ |arguments = {{FunctionArgument
+  |Name = Topic
+  |Type = EditorID
+  }}{{FunctionArgument
+  |Name = ForceSubtitleFlag
+  |Type = int
+  |Optional = Optional
+  }}{{FunctionArgument
+  |Name = Actor
+  |Type = EditorID
+  |Optional = Optional
+  }}{{FunctionArgument
+  |Name = Integer
+  |Type = int
+  |Optional = Optional
+  }}{{FunctionArgument
+  |Name = Integer
+  |Type = int
+  |Optional = Optional
+  }}
+  |Example = JoeRef.Say SpeechTopic
+JoeRef will say SpeechTopic
+}}==Notes==
+*The purpose of the last three optional parameters is unknown at this time.
-=='''Description'''==
+==See Also==
+*[[SayTo]]
-'''Say''' makes an actor speak a single line of dialogue.  The function returns 0, so setting a variable equal to the return value will not do anything.  To set up an action for after the line is spoken, see [[SayToDone]], which is a block that is triggered when the SAY is complete.
+*[[SayToDone]]
-=='''Syntax'''==
- [''ActorREF''.]Say TopicID, ForceSubtitleFlag (optional)
-=='''Examples'''==
- JoeRef.Say SpeechTopic
-=='''Notes'''==
-* None at this time.
-=='''See Also'''==
-[[SayTo]]
 [[Category:Functions]]
 [[Category:Dialogue Functions]]
 [[Category:Actor Functions]]