Asw marker: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (template name fix)
No edit summary
Line 1: Line 1:
{{as point|asw_marker}}
{{as point|asw_marker}}
==Entity description==
It creates highlighted areas on the ingame minimap and the briefing map to be used as markings for objectives.  
It creates highlighted areas on the ingame minimap and the briefing map to be used as markings for objectives.  
 
=== Usage ===
 
== Usage ==
 
To create highlighted areas with this entity, you will need an objective first. Once you have that, define it as the markers target in the 'Objective Name' keyvalue and it will be visible ingame. To control it's size, use the 'Map Width' and 'Map Height' keyvalues. Note that these are measured in world units and are automatically fitted onto map, if it is applied correctly.  
To create highlighted areas with this entity, you will need an objective first. Once you have that, define it as the markers target in the 'Objective Name' keyvalue and it will be visible ingame. To control it's size, use the 'Map Width' and 'Map Height' keyvalues. Note that these are measured in world units and are automatically fitted onto map, if it is applied correctly.  
''Note also, that this entity is always the center of the map marking.'' So for example if you wanted to highlight a room on your map, you would have to place the marker in the exact middle of it room, and aplly the rooms size to the 'Map Width' and 'Map Height' keyvalues.
''Note also, that this entity is always the center of the map marking.'' So for example if you wanted to highlight a room on your map, you would have to place the marker in the exact middle of it room, and aplly the rooms size to the 'Map Width' and 'Map Height' keyvalues.


{{tip|To learn how to create overview maps for Alien Swarm addons refere to [[Swarm Overview Map]]!}}
{{tip|To learn how to create overview maps for Alien Swarm addons refere to [[Swarm Overview Map]]!}}


== Keyvalues ==
== Keyvalues ==
Line 69: Line 67:




== See Also ==
== See also ==
 
*[[List of Alien Swarm entities]]
;[[List of Alien Swarm entities]]
*[[Swarm Objectives]]
;[[Swarm Objectives]]






[[Category:Alien Swarm Entities]]
[[Category:Alien Swarm Entities]]

Revision as of 03:51, 12 February 2012

Template:As point

Entity description

It creates highlighted areas on the ingame minimap and the briefing map to be used as markings for objectives.

Usage

To create highlighted areas with this entity, you will need an objective first. Once you have that, define it as the markers target in the 'Objective Name' keyvalue and it will be visible ingame. To control it's size, use the 'Map Width' and 'Map Height' keyvalues. Note that these are measured in world units and are automatically fitted onto map, if it is applied correctly. Note also, that this entity is always the center of the map marking. So for example if you wanted to highlight a room on your map, you would have to place the marker in the exact middle of it room, and aplly the rooms size to the 'Map Width' and 'Map Height' keyvalues.

Tip.pngTip:To learn how to create overview maps for Alien Swarm addons refere to Swarm Overview Map!

Keyvalues

Name
The name that other entities refer to this entity by.
Entity Scripts
Name(s) of script files that are executed after all entities have spawned.
Script think function
Name of a function in this entity's script scope which will be called automatically.


Start Disabled
Wether this entity should start disabled or not.
Note.pngNote:The map markers visibility can be controlled using en/disabling.
Objective Name
Name of the target object this is associated with.
Note.pngNote:If this isn't set, the markings won't show up ingame.
Map Heigth
Name of the target object this is associated with.
Map Width
Name of the target object this is associated with.


Inputs

AddOutput
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1-4
Fire the OnUser outputs; see User Inputs and Outputs.
Kill
Removes this entity from the world.


Enable
Enables this entity (which means sets visible ingame).
Disable
Disables this entity (which means sets invisible ingame).
SetComplete
Sets this entity invisble.
Note.pngNote:Not required to complete missions.


Outputs

OnUser1-4
Fired in response to the FireUser inputs; see User Inputs and Outputs.


See also