🪤 Trigger

A Trigger class is a utility class to trigger events when any Entity enters an Area.

💂Authority

This class can only be spawned on 🟦 Server.

👪Inheritance

This class inherits from Base Actor .

🎒 Examples

local sphere_trigger = Trigger(Vector(-200, 100, 500), Rotator(), Vector(100), TriggerType.Sphere, true, Color(1, 0, 0))

sphere_trigger:Subscribe("BeginOverlap", function(trigger, actor_triggering)
    Package.Log("Something entered my Sphere Trigger")
end)

local box_trigger = Trigger(Vector(300, 200, 500), Rotator(0, 45, 0), Vector(150, 150, 150), TriggerType.Box, true, Color(0, 1, 0))

box_trigger:Subscribe("BeginOverlap", function(trigger, actor_triggering)
    Package.Log("Something entered my Box Trigger")
end)

box_trigger:Subscribe("EndOverlap", function(trigger, actor_triggering)
    Package.Log("Something left my Box Trigger")
end)

🏗️ Constructor

local my_trigger = Trigger(location?, rotation?, extent?, trigger_type?, is_visible?, color?, overlap_only_classes?)

Type	Name	Default	Description
Vector	location	Vector(0, 0, 0)
Rotator	rotation	Rotator(0, 0, 0)
Vector	extent	Vector(0, 0, 0)	Size of the Trigger. If using Sphere, only the X is used
TriggerType	trigger_type	TriggerType.Sphere
boolean	is_visible	false	Useful for debugging
Color	color	Color.RED	Color to paint the Trigger bounds - if Visible
table of string	overlap_only_classes	{}	Filter Trigger to only overlap specific Classes. Leave it empty for all Classes

🦠 Functions

Inherited Actor Functions

Base Actorscripting-reference/classes/base-classes/actor

	Returns	Name	Description
		AddImpulse	Applies a force in world world to this Actor
		AttachTo	Attaches this Actor to any other Actor, optionally at a specific bone
		Destroy	Destroys this Actor
		Detach	Detaches this Actor from AttachedTo Actor
		SetCollision	Sets this Actor's collision type
		SetForce	Adds a permanent force to this Actor, set to Vector(0, 0, 0) to cancel
		SetGravityEnabled	Sets whether gravity is enabled on this Actor
		SetVisibility	Sets whether the actor is visible or not
		SetHighlightEnabled	Sets whether the highlight is enabled on this Actor, and which highlight index to use
		SetOutlineEnabled	Sets whether the outline is enabled on this Actor, and which outline index to use
		SetLifeSpan	Sets the time (in seconds) before this Actor is destroyed. After this time has passed, the actor will be automatically destroyed.
		SetLocation	Sets this Actor's location in the game world
		SetRotation	Sets this Actor's rotation in the game world
		SetRelativeLocation	Sets this Actor's relative location in local space (only if this actor is attached)
		SetRelativeRotation	Sets this Actor's relative rotation in local space (only if this actor is attached)
		SetScale	Sets this Actor's scale
		SetNetworkAuthority	Sets the Player to have network authority over this Actor
		SetValue	Sets a value in this Actor
		TranslateTo	Smoothly moves this actor to a location over a certain time
		RotateTo	Smoothly rotates this actor to an angle over a certain time
	boolean	IsBeingDestroyed	Returns true if this Actor is being destroyed
	boolean	IsVisible	Returns true if this Actor is visible
	boolean	IsGravityEnabled	Returns true if gravity is enabled on this Actor
	boolean	IsInWater	Returns true if this Actor is in water
	boolean	IsNetworkDistributed	Returns true if this Actor is currently network distributed
	boolean	IsValid	Returns true if this Actor is valid (i.e. wasn't destroyed and points to a valid Actor)
	table of Base Actor	GetAttachedEntities	Gets all Actors attached to this Actor
	Base Actor or nil	GetAttachedTo	Gets the Actor this Actor is attached to
	table	GetBounds	Gets this Actor's bounds
	CollisionType	GetCollision	Gets this Actor's collision type
	number	GetID	Gets the universal network ID of this Actor (same on both client and server)
	Vector	GetLocation	Gets this Actor's location in the game world
	Rotator	GetRotation	Gets this Actor's angle in the game world
	Vector	GetForce	Gets this Actor's force (set by SetForce())
	boolean	HasNetworkAuthority	Returns true if the local Player is currently the Network Authority of this Actor
	boolean	HasAuthority	Gets if this Actor was spawned by the client side
	Vector	GetScale	Gets this Actor's scale
	string	GetType	Gets the type of this Actor
	any	GetValue	Gets a value stored on this Actor at the given key. Please refer to Entity Values for more information
	Vector	GetVelocity	Gets this Actor's current velocity
		AddActorTag	Adds an Unreal Actor Tag to this Actor
		RemoveActorTag	Removes an Unreal Actor Tag from this Actor
	table of string	GetActorTags	Gets all Unreal Actor Tags on this Actor
	function	Subscribe	Subscribes to an Event
		Unsubscribe	Unsubscribes all callbacks from this Event in this Actor within this Package, or only the callback passed

	Returns	Name	Description
		ForceOverlapChecking	Forces a Overlap checking to occur, will immediately trigger overlaps
		SetExtent	Sets the extent size of this trigger (sphere triggers will use only the .X component for radius)

ForceOverlapChecking

Forces a Overlap checking to occur, will immediately trigger overlaps

my_trigger:ForceOverlapChecking()

---

SetExtent

Sets the extent size of this trigger (sphere triggers will use only the .X component for radius)

my_trigger:SetExtent(extent)

Type	Parameter	Default	Description
Vector	extent

---

🚀 Events

Inherited Actor Events

Base Actorscripting-reference/classes/base-classes/actor

	Name	Description
	Destroy	Triggered when an Actor is destroyed
	Spawn	Triggered when an Actor is spawned/created
	ValueChange	Triggered when an Actor has a value changed with :SetValue()

	Name	Description
	BeginOverlap	Triggered when something overlaps this Trigger
	EndOverlap	Triggered when something leaves this Trigger

BeginOverlap

Triggered when something overlaps this Trigger

Trigger.Subscribe("BeginOverlap", function(self, entity)

end)

Type	Argument	Description
Trigger	self	The Trigger entity
Base Actor	entity	Any Actor which overlaps

---

EndOverlap

Triggered when something leaves this Trigger

Trigger.Subscribe("EndOverlap", function(self, entity)

end)

Type	Argument	Description
Trigger	self	The Trigger entity
Base Actor	entity	Any Actor which left the Trigger

---