Asw spawner: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (Changed parameters of {{this is a}} to comply with the updated version. This action was performed by a bot.)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{as}}'''asw_Spawner''' is an entity available in [[Alien Swarm]] which is a spawn point for multiple aliens of a specified type
{{this is a|point entity|game=Alien Swarm|name=asw_spawner}} It is used to spawn and configure aliens. Each spawner can only spawn one type of alien.
{{clr}}
 
== Keyvalues ==
== Keyvalues ==
; <code>Name</code>
 
: The name that other entities refer to this entity by. '''not needed unless you want it triggerable'''
; Max Num. Of Live Aliens <code><[[int]]></code>
; <code>Allow spawn if marines are near</code>
: see 'Prevent spawn if marines are this close
; <code>Start Burrowed</code>
: if Yes the spawn alien will play the unburrowing animation.
; <code>Unburrow Idle Activity</code>
: The name that other entities refer to this entity by.
; <code>Unburrow Activity</code>
: If alien starts burrowed, he'll play this activity while unburrowing.
; <code>Prevent spawn if marines are this close</code>
: If 'Allow spawn if marines are near' option is set to 'No' this distance is used for the nearby marine check.
; <code>Long sight range</code>
: If set to 'yes', aliens from this spawner will be able to see and sense enemies twice as far away as normal.
; <code>Alien Orders</code>
: Orders given to each alien spawned.
; <code> Alien Orders Target Name</code>
: Name of the target object for our orders (used by move to and move to ignoring marines orders).
; <code>Name to give spawned aliens</code>
: useful if you want to control the spawned aliens via triggers and such {{note| when triggering the spawned critters the names are automatically given a number after the name when they spawn. ex. YourNameHere1 or YourNameHere_1 so to control them all trigger them by YourNameHere*}}
; <code>Check Spawn Point is Clear</code>
: Should We Check to make sure nothing is on our spawn point? '''ex. box's, aliens, marines'''
; <code>Min Skill Level</code>
: The minimum skill level for this spawner to function.  Skill levels are: 1=easy 2=normal 3=hard 4=insane 0=nolimit
; <code>Max Skill Level</code>
: The maximum skill level for this spawner to function.  Skill levels are: 1=easy 2=normal 3=hard 4=insane 0=nolimit
; <code>Max Num. Of Live Aliens</code>
: Maximum number of live aliens that can be present in the level from this spawner at any given time.
: Maximum number of live aliens that can be present in the level from this spawner at any given time.
; <code>Num. aliens we can create</code>
; Num. aliens we can create <code><int></code>
: The number of aliens that can spawn before the spawner is exhausted.
: The number of aliens that can spawn before the spawner is exhausted.
; <code>Infinitely spawn aliens</code>
; Infinitely spawn aliens <code><[[bool]]></code>
: self-explainatory
: If True then the spawner will constantly spawn aliens until disabled.
; <code>Spawn interval</code>
; Spawn interval <code><[[float]]></code>
: Time in seconds between each alien spawning.
: Time in seconds between each alien spawning.
; <code>Spawn interval variation</code>
; Spawn interval variation <code><float></code>
: Percentage variation applied randomly to the spawn interval each time an alien spawns.  Value must be between 0 and 100.  The default 25 will give a 25% variation to the spawn interval, so a 1 second spawn interval would actually be randomly between 0.75 seconds and 1.25 seconds.
: Percentage variation applied randomly to the spawn interval each time an alien spawns.  Value must be between 0 and 100.  The default 25 will give a 25% variation to the spawn interval, so a 1 second spawn interval would actually be randomly between 0.75 seconds and 1.25 seconds.
; <code>Alien Class</code>
; Alien Class <code><choices></code>
: Which type of alien to produce from this spawner.
: Which class type of alien to produce from this spawner.
; <code>Alien Health scale</code>
; Alien Health scale <code><float></code>
: Multiplies the alien's default health by this amount. '''ex. 0.25=25%, 5=500%....'''
: Multiplier of the alien's default health by this amount. Useful for increasing or decreasing the difficulty of your map. For example: 0.5=50%, 1=100%, 1.50=150%
; <code>Alien Speed Scale</code>
; Alien Speed Scale <code><float></code>
: Multiplies the alien's default speed by this amount. ''' 1=normal 0.5=50% or half speed....'''
: Multiplier of the alien's default speed by this amount. Useful for increasing or decreasing the difficulty of your map. For example: 0.5=50%, 1=100%, 1.5=150%
; <code>Spawner State</code>
; Spawner State <code><bool></code>
: Spawner's initial state
: Spawner's initial state.
{{KV BaseASWSpawner}}
{{KV Angles}}
{{KV Targetname}}


== Flags ==
== Flags ==
* Infinite even on Easy mode
* Infinite even on Easy mode. '''Will forcibly spawn an infinite amount of aliens when the 'Infinitely spawn aliens' flag is set to True, while playing on easy difficulty.
* Don't Spawn Uber aliens here '''as in non of those random near unkillable ones'''
* Don't Spawn Uber aliens here. '''Prevents spawning the stronger variation of drones.'''
* Spawned Aliens never sleep ''' no hibernation... always try to get to player'''
* Spawned Aliens never sleep. '''Never idle into the sleeping state, prevents aliens from stopping, appropriate for hold outs.'''
== Outputs ==
; <code>OnAllSpawned</code>
: Fired when the Spawner has Spawned it's max number of aliens.
; <code>OnAllSpawnedDead</code>
: Fired when the spawner has spawned it's max number of aliens AND they are all dead.
; <code>OnSpawned</code>
: Fired Each time the Spawner Spawns an Alien.
; <code>OnUser1 - 4</code>
: Fired in response to the FireUser inputs; see [[User Inputs and Outputs]].


== Inputs ==
== Inputs ==
Line 65: Line 34:
: Ignores Max Alien count from this spawner and spawns one alien of the predefined type.
: Ignores Max Alien count from this spawner and spawns one alien of the predefined type.
; <code>StartSpawning</code>
; <code>StartSpawning</code>
: self-explainatory
: Enables spawning.
; <code>StopSpawning</code>
; <code>StopSpawning</code>
: self-explainatory
: Disables spawning.
; <code>ToggleEnabled</code>
; <code>ToggleEnabled</code>
: if Disabled enable else disable.
: Toggles active status.
; <code>ToggleSpawning</code>
; <code>ToggleSpawning</code>
: if spawning stop spawning else start spawning.
: Toggle spawning status.
; <code>OnUser1 - 4</code>
{{I Targetname}}
: Fire the OnUser outputs; see [[User Inputs and Outputs]].
 
{{todo| add the rest of the inputs and explain what they are for}}
== Outputs ==
; <code>OnAllSpawned</code>
: Fired when the Spawner has Spawned it's max number of aliens. '''Note:''' If set to infinite spawning, this output will never be fired.
; <code>OnAllSpawnedDead</code>
: Fired when the spawner has spawned it's max number of aliens AND they have all died. '''Note:''' If set to infinite spawning, this output will never be fired.  
; <code>OnSpawned</code>
: Fired Each time the Spawner Spawns an Alien.
{{O Targetname}}

Latest revision as of 17:54, 17 May 2024

asw_spawner is a point entity available in Alien Swarm Alien Swarm. It is used to spawn and configure aliens. Each spawner can only spawn one type of alien.

Keyvalues

Max Num. Of Live Aliens <int>
Maximum number of live aliens that can be present in the level from this spawner at any given time.
Num. aliens we can create <int>
The number of aliens that can spawn before the spawner is exhausted.
Infinitely spawn aliens <bool>
If True then the spawner will constantly spawn aliens until disabled.
Spawn interval <float>
Time in seconds between each alien spawning.
Spawn interval variation <float>
Percentage variation applied randomly to the spawn interval each time an alien spawns. Value must be between 0 and 100. The default 25 will give a 25% variation to the spawn interval, so a 1 second spawn interval would actually be randomly between 0.75 seconds and 1.25 seconds.
Alien Class <choices>
Which class type of alien to produce from this spawner.
Alien Health scale <float>
Multiplier of the alien's default health by this amount. Useful for increasing or decreasing the difficulty of your map. For example: 0.5=50%, 1=100%, 1.50=150%
Alien Speed Scale <float>
Multiplier of the alien's default speed by this amount. Useful for increasing or decreasing the difficulty of your map. For example: 0.5=50%, 1=100%, 1.5=150%
Spawner State <bool>
Spawner's initial state.
BaseASWSpawner:
; Allow spawn if marines are near <bool>
If set to True, the key 'Prevent spawn if marines are this close' must be adjusted accordingly. Useful for 'magic', non-burrowed spawns where it would look awkward if a player saw it.
Start Burrowed <bool>
If true then the spawning alien will play either it's default or a specific unburrow animation.
Unburrow Idle Activity <string>
Idle animation the alien will play before unburrowing. Not necessary for standard spawns.
Unburrow Activity <string>
If the spawning alien starts burrowed, it'll play this animation on spawn. By default burrowed aliens will climb out of a floor grate, in order to change this please view Swarm Animations
Prevent spawn if marines are this close <float>
Used in conjunction with the 'Allow spawn if marines are near' key; if said key set to True then this value must be adjusted for it to work efficiently. If marines are in the specified radius, the spawner will temporarily stop until the set radius has been cleared.
Long sight range <bool>
If true, aliens from this spawner will be able to see and sense enemies twice as far away as normal. Useful for aliens spawned at a distance that are intended to track the marines. Handy for larger survival maps.
Alien Orders <choices>
Orders given to each alien spawned.
  • Spread Then Hibernate
  • Move To
  • Move To Ignoring Marines
  • Move To Nearest Marine
Alien Orders Target Name <targetname>
Name of the target object used by the 'Move To' order (above).
Name to give spawned aliens <string>
Useful for controlling spawned aliens later on.
Note.pngNote: When specifying the spawned aliens in another entity or Output the names of the spawned aliens are automatically given a numeric value after their name. ex. specified name is 'Drone' and the added value would make it 'Drone_1', so in order to specify all the spawned later on you must add a wildcard to the end of the target, thus becoming 'Drone*'
Check Spawn Point is Clear <bool>
Used to check whether the spawn point is clear of obstruction. E.g. Not blocked by props, marines, other aliens.
Min Skill Level <int>
The minimum skill level for this spawner to function. Skill levels are: 1=easy 2=normal 3=hard 4=insane 0=nolimit
Max Skill Level <int>
The maximum skill level for this spawner to function. Skill levels are: 1=easy 2=normal 3=hard 4=insane 0=nolimit
Pitch Yaw Roll (Y Z X) (angles) <QAngle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Flags

  • Infinite even on Easy mode. Will forcibly spawn an infinite amount of aliens when the 'Infinitely spawn aliens' flag is set to True, while playing on easy difficulty.
  • Don't Spawn Uber aliens here. Prevents spawning the stronger variation of drones.
  • Spawned Aliens never sleep. Never idle into the sleeping state, prevents aliens from stopping, appropriate for hold outs.

Inputs

SpawnOneAlien
Ignores Max Alien count from this spawner and spawns one alien of the predefined type.
StartSpawning
Enables spawning.
StopSpawning
Disables spawning.
ToggleEnabled
Toggles active status.
ToggleSpawning
Toggle spawning status.


Outputs

OnAllSpawned
Fired when the Spawner has Spawned it's max number of aliens. Note: If set to infinite spawning, this output will never be fired.
OnAllSpawnedDead
Fired when the spawner has spawned it's max number of aliens AND they have all died. Note: If set to infinite spawning, this output will never be fired.
OnSpawned
Fired Each time the Spawner Spawns an Alien.