Scripting

Search The Documentation:

  1. Home
  2. Docs
  3. Scripting
  4. Built-In Functions
  5. onTriggerExit

onTriggerExit

Platform Compatibility

PC Mac OSX Oculus Quest
X X X

onTriggerExit runs after leaving a trigger. As triggers are not solid, you may find that this runs quite some time after the onTriggerEnter effect, and generally is useful for things like automated doors or activating a chain of events when leaving an area.

Parameters:

  • name
    • A string showing the name of the object
  • tag
    • A string showing the tag of the object
  • object UID
    • A string for custom numbering of objects / types, use tonumber(uid) to convert it to a number in the script
  • object EID
    • An integer identifier number that only exists for this specific object we are colliding with, is not the same as a UID which can be manually assigned in the editor or via script

Example:

1
2
3
function onTriggerExit(name, tag, uid, eid)
    obj.set3DText("I left the " .. name .. " zone")
end

For more information on when this function will activate, see the Collision and Rigidbody pages.

Tags
Was this article helpful to you? Yes No

How can we help?