There is no spoon

Difference between revisions of "Legacy:ASCriticalObjectiveVolume"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m
(minor markup.)
 
Line 1: Line 1:
 
{{classbox|[[Legacy:UT2004|UT2004]] :: [[Legacy:Actor|Actor]] >> [[Legacy:Brush|Brush]] >> [[Legacy:Volume|Volume]] >> ASCriticalObjectiveVolume (Package: UT2k4Assault)}}
 
{{classbox|[[Legacy:UT2004|UT2004]] :: [[Legacy:Actor|Actor]] >> [[Legacy:Brush|Brush]] >> [[Legacy:Volume|Volume]] >> ASCriticalObjectiveVolume (Package: UT2k4Assault)}}
  
−
ASCriticalObjectiveVolumes are used in connection with [[Legacy:GameObjective|GameObjective]]s in the UT2004 Assault gametype.  If one or more GameObjectives have a CriticalObjectiveVolumeTag which matches this volume's Events->Tag, then whenever an attacker enters this volume, those objectives will be marked as "critical", and the "critical objective warning" (a siren and flashing HUD icon) will be signalled to the defending team.
+
ASCriticalObjectiveVolumes are used in connection with [[Legacy:GameObjective|GameObjective]]s in the UT2004 Assault gametype.  If one or more GameObjectives have a CriticalObjectiveVolumeTag which matches this volume's Events->Tag.  Then whenever an attacker enters this volume, those objectives will be marked as "critical", and the "critical objective warning" (a siren and flashing HUD icon) will be signalled to the defending team.
  
−
==Properties ==
+
==Properties==
  
−
===Important Properties Inherited from [[Legacy:Actor|Actor]] ===
+
===Main===
 +
; [[Legacy:Pawn|Pawn]] ConstraintPawnClass : Only pawns matching this pawn class (or its descendants) will trigger the critical objective alarm when entering this volume.
  
−
; Events->Tag: This actor is associated with one or more [[Legacy:GameObjective|GameObjective]]s by matching this tag with the GameObjective's CriticalObjectiveVolumeTag property.
+
===Hidden===
 +
; Info CheckTimer : Internal timer used to periodically check if the objective is still "critical".
  
−
===ASCriticalObjectiveVolume ===
+
===Inherited from [[Legacy:Actor|Actor]]===
−
; [[Legacy:Pawn|Pawn]] ConstraintPawnClass: Only pawns matching this pawn class (or its descendants) will trigger the critical objective alarm when entering this volume.
+
; Tag : This actor is associated with one or more [[Legacy:GameObjective|GameObjective]]s by matching this Tag with the GameObjective's <tt>CriticalObjectiveVolumeTag</tt> property.
  
−
===(Hidden Properties) ===
+
==Functions==
−
; Info CheckTimer: Internal timer used to periodically check if the objective is still "critical".
+
; PostBeginPlay() : Skips normal Volume initialization and goes straight to super(Brush).PostBeginPlay() to avoid the AssociatedActorTag stuff in [[Legacy:Volume|Volume]] (ASCriticalVolumes do not support associated actors).
−
 
+
; Destroyed() : Clean up the CheckTimer, if there is one.
−
==Functions ==
+
; bool IsCriticalPawn( [[Legacy:Pawn|Pawn]] P ) : Determine whether the Pawn P matches the requirements (ConstraintPawnClass) for triggering a critical state for the objective.
−
; PostBeginPlay ( ) : Skips normal Volume initialization and goes straight to super(Brush).PostBeginPlay() to avoid the AssociatedActorTag stuff in [[Legacy:Volume|Volume]] (ASCriticalVolumes do not support associated actors).
+
; bool IsStillCritical() : Determine whether there are any Pawns touching this volume which pass the IsCriticalPawn test.  If there are, re-send the "critical objective warning" to the defenders of all of the objectives associated with this volume.  If there aren't any valid touching Pawns, clear the "critical" status on all associated objectives.
−
; Destroyed ( ) : Clean up the CheckTimer, if there is one.
+
; Reset() : Go to the "Safe" state.
−
; bool IsCriticalPawn (Pawn P) : Determine whether the Pawn P matches the requirements (ConstraintPawnClass) for triggering a critical state for the objective.
+
−
; bool IsStillCritical ( ) : Determine whether there are any Pawns touching this volume which pass the IsCriticalPawn test.  If there are, re-send the "critical objective warning" to the defenders of all of the objectives associated with this volume.  If there aren't any valid touching Pawns, clear the "critical" status on all associated objectives.
+
−
 
+
−
; Reset ( ) : Go to the "Safe" state.
+
  
 
==States ==
 
==States ==
  
−
===Safe (auto) ===
+
===Safe (auto)===
  
 
This is the "normal" state of the ASCriticalObjectiveVolume.
 
This is the "normal" state of the ASCriticalObjectiveVolume.
  
−
====Events ====
+
====Events====
−
; Touch (Actor Other) : If Other is a Pawn matching the ConstraintPawnClass, set all associated objectives "critical status" to true, send warning to their defenders, and go into the "Critical" state.
+
; Touch( Actor Other ) : If Other is a Pawn matching the ConstraintPawnClass, set all associated objectives "critical status" to true, send warning to their defenders, and go into the "Critical" state.
  
−
===Critical ===
+
===Critical===
  
 
This state is entered after the Touch event (in the Safe state) has set the objectives to be "critical".
 
This state is entered after the Touch event (in the Safe state) has set the objectives to be "critical".
  
−
====Functions ====
+
====Functions====
−
; BeginState ( ) : Create a new VolumeTimer (and store it in CheckTimer) to periodically see if we're still critical.
+
; BeginState() : Create a new [[Legacy:VolumeTimer|VolumeTimer]] (and store it in CheckTimer) to periodically see if we're still critical.
−
; TimerPop (VolumeTimer T) : When the CheckTimer pops, call IsStillCritical to check if we're still critical.
+
; TimerPop( [[Legacy:VolumeTimer|VolumeTimer]] T ) : When the CheckTimer pops, call IsStillCritical to check if we're still critical.
  
−
===ObjectiveDisabled ===
+
===ObjectiveDisabled===
  
 
Apparently entered when one of the associated objectives is disabled.
 
Apparently entered when one of the associated objectives is disabled.
  
 
====Functions ====
 
====Functions ====
−
; BeginState ( ) : Check if we have any remaining active objectives, and if not, go to the "Disabled" state.
+
; BeginState() : Check if we have any remaining active objectives, and if not, go to the "Disabled" state.
  
−
===Disabled ===
+
===Disabled===
  
 
This state is entered when we don't have any more active objectives to take care of.
 
This state is entered when we don't have any more active objectives to take care of.
  
−
====Functions ====
+
====Functions====
−
; BeginState ( ) : If we have a CheckTimer, clean it up.
+
; BeginState() : If we have a CheckTimer, clean it up.
  
 
==Related Topics==
 
==Related Topics==
 
* [[Legacy:Mapping For AS (UT2004)|Mapping For AS (UT2004)]]
 
* [[Legacy:Mapping For AS (UT2004)|Mapping For AS (UT2004)]]
 +
* [[Legacy:GameObjective|GameObjective]]
 +
* [[Legacy:Team Number|Team Number]]
  
 
[[Category:Legacy Class (UT2004)|{{PAGENAME}}]]
 
[[Category:Legacy Class (UT2004)|{{PAGENAME}}]]

Latest revision as of 12:56, 16 December 2005

UT2004 :: Actor >> Brush >> Volume >> ASCriticalObjectiveVolume (Package: UT2k4Assault)

ASCriticalObjectiveVolumes are used in connection with GameObjectives in the UT2004 Assault gametype. If one or more GameObjectives have a CriticalObjectiveVolumeTag which matches this volume's Events->Tag. Then whenever an attacker enters this volume, those objectives will be marked as "critical", and the "critical objective warning" (a siren and flashing HUD icon) will be signalled to the defending team.

Properties[edit]

Main[edit]

Pawn ConstraintPawnClass 
Only pawns matching this pawn class (or its descendants) will trigger the critical objective alarm when entering this volume.

Hidden[edit]

Info CheckTimer 
Internal timer used to periodically check if the objective is still "critical".

Inherited from Actor[edit]

Tag 
This actor is associated with one or more GameObjectives by matching this Tag with the GameObjective's CriticalObjectiveVolumeTag property.

Functions[edit]

PostBeginPlay() 
Skips normal Volume initialization and goes straight to super(Brush).PostBeginPlay() to avoid the AssociatedActorTag stuff in Volume (ASCriticalVolumes do not support associated actors).
Destroyed() 
Clean up the CheckTimer, if there is one.
bool IsCriticalPawn( Pawn P ) 
Determine whether the Pawn P matches the requirements (ConstraintPawnClass) for triggering a critical state for the objective.
bool IsStillCritical() 
Determine whether there are any Pawns touching this volume which pass the IsCriticalPawn test. If there are, re-send the "critical objective warning" to the defenders of all of the objectives associated with this volume. If there aren't any valid touching Pawns, clear the "critical" status on all associated objectives.
Reset() 
Go to the "Safe" state.

States[edit]

Safe (auto)[edit]

This is the "normal" state of the ASCriticalObjectiveVolume.

Events[edit]

Touch( Actor Other ) 
If Other is a Pawn matching the ConstraintPawnClass, set all associated objectives "critical status" to true, send warning to their defenders, and go into the "Critical" state.

Critical[edit]

This state is entered after the Touch event (in the Safe state) has set the objectives to be "critical".

Functions[edit]

BeginState() 
Create a new VolumeTimer (and store it in CheckTimer) to periodically see if we're still critical.
TimerPop( VolumeTimer T ) 
When the CheckTimer pops, call IsStillCritical to check if we're still critical.

ObjectiveDisabled[edit]

Apparently entered when one of the associated objectives is disabled.

Functions[edit]

BeginState() 
Check if we have any remaining active objectives, and if not, go to the "Disabled" state.

Disabled[edit]

This state is entered when we don't have any more active objectives to take care of.

Functions[edit]

BeginState() 
If we have a CheckTimer, clean it up.

Related Topics[edit]

Retrieved from "https://wiki.beyondunreal.com/Legacy:ASCriticalObjectiveVolume?oldid=1543"