There is no spoon

UE3:SequenceEvent (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> SequenceObject >> SequenceOp >> SequenceEvent
Package: 
Engine
Direct subclasses:
SeqEvent_GetInventory, UTSeqEvent_MinedOre, SeqEvent_TakeDamage, SeqEvent_ProjectileLanded, SeqEvent_Mover, SeqEvent_Used, SeqEvent_AISeeEnemy, SeqEvent_Console, SeqEvent_ConstraintBroken, SeqEvent_Death, SeqEvent_DemoInput, SeqEvent_Destroyed, SeqEvent_LevelBeginning, SeqEvent_LOS, SeqEvent_LevelLoaded, SeqEvent_LevelReset, SeqEvent_LevelStartup, SeqEvent_PickupStatusChange, SeqEvent_PlayerSpawned, SeqEvent_RemoteEvent, SeqEvent_RigidBodyCollision, SeqEvent_SeeDeath, SeqEvent_SequenceActivated, SeqEvent_Touch, UIEvent, UTSeqEvent_CountdownNodeSucceeded, UTSeqEvent_FlagEvent, UTSeqEvent_GameEnded, UTSeqEvent_ObjectiveCompleted, UTSeqEvent_OnslaughtNodeEvent, UTSeqEvent_PowerCoreDestructionEffect, UTSeqEvent_SkipCinematic, UTSeqEvent_TurretSpawn, UTSeqEvent_TurretStatusChanged, UTSeqEvent_VehicleFactory
This class in other games:
UDK

class SequenceEvent

Sequence event is a representation of any event that is used to instigate a sequence.

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties[edit]

Property group 'SequenceEvent'[edit]

bClientSideOnly[edit]

Type: bool

Modifiers: const

if true, this event (and therefore all linked actions) is triggered on the client instead of the server use for events that don't affect gameplay

Note: direct references to level placed actors used by client side events/actions require that the actors have bStatic or bNoDelete set; otherwise the reference will be NULL on the client

bEnabled[edit]

Type: bool

Is this event currently enabled?

Default value: True

bPlayerOnly[edit]

Type: bool

Require this event to be activated by a player?

Default value: True

MaxTriggerCount[edit]

Type: int

How many times can this event be activated, 0 for infinite

Default value: 1

Priority[edit]

Type: byte

Used by event managers (such as DialogueManager) to help filter out events that occur at same time

ReTriggerDelay[edit]

Type: float

Delay between allowed activations

Internal variables[edit]

ActivationTime[edit]

Type: float

Modifiers: transient

Last time this event was activated at

bRegistered[edit]

Type: bool

Modifiers: transient

Has this event been successfully register?

Instigator[edit]

Type: Actor

Modifiers: transient

Instigator of the event activation, or the actor that caused the event to be activated. Can vary depending on the type of event.

MaxWidth[edit]

Type: int

Editor only, max width of the title bar?

Originator[edit]

Type: Actor

Originator of this event, set at editor time. Usually the actor that this event is attached to.

QueuedActivations[edit]

Type: array<QueuedActivationInfo>


TriggerCount[edit]

Type: int

Modifiers: transient

Number of times this event has been activated

Default values[edit]

Property Value
ObjColor
Member Value
A 255
B 0
G 0
R 255
VariableLinks[0]
Member Value
bWriteable True
ExpectedType Class'Engine.SeqVar_Object'
LinkDesc "Instigator"
MaxVars 255
MinVars 1

Structs[edit]

QueuedActivationInfo[edit]

Modifiers: native

Matches the ::ActivateEvent parms, for storing multiple activations per frame

Actor InOriginator 
Actor InInstigator 
array<int> ActivateIndices 
bool bPushTop 

Functions[edit]

Native functions[edit]

CheckActivate[edit]

native noexport final function bool CheckActivate (Actor inOriginator, Actor inInstigator, optional bool bTest, optional const out array<intActivateIndices, optional bool bPushTop)

Checks if this event could be activated, and if bTest == false then the event will be activated with the specified actor as the instigator.

Parameters:

  • inOriginator - actor to use as the originator
  • inInstigator - actor to use as the instigator
  • bTest - if true, then the event will not actually be activated, only tested for success
  • ActivateIndices - array of indices of output links to activate if the event is activated. If unspecified, the default is to activate all of them.
  • bPushTop - if true and the event is activated, adds it to the top of the stack (meaning it will be executed first), rather than the bottom

Returns:

true if this event can be activated, or was activate if !bTest

Events[edit]

RegisterEvent[edit]

event RegisterEvent ()

Called when the sequence that contains this event is initialized (@see USequence::InitializeSequence). For events attached to actors, this will occur at level startup (@see USequence::BeginPlay())

Toggled[edit]

event Toggled ()

Called once this event is toggled via SeqAct_Toggle.

Other instance functions[edit]

Reset[edit]

function Reset ()

Overrides: SequenceOp.Reset