Scripted sentence: Difference between revisions

Revision as of 16:45, 10 July 2005

Entity Description

Entity Name: scripted_sentence

A scripted sentence, usually spoken by an NPC. Can be considered somewhat obsolete, as it is preferable to use a combination of Faceposer and a Logic_choreographed_scene entity for spoken dialog.

Keyvalues

Template:Kv targetname

Sentence Name (sentence)

<string> The sentence group name, as found in sentences.txt.

Speaker Type (entity)

Additional Sentence Time (delay)

Search Radius (radius)

<integer> Radius to search within for an NPC to use. A value of "0" searches everywhere in the map.

Delay Before Refire (refire)

<string> Timed delay (in seconds) before refiring.

Listener Type (listener)

Volume (volume)

<string> A value from 0-10.

Sound Radius (attenuation)

Inputs

Template:I targetname

Template:I parentname

BeginSentence

Starts the scripted sentence.

Outputs

Template:O targetname

OnBeginSentence

Fires when the sentence begins

OnEndSentence

Fires when the sentence ends

@@ Line 1: / Line 1: @@
-{{wrongtitle|title=scripted_sentance}}
+{{wrongtitle|title=scripted_sentence}}
-{{cleanup}}
-scripted_sentence
+==Entity Description==
+'''Entity Name:''' scripted_sentence
-Scripted Sentence
+A scripted sentence, usually spoken by an NPC. Can be considered somewhat obsolete, as it is preferable to use a combination of [[Faceposer]] and a [[Logic_choreographed_scene]] entity for spoken dialog.
-KEYS
+==Keyvalues==
-Name targetname <target_source> The name that other entities refer to this entity by.
+*{{kv targetname}}
-spawnflags spawnflags <flags>
+*'''Sentence Name (sentence)'''
+:<string> The sentence group name, as found in [[sentences.txt]].
-Sentence Name sentence <string>
+*'''Speaker Type (entity)'''
+:<string>
-Speaker Type entity <string>
+*'''Additional Sentence Time (delay)'''
+:<string>
-Additional Sentence Time delay <string>
+*'''Search Radius (radius)'''
+:<integer> Radius to search within for an NPC to use. A value of "0" searches everywhere in the map.
-Search Radius radius <integer>
+*'''Delay Before Refire (refire)'''
+:<string> Timed delay (in seconds) before refiring.
-Delay Before Refire refire <string>
+*'''Listener Type (listener)'''
+:<string>
-Listener Type listener <string>
+*'''Volume (volume)'''
+:<string> A value from 0-10.
-Volume 0-10 volume <string>
+*'''Sound Radius (attenuation)'''
+:<choices>
-Sound Radius attenuation <choices>
+==Inputs==
+* {{i targetname}}
-INPUTS
+* {{i parentname}}
-Kill Removes this entity from the world.
+*'''BeginSentence'''
+:Starts the scripted sentence.
-KillHierarchy Removes this entity and all its children from the world.
+==Outputs==
-AddOutput <string> Adds an entity I/O connection to this entity. Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>. Very dangerous, use with care.
+* {{o targetname}}
-FireUser1 Causes this entity's OnUser1 output to be fired.
+*'''OnBeginSentence'''
+:Fires when the sentence begins
-FireUser2 Causes this entity's OnUser2 output to be fired.
+*'''OnEndSentence'''
+:Fires when the sentence ends
-FireUser3 Causes this entity's OnUser3 output to be fired.
-FireUser4 Causes this entity's OnUser4 output to be fired.
+[[Category:Entities]]
-BeginSentence Starts the scripted sentence.
-OUTPUTS
-OnUser1 Fired in response to FireUser1 input.
-OnUser2 Fired in response to FireUser2 input.
-OnUser3 Fired in response to FireUser3 input.
-OnUser4 Fired in response to FireUser4 input.
-OnBeginSentence Fires when the sentence begins
-OnEndSentence Fires when the sentence ends