Skip to content
HELIX is in Early Access Preview. Some features and documentation may be non-functional or out of date.

Game Events

HELIX automatically triggers events in the background when certain actions happen to make it easier for you to respond to those actions!


HEvent:HealthChanged#

Client event that can be listened to for any health changes on the character

Example
RegisterClientEvent('HEvent:HealthChanged', function(oldHealth, newHealth)
    print('Health changed from ' .. oldHealth .. ' to ' .. newHealth)
end)

HEvent:Death#

Client event that can be listened to for character death

Example
RegisterClientEvent('HEvent:Death', function()
    print('Player has died')
end)

HEvent:WeaponEquipped#

Client event that can be listened to for player equipping a weapon

Example
RegisterClientEvent('HEvent:WeaponEquipped', function(displayName, weaponName)
    print('Equipped weapon: ' .. displayName .. ' (' .. weaponName .. ')')
end)

HEvent:WeaponUnequipped#

Client event that can be listened to for when a character unequips a weapon

Example
RegisterClientEvent('HEvent:WeaponUnequipped', function()
    print('Unequipped weapon')
end)

HEvent:EnteredVehicle#

Client event that can be listened to for character entering a vehicle

Example
RegisterClientEvent('HEvent:EnteredVehicle', function(seat)
    print('Entered vehicle, seat: ' .. seat)
end)

HEvent:ExitedVehicle#

Client event that can be listened to for character leaving a vehicle

Example
RegisterClientEvent('HEvent:ExitedVehicle', function(seat)
    print('Exited vehicle, seat: ' .. seat)
end)

HEvent:VoiceStateChanged#

Client event that can be listened to for when the user is talking

Example
RegisterClientEvent('HEvent:VoiceStateChanged', function(isTalking)
    print('Is User Talking: ' .. tostring(isTalking))
end)