Difference between revisions of "UE2:Mover states (UT2004)"

Revision as of 10:11, 17 May 2008 (edit) Wormbo (Talk | contribs) (Auto-generated page)		Latest revision as of 16:54, 12 December 2008 (edit) (undo) Wormbo (Talk | contribs) m (→‎RotatingMover: corrected state description (actually applies to return groups))
(One intermediate revision by the same user not shown)
Line 5:		Line 5:
	| parent2 = Object		| parent2 = Object
	}}		}}
−	{{autogenerated}}	+	The different states of a mover control, how the mover is activated.
−	==States==	+
		+	==Selectable initial states==
		+	One of the following states should be selected as the {{tl|InitialState||Actor properties}} of the mover.
		+
	===BumpButton===		===BumpButton===
−	<!-- enter state description -->	+	Open when bumped, close when reset.
		+
		+	Unlike {{tl|BumbOpenTimed}}, the mover will to the {{tl|WasBumpButton}} state instead of closing again. Only when the mover is reset, e.g. at the end of an Assault or Onslaught round, it will return to its initial position.
	====BumpButton.BeginEvent====		====BumpButton.BeginEvent====
Line 32:		Line 37:
	===BumpOpenTimed===		===BumpOpenTimed===
−	<!-- enter state description -->	+	Open when bumped, wait, then close. This is the default state. Note that {{tl|StandOpenTimed}} works better for "automatic" elevators.
	'''Extends:''' {{tl|OpenTimedMover}}		'''Extends:''' {{tl|OpenTimedMover}}
Line 58:		Line 63:
	===ConstantLoop===		===ConstantLoop===
−	<!-- enter state description -->	+	The mover loops through its key frames right away. Depending on the value of {{tl|bOscillatingLoop||Mover properties}}, it either goes forward and reversed when the last key is reached (''True'') or directly moves from the last to the first key. (''False'')
	====ConstantLoop.BeginState====		====ConstantLoop.BeginState====
Line 75:		Line 80:
	===LeadInOutLooper===		===LeadInOutLooper===
−	<!-- enter state description -->	+	Similar to {{tl|ConstantLoop}}, except that key 0 serves as idle position. When the mover is triggered, it moves to key 1 and loops the remaining keys. Depending on the value of {{tl|bOscillatingLoop||Mover properties}}, it either goes forward and reversed when the last key is reached (''True'') or directly moves from the last to the first loop key, i.e. key 1. (''False'') When the mover is triggered again, it goes directly back to key 0.
	====LeadInOutLooper.BeginState====		====LeadInOutLooper.BeginState====
Line 92:		Line 97:
	====LeadInOutLooper.Trigger====		====LeadInOutLooper.Trigger====
−	{{code|event '''Trigger''' ({{cl|Actor}}&nbsp;'''Other''', {{cl|Pawn}}&nbsp;'''EventInstigator''')}}
−
−	'''Overrides:''' {{tl|Trigger|Actor|events}} ''(global)''
−
−	<!-- enter function description -->
−
−	===LeadInOutLooping===
−	<!-- enter state description -->
−
−	====LeadInOutLooping.KeyFrameReached====
−	{{code|event '''KeyFrameReached''' ()}}
−
−	'''Overrides:''' {{tl|KeyFrameReached||Mover}} ''(global)''
−
−	<!-- enter event description -->
−
−	====LeadInOutLooping.Trigger====
	{{code|event '''Trigger''' ({{cl|Actor}}&nbsp;'''Other''', {{cl|Pawn}}&nbsp;'''EventInstigator''')}}		{{code|event '''Trigger''' ({{cl|Actor}}&nbsp;'''Other''', {{cl|Pawn}}&nbsp;'''EventInstigator''')}}
Line 116:		Line 104:
	===LoopMove===		===LoopMove===
−	<!-- enter state description -->	+	Loops through its keys if triggered, stops at the next key if untriggered.
	====LoopMove.BeginState====		====LoopMove.BeginState====
Line 150:		Line 138:
	'''Overrides:''' {{tl|SelfTriggered||Mover}} ''(global)''		'''Overrides:''' {{tl|SelfTriggered||Mover}} ''(global)''
−
−	<!-- enter function description -->
−
−	===OpenTimedMover===
−	<!-- enter state description -->
−
−	====OpenTimedMover.BeginState====
−	{{code|event '''BeginState''' ()}}
−
−	'''Overrides:''' {{tl|BeginState|Object}} ''(global)''
−
−	<!-- enter function description -->
−
−	====OpenTimedMover.Reset====
−	{{code|function '''Reset''' ()}}
−
−	'''Overrides:''' {{tl|Reset||Mover}} ''(global)''
−
−	<!-- enter function description -->
−
−	====OpenTimedMover.ShouldReTrigger====
−	{{code|function [[bool]]&nbsp;'''ShouldReTrigger''' ()}}
	<!-- enter function description -->		<!-- enter function description -->
	===RotatingMover===		===RotatingMover===
−	<!-- enter state description -->	+	A simple rotating state. Most useful for non-leading movers in the "return group" of a non-looping mover. It will start rotating if the "leader" starts opening, stop rotating when the "leader" has opened and reverse the rotation direction when the "leader" closes again.
	====RotatingMover.BeginState====		====RotatingMover.BeginState====
Line 200:		Line 166:
	===StandOpenTimed===		===StandOpenTimed===
−	<!-- enter state description -->	+	Open when stood on, wait, then close. The most-used state for automatic elevators.
	'''Extends:''' {{tl|OpenTimedMover}}		'''Extends:''' {{tl|OpenTimedMover}}
Line 238:		Line 204:
	===TriggerAdvance===		===TriggerAdvance===
−	<!-- enter state description -->	+	Open when triggered, stop when untriggered, close when reset.
		+
		+	This is mostly used in Assault maps for doors and levers that slowly open/activate while a player is nearby. Player proximity is not checked by the mover itself, but by a {{cl|Trigger}} or other triggering/untriggering actor. The mover will only return to its initial position if it is reset, e.g. at the start of a new Assault or Onslaught round.
	====TriggerAdvance.BeginState====		====TriggerAdvance.BeginState====
Line 283:		Line 251:
	===TriggerControl===		===TriggerControl===
−	<!-- enter state description -->	+	Open when triggered, close when get untriggered.
		+
		+	Like {{tl|TriggerAdvance}}, this state requires a {{cl|Trigger}} or other triggering/untriggering actor. Can be used e.g. for doors that stay open while a player is nearby.
	====TriggerControl.BeginState====		====TriggerControl.BeginState====
Line 321:		Line 291:
	===TriggerOpenTimed===		===TriggerOpenTimed===
−	<!-- enter state description -->	+	When triggered, open, wait, then close.
		+
		+	Used for special doors that only stay open for a certain time but shouldn't react to player bumping. This state is also recommended for {{tl|bDamageTriggered||Mover properties}} movers.
	'''Extends:''' {{tl|OpenTimedMover}}		'''Extends:''' {{tl|OpenTimedMover}}
Line 354:		Line 326:
	===TriggerPound===		===TriggerPound===
−	<!-- enter state description -->	+	Starts opening and closing when triggered. Stops when closed after untriggering.
	====TriggerPound.BeginState====		====TriggerPound.BeginState====
Line 392:		Line 364:
	===TriggerToggle===		===TriggerToggle===
−	<!-- enter state description -->	+	Opens when triggered, closes when triggered again.
	====TriggerToggle.Trigger====		====TriggerToggle.Trigger====
Line 412:		Line 384:
	'''Overrides:''' {{tl|SelfTriggered||Mover}} ''(global)''		'''Overrides:''' {{tl|SelfTriggered||Mover}} ''(global)''
		+
		+	<!-- enter function description -->
		+
		+	==Internal states==
		+	These are secondary states the mover will switch to in certain situations. Some of them also serve as base for other states with similar behavior.
		+
		+	===LeadInOutLooping===
		+	Active state for {{tl|LeadInOutLooper}}.
		+
		+	====LeadInOutLooping.KeyFrameReached====
		+	{{code|event '''KeyFrameReached''' ()}}
		+
		+	'''Overrides:''' {{tl|KeyFrameReached||Mover}} ''(global)''
		+
		+	Moves to the next key in sequence.
		+
		+	====LeadInOutLooping.Trigger====
		+	{{code|event '''Trigger''' ({{cl|Actor}}&nbsp;'''Other''', {{cl|Pawn}}&nbsp;'''EventInstigator''')}}
		+
		+	'''Overrides:''' {{tl|Trigger|Actor|events}} ''(global)''
		+
		+	Moves to key 0, then returns to {{tl|LeadInOutLooper}} state.
		+
		+	===OpenTimedMover===
		+	Base state for {{tl|BumpOpenTimed}}, {{tl|StandOpenTimed}} and {{tl|TriggerOpenTimed}} mover.
		+
		+	====OpenTimedMover.BeginState====
		+	{{code|event '''BeginState''' ()}}
		+
		+	'''Overrides:''' {{tl|BeginState|Object}} ''(global)''
		+
		+	<!-- enter function description -->
		+
		+	====OpenTimedMover.Reset====
		+	{{code|function '''Reset''' ()}}
		+
		+	'''Overrides:''' {{tl|Reset||Mover}} ''(global)''
		+
		+	<!-- enter function description -->
		+
		+	====OpenTimedMover.ShouldReTrigger====
		+	{{code|function [[bool]]&nbsp;'''ShouldReTrigger''' ()}}
	<!-- enter function description -->		<!-- enter function description -->
	===WasBumpButton===		===WasBumpButton===
−	<!-- enter state description -->	+	Disabled state for {{tl|BumpButton}} mover.
	====WasBumpButton.Reset====		====WasBumpButton.Reset====
Line 423:		Line 437:
	'''Overrides:''' {{tl|Reset||Mover}} ''(global)''		'''Overrides:''' {{tl|Reset||Mover}} ''(global)''
−	<!-- enter function description -->	+	Returns to {{tl|BumpButton}} state.
	===WasOpenTimedMover===		===WasOpenTimedMover===
−	<!-- enter state description -->	+	Disabled state for trigger-once {{tl|BumpOpenTimed}}, {{tl|StandOpenTimed}} and {{tl|TriggerOpenTimed}} movers.
	====WasOpenTimedMover.Reset====		====WasOpenTimedMover.Reset====
Line 433:		Line 447:
	'''Overrides:''' {{tl|Reset||Mover}} ''(global)''		'''Overrides:''' {{tl|Reset||Mover}} ''(global)''
−	<!-- enter function description -->	+	Returns to the original open-timed state.
	===WasTriggerAdvance===		===WasTriggerAdvance===
−	<!-- enter state description -->	+	Final state of fully-opened {{tl|TriggerAdvance}} mover.
	====WasTriggerAdvance.Reset====		====WasTriggerAdvance.Reset====
Line 443:		Line 457:
	'''Overrides:''' {{tl|Reset||Mover}} ''(global)''		'''Overrides:''' {{tl|Reset||Mover}} ''(global)''
−	<!-- enter function description -->	+	Returns to {{tl|TriggerAdvance}} state.
	====WasTriggerAdvance.SelfTriggered====		====WasTriggerAdvance.SelfTriggered====
Line 453:		Line 467:
	===WasTriggerControl===		===WasTriggerControl===
−	<!-- enter state description -->	+	Final state of fully-opened trigger-once {{tl|TriggerControl}} mover.
	====WasTriggerControl.Reset====		====WasTriggerControl.Reset====
Line 460:		Line 474:
	'''Overrides:''' {{tl|Reset||Mover}} ''(global)''		'''Overrides:''' {{tl|Reset||Mover}} ''(global)''
−	<!-- enter function description -->	+	Returns to {{tl|TriggerControl}} state.
	====WasTriggerControl.SelfTriggered====		====WasTriggerControl.SelfTriggered====
Line 470:		Line 484:
	===WasTriggerPound===		===WasTriggerPound===
−	<!-- enter state description -->	+	Disabled state of trigger-once {{tl|TriggerPound}} mover that opened and closed once.
	====WasTriggerPound.Reset====		====WasTriggerPound.Reset====
Line 477:		Line 491:
	'''Overrides:''' {{tl|Reset||Mover}} ''(global)''		'''Overrides:''' {{tl|Reset||Mover}} ''(global)''
−	<!-- enter function description -->	+	Returns to {{tl|TriggerPound}} state.

---

Latest revision as of 16:54, 12 December 2008

Mover states in other games:

UT2003

Other member categories for this class:

properties

The different states of a mover control, how the mover is activated.

Selectable initial states[edit]

One of the following states should be selected as the InitialState of the mover.

BumpButton[edit]

Open when bumped, close when reset.

Unlike BumbOpenTimed, the mover will to the WasBumpButton state instead of closing again. Only when the mover is reset, e.g. at the end of an Assault or Onslaught round, it will return to its initial position.

BumpButton.BeginEvent[edit]

Overrides: Actor.BeginEvent (global)

BumpButton.Bump[edit]

Overrides: Bump (global)

BumpButton.EndEvent[edit]

Overrides: Actor.EndEvent (global)

BumpOpenTimed[edit]

Open when bumped, wait, then close. This is the default state. Note that StandOpenTimed works better for "automatic" elevators.

Extends: OpenTimedMover

BumpOpenTimed.Bump[edit]

Overrides: Bump (global)

BumpOpenTimed.DisableTrigger[edit]

Overrides: DisableTrigger (global)

BumpOpenTimed.EnableTrigger[edit]

Overrides: EnableTrigger (global)

ConstantLoop[edit]

The mover loops through its key frames right away. Depending on the value of bOscillatingLoop, it either goes forward and reversed when the last key is reached (True) or directly moves from the last to the first key. (False)

ConstantLoop.BeginState[edit]

Overrides: Object.BeginState (global)

ConstantLoop.KeyFrameReached[edit]

Overrides: KeyFrameReached (global)

LeadInOutLooper[edit]

Similar to ConstantLoop, except that key 0 serves as idle position. When the mover is triggered, it moves to key 1 and loops the remaining keys. Depending on the value of bOscillatingLoop, it either goes forward and reversed when the last key is reached (True) or directly moves from the last to the first loop key, i.e. key 1. (False) When the mover is triggered again, it goes directly back to key 0.

LeadInOutLooper.BeginState[edit]

Overrides: Object.BeginState (global)

LeadInOutLooper.KeyFrameReached[edit]

Overrides: KeyFrameReached (global)

LeadInOutLooper.Trigger[edit]

Overrides: Actor.Trigger (global)

LoopMove[edit]

Loops through its keys if triggered, stops at the next key if untriggered.

LoopMove.BeginState[edit]

Overrides: Object.BeginState (global)

LoopMove.KeyFrameReached[edit]

Overrides: KeyFrameReached (global)

LoopMove.Trigger[edit]

Overrides: Actor.Trigger (global)

LoopMove.UnTrigger[edit]

Overrides: Actor.UnTrigger (global)

LoopMove.SelfTriggered[edit]

Overrides: SelfTriggered (global)

RotatingMover[edit]

A simple rotating state. Most useful for non-leading movers in the "return group" of a non-looping mover. It will start rotating if the "leader" starts opening, stop rotating when the "leader" has opened and reverse the rotation direction when the "leader" closes again.

RotatingMover.BeginState[edit]

Overrides: Object.BeginState (global)

RotatingMover.BaseFinished[edit]

Overrides: BaseFinished (global)

RotatingMover.BaseStarted[edit]

Overrides: BaseStarted (global)

StandOpenTimed[edit]

Open when stood on, wait, then close. The most-used state for automatic elevators.

Extends: OpenTimedMover

StandOpenTimed.Attach[edit]

Overrides: Actor.Attach (global)

StandOpenTimed.CanTrigger[edit]

StandOpenTimed.DisableTrigger[edit]

Overrides: DisableTrigger (global)

StandOpenTimed.EnableTrigger[edit]

Overrides: EnableTrigger (global)

StandOpenTimed.ShouldReTrigger[edit]

Overrides: OpenTimedMover.ShouldReTrigger

TriggerAdvance[edit]

Open when triggered, stop when untriggered, close when reset.

This is mostly used in Assault maps for doors and levers that slowly open/activate while a player is nearby. Player proximity is not checked by the mover itself, but by a Trigger or other triggering/untriggering actor. The mover will only return to its initial position if it is reset, e.g. at the start of a new Assault or Onslaught round.

TriggerAdvance.BeginState[edit]

Overrides: Object.BeginState (global)

TriggerAdvance.EndState[edit]

Overrides: Object.EndState (global)

TriggerAdvance.Trigger[edit]

Overrides: Actor.Trigger (global)

TriggerAdvance.UnTrigger[edit]

Overrides: Actor.UnTrigger (global)

TriggerAdvance.Reset[edit]

Overrides: Reset (global)

TriggerAdvance.SelfTriggered[edit]

Overrides: SelfTriggered (global)

TriggerControl[edit]

Open when triggered, close when get untriggered.

Like TriggerAdvance, this state requires a Trigger or other triggering/untriggering actor. Can be used e.g. for doors that stay open while a player is nearby.

TriggerControl.BeginState[edit]

Overrides: Object.BeginState (global)

TriggerControl.Trigger[edit]

Overrides: Actor.Trigger (global)

TriggerControl.UnTrigger[edit]

Overrides: Actor.UnTrigger (global)

TriggerControl.Reset[edit]

Overrides: Reset (global)

TriggerControl.SelfTriggered[edit]

Overrides: SelfTriggered (global)

TriggerOpenTimed[edit]

When triggered, open, wait, then close.

Used for special doors that only stay open for a certain time but shouldn't react to player bumping. This state is also recommended for bDamageTriggered movers.

Extends: OpenTimedMover

TriggerOpenTimed.Trigger[edit]

Overrides: Actor.Trigger (global)

TriggerOpenTimed.DisableTrigger[edit]

Overrides: DisableTrigger (global)

TriggerOpenTimed.EnableTrigger[edit]

Overrides: EnableTrigger (global)

TriggerOpenTimed.SelfTriggered[edit]

Overrides: SelfTriggered (global)

TriggerPound[edit]

Starts opening and closing when triggered. Stops when closed after untriggering.

TriggerPound.BeginState[edit]

Overrides: Object.BeginState (global)

TriggerPound.Trigger[edit]

Overrides: Actor.Trigger (global)

TriggerPound.UnTrigger[edit]

Overrides: Actor.UnTrigger (global)

TriggerPound.Reset[edit]

Overrides: Reset (global)

TriggerPound.SelfTriggered[edit]

Overrides: SelfTriggered (global)

TriggerToggle[edit]

Opens when triggered, closes when triggered again.

TriggerToggle.Trigger[edit]

Overrides: Actor.Trigger (global)

TriggerToggle.Reset[edit]

Overrides: Reset (global)

TriggerToggle.SelfTriggered[edit]

Overrides: SelfTriggered (global)

Internal states[edit]

These are secondary states the mover will switch to in certain situations. Some of them also serve as base for other states with similar behavior.

LeadInOutLooping[edit]

Active state for LeadInOutLooper.

LeadInOutLooping.KeyFrameReached[edit]

Overrides: KeyFrameReached (global)

Moves to the next key in sequence.

LeadInOutLooping.Trigger[edit]

Overrides: Actor.Trigger (global)

Moves to key 0, then returns to LeadInOutLooper state.

OpenTimedMover[edit]

Base state for BumpOpenTimed, StandOpenTimed and TriggerOpenTimed mover.

OpenTimedMover.BeginState[edit]

Overrides: Object.BeginState (global)

OpenTimedMover.Reset[edit]

Overrides: Reset (global)

OpenTimedMover.ShouldReTrigger[edit]

WasBumpButton[edit]

Disabled state for BumpButton mover.

WasBumpButton.Reset[edit]

Overrides: Reset (global)

Returns to BumpButton state.

WasOpenTimedMover[edit]

Disabled state for trigger-once BumpOpenTimed, StandOpenTimed and TriggerOpenTimed movers.

WasOpenTimedMover.Reset[edit]

Overrides: Reset (global)

Returns to the original open-timed state.

WasTriggerAdvance[edit]

Final state of fully-opened TriggerAdvance mover.

WasTriggerAdvance.Reset[edit]

Overrides: Reset (global)

Returns to TriggerAdvance state.

WasTriggerAdvance.SelfTriggered[edit]

Overrides: SelfTriggered (global)

WasTriggerControl[edit]

Final state of fully-opened trigger-once TriggerControl mover.

WasTriggerControl.Reset[edit]

Overrides: Reset (global)

Returns to TriggerControl state.

WasTriggerControl.SelfTriggered[edit]

Overrides: SelfTriggered (global)

WasTriggerPound[edit]

Disabled state of trigger-once TriggerPound mover that opened and closed once.

WasTriggerPound.Reset[edit]

Overrides: Reset (global)

Returns to TriggerPound state.