Mostly Harmless

UE1:SpecialEvent (RTNP)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
RTNP Object >> Actor >> Triggers >> SpecialEvent
Package: 
Engine
Direct subclass:
VoiceEvent
This class in other games:
U1, UT, U2, U2XMP, UE2Runtime

Special events can be used to display messages and one of the following actions:

To select the type of additional action, set the Object -> InitialState property to the desired state.

Properties[edit]

Property group 'SpecialEvent'[edit]

bBroadcast[edit]

Type: bool

If set to True, the Message will not only be sent to the player who activated the SpecialEvent, but also to all other players. The message string will be displayed in the middle of the HUD in a large blue font when broadcasted.

bPlayerViewRot[edit]

Type: bool

(unused)

Damage[edit]

Type: int

The amount of damage to apply in DamageInstigator state.

DamageString[edit]

Type: string

Modifiers: localized

The death message for DamageInstigator and KillInstigator states. Requires the DamageType to be 'SpecialDamage'.

DamageType[edit]

Type: name

The damage type for DamageInstigator and KillInstigator states. This determines the death message and possibly other effects. 'SpecialDamage' will allow you to specify a DamageString to use as death message. See damage types for other damage type names with special meaning.

Message[edit]

Type: string

Modifiers: localized

The message to display when this SpecialEvent is triggered.

Sound[edit]

Type: Sound

The sound effect to play in PlaySoundEffect and PlayersPlaySoundEffect states.

Default values[edit]

Property Value
Texture Texture'Engine.S_SpecialEvent'

Events[edit]

Trigger[edit]

event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Actor.Trigger

Displays the Message to the EventInstigator or broadcasts it to all players, depending on the value of bBroadcast.

States[edit]

DamageInstigator[edit]

In this state, the SpecialEvent damages the player triggering it in addition to displaying the specified message.

DamageInstigator.Trigger[edit]

event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Trigger (global)

In addition to the global Trigger event's effect, also applies damage to the EventInstigator.

DisplayMessage[edit]

This state actually doesn't change the behavior of the SpecialEvent. It is exactly the same as if 'None' was selected as initial state, but the mapper's intend might be more obvious if this state is selected instead of 'None'.

KillInstigator[edit]

In this state the SpecialEvent instantly kills the player triggering it in addition to displaying the specified message.

KillInstigator.Trigger[edit]

event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Trigger (global)

In addition to the global Trigger event's effect, also kills the EventInstigator.

PlayAmbientSoundEffect[edit]

In this state the SpecialEvent sets the triggering player's AmbientSound it in addition to displaying the specified message.

PlayAmbientSoundEffect.Trigger[edit]

event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Trigger (global)

In addition to the global Trigger event's effect, also sets the EventInstigator AmbientSound to this SpecialEvent's AmbientSound.

PlayerPath[edit]

Sends the triggering player on an interpolation path whose InterpolationPoints have the same Tag as this SpecialEvent's Event value. This only works offline, though.

PlayerPath.Trigger[edit]

event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Trigger (global)

If offline and triggered by a player, the player is set up to follow the specified interpolation path.

PlayersPlaySoundEffect[edit]

Globally plays a sound effect for all players it in addition to displaying the specified message.

PlayersPlaySoundEffect.Trigger[edit]

event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Trigger (global)

Plays the sound effect for all players.

PlaySoundEffect[edit]

Plays a sound effect at the SpecialEvent's location it in addition to displaying the specified message.

PlaySoundEffect.Trigger[edit]

event Trigger (Actor Other, Pawn EventInstigator)

Overrides: Trigger (global)

Plays the sound effect for the SpecialEvent.