Comment on page
🪄

StatusEffectService

Service for giving and removing status effects.
Example usage:
-- Give all entities the Speed Status Effect when the match starts for 60 seconds
Events.MatchStart(function(event)
for i, player in ipairs(PlayerService.getPlayers()) do
local entity = player:getEntity()
if not entity then
continue
end
StatusEffectService.giveEffect(entity, StatusEffectType.SPEED, 60)
end
end)

Functions

giveEffect(entity: Entity, effect: StatusEffectType, duration: number | nil)

Gives an effect to an entity. You can optionally specify the duration (in seconds) of the effect.

removeEffect(entity: Entity, effect: StatusEffectType)

Removes an effect from an entity

hasEffect(entity: Entity, effect: StatusEffectType): bool

Returns true if the entity has the specified status effect currently applied to them.