Difference between revisions of "Point surroundtest"

From Valve Developer Community
Jump to: navigation, search
(Can you guys help document this entity?)
 
(Ok my English is not perfect, maybe someone should correct wrong spelling.)
Line 1: Line 1:
 
{{stub}}
 
{{stub}}
A point entity in [[Counter-Strike: Source]].
+
{{DISPLAYTITLE:point_surroundtest}}
 +
{{css point|point_surroundtest}}
 +
 
 +
==Entity description==
 +
This entity reads the audio settings in the properties menu. It identifies the number of selected speakers (2 Speakers, 4 Speakers, 5.1 Sound System) and can fire an output.
 +
 
 +
==Keyvalues==
 +
{{KV Targetname}}
 +
 
 +
==Inputs==
 +
{{I Targetname}}
 +
{{IO|FireCorrectOutput|Fires an output to the correct number of speakers.|}}
 +
 
 +
==Outputs==
 +
{{O Targetname}}
 +
{{IO|On2Speakers|Fires an output if 2 Speakers are selected.|}}
 +
{{IO|On4Speakers|Fires an output if 4 Speakers are selected.|}}
 +
{{IO|On51Speakers|Fires an output if a 5.1 Sound System is selected.|}}

Revision as of 18:47, 22 February 2012

<Counter-Strike: Source> point_surroundtest is a point entity available in Counter-Strike: Source.

Entity description

This entity reads the audio settings in the properties menu. It identifies the number of selected speakers (2 Speakers, 4 Speakers, 5.1 Sound System) and can fire an output.

Keyvalues

Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (in all games since <Left 4 Dead 2>)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (in all games since <Left 4 Dead 2>)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

Inputs

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and its children from the world.
Note:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.
RunScriptFile <script> (in all games since <Left 4 Dead 2>)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since <Left 4 Dead 2>)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug: In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.
FireCorrectOutput
Fires an output to the correct number of speakers.

Outputs

Targetname:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (only in <Left 4 Dead><Left 4 Dead 2>)
This output fires when the entity is killed and removed from the game.
On2Speakers
Fires an output if 2 Speakers are selected.
On4Speakers
Fires an output if 4 Speakers are selected.
On51Speakers
Fires an output if a 5.1 Sound System is selected.