Events

Events are nodes that are called from gameplay code to begin execution of an individual network within the EventGraph. They allow Blueprints to perform a series of actions in response to certain events that occur within the game, such as the game beginning, the level being reset, taking damage, etc. These events can be accessed within Blueprints in order to implement new functionality or override or augment the default functionality. Any number of Events can be used within a single EventGraph; though only one of each type may be used.

Blueprint Class Events Expanded Level Blueprint Events Expanded

Each event can only execute a single object. If you want to trigger multiple actions from one event, you will need to string them together linearly.

For information about using Matinee to create events to be triggered at specific times during the playback of a cinematic sequence, see Modifying Blueprint Properties with Matinee .

Event Level Reset

This Blueprint Event node is only available in the Level Blueprint.

This Blueprint Event node executes only on the server. For single player games, the local client is considered the server.

LevelReset.png

The Level Reset event sends out an execution signal when the level restarts. This is useful when you need something to be triggered once a level has reloaded, such as in a gaming situation when the player has died but the level does not need to reload.

LevelReset_Example.png

Event Actor Begin Overlap

BeginOverlap.png

This event will execute when a number of conditions are met at the same time:

  • Collision response between the actors must allow Overlaps.

  • Both Actors that are to execute the event have Generate Overlap Events set to true.

  • And finally, both Actors' collision starts overlapping; moving together or one is created overlapping the other.

For more information on collision, see: Collision Responses .

BeginOverlapEX.png

When this Blueprint Actor overlaps the Actor stored in the Player Actor variable, it will increment the Counter integer variable.

Item Description

Output Pins

Other Actor Actor - This is the Actor that is overlapping this Blueprint.

Event Actor End Overlap

EndOverlap.png

This event will execute when a number of conditions are met at the same time:

  • Collision response between the actors must allow Overlaps.

  • Both Actors that are to execute the event have Generate Overlap Events set to true.

  • And finally, both Actors' collision stop overlapping; moving apart or if one is destroyed.

For more information on collision, see: Collision Responses .

EndOverlapEX.png

When this Blueprint Actor stops overlapping any other Actor except the Actor stored in the Player Actor variable, it will destroy the Actor that overlapped it.

Item Description

Output Pins

Other Actor Actor - This is the Actor that is overlapping this Blueprint.

Event Hit

EventHit.png

This event will execute as long as the collision settings on one of the Actors involved have Simulation Generates Hit Events set to true.

If you are creating movement using Sweeps, you will get this event even if you don't have the flag selected. This occurs as long as the Sweep stops you from moving past the blocking object.

Item Description

Output Pins

My Comp PrimitiveComponent - The Component on the executing Actor that was hit.
Other Actor - The other Actor involved in the collision.
Other Comp PrimitiveComponent - The component on the other Actor involved in the collision that was hit.
Self Moved Boolean - Used when receiving a hit from another object's movement (if false), the directions of Hit Normal and Hit Impact Normal will be adjusted to indicate force from the other object against the object being hit.
Hit Location Vector - The location of contact between the two colliding Actors.
Hit Normal Vector - The direction of the collision.
Normal Impulse Vector - The force that the Actors collided with.
Hit Struct HitResult - All the data collected in a Hit, you can pull off and "break" this result to gain access to the individual bits of data.

EventHitEX.png

In this example, when this Blueprint executes Hit it will spawn an explosion effect at the point of impact.

Event Any Damage

This Blueprint Event node executes only on the server. For single player games, the local client is considered the server.

AnyDamage.png

This event is passed along when general damage is to be dealt. Like drowning or environmental damage, not specifically point damage or radial damage.

Item Description

Output Pins

Damage Float - The amount of damage being passed into the Actor.
Damage Type Object DamageType - This is the object that contains additional data on the Damage being dealt.
Instigated By Actor - The Actor that is responsible for the damage. This would be the Actor that fired a gun or threw the grenade to deal the damage.
Damage Causer Actor - The Actor that caused the damage. This would be like a bullet or explosion.

Here if the damage being dealt to the Actor is coming from Water, it will subtract health and print a warning to the screen.

Event Point Damage

This Blueprint Event node executes only on the server. For single player games, the local client is considered the server.

PointDamage.png

Point Damage is meant to represent damage dealt by projectiles, hit scan weapons, or even melee weaponry.

Item Description

Output Pins

Damage Float - The amount of damage being passed into the Actor.
Damage Type Object DamageType - This is the object that contains additional data on the Damage being dealt.
Hit Location Vector - The location of where the damage is being applied.
Hit Normal Vector - The direction of the collision.
Hit Component PrimitiveComponent - The Component on the executing Actor that was hit.
Bone Name Name - The name of the bone that was hit.
Shot from Direction Vector - The direction the damage came from.
Instigated By Actor - The Actor that is responsible for the damage. This would be the Actor that fired a gun or threw the grenade to deal the damage.
Damage Causer Actor - The Actor that caused the damage. This would be like a bullet or explosion.

In this example, when any damage is received, the damage dealt is subtracted from the Actor's health, but if the Head of the Actor is hit then the Actor's health is set to -1.

Event Radial Damage

This Blueprint Event node executes only on the server. For single player games, the local client is considered the server.

RadialDamage.png

The Radial Damage Event is called whenever the parent Actor for this sequence receives radial damage. This is useful for handling events based on explosion damage, or damage caused indirectly.

Item Description

Output Pins

Damage Received Float - The amount of damage received from the event.
Damage Type Object DamageType - This is the object that contains additional data on the Damage being dealt.
Origin Vector - This gives the location in 3D space where the damage originated.
Hit Info Struct HitResult - All the data collected in a Hit, you can pull off and "break" this result to gain access to the individual bits of data.
Instigated By Controller - The Controller (AI or Player) that instigated the damage.
Damage Causer Actor - The Actor that caused the damage. Could be a bullet, rocket, laser, or a character punching another.

Event Actor Begin Cursor Over

BeginCursorOver.png

When using the mouse interface, when the mouse cursor is moved over an Actor, this event will execute.

BeginCursorOverEX.png

Once the mouse passes over this Actor it sets the scalar Parameter named Highlight on the Dynamic Material Instance to 1.0.

Event Actor End Cursor Over

EndCursorOver.png

When using the mouse interface, when the mouse cursor is moved off an Actor, this event will execute.

EndCursorOverEX.png

This will set the Actor stored in Target Notification to hidden in game.

Event Begin Play

BeginPlay.png

This event is triggered for all Actors when the game is started, any Actors spawned after the game is started will have this called immediately.

BeginPlayEX.png

Upon beginning play, this Actor will set its Health to 1000 and Score to 0.

Event End Play

EndPlay.png

This event is executed when the Actor ceases to be in the World.

EndPlayEX.png

Once this Actor is no longer in the World, a String will output to indicate the reason for the Event being called.

Item Description

Output Pins

End Play Reason enum EEndPlayReason - An enum indicating the reason for why Event End Play is being called.

Event Destroyed

Destroyed.png

This event is executed when the Actor is Destroyed.

DestroyedEX.png

In this example, the variable of Score is being set to Value plus Score.

The Destroyed Event will be deprecated in a future release! The functionality of the Destroyed function has been incorporated into the EndPlay function.

Event Tick

Tick.png

This is a simple event that is called on every frame of gameplay.

Item Description

Output Pins

Delta Seconds Float - This outputs the amount of time between frames.

TickEX.png

This example uses Delta Seconds to form a countdown timer that displays in the log with the final tick being "Blast Off!"

Event Receive Draw HUD

This Event is only available to Blueprint Classes that inherit from the HUD class.

DrawHud.png

This is a specialized event that enables Blueprints to draw to the HUD. The HUD draw nodes require this event to be the one that creates them.

Item Description

Output Pins

Size X Int - The width of the render window in pixels.
Size Y Int - The height of the render window in pixels.

This will create a clickable Hit Box in the center of the render window, with a red box behind it so you can see it.

Custom Event

Custom Event Node

The Custom Event node is a specialized node with its own workflow, see: Custom Event Nodes for more information.