clear_teleport_queue Synchronous

  • clear_tp_queue
  • clearqueueonteleport
  • clearteleportqueue
  • cleartpqueue

Discard all source strings previously registered with queue_on_teleport. Call it when the user cancels a planned follow-up action before travelling.

Syntax
Luau
clear_teleport_queue() -> ()

Parameters

This function takes no arguments.

Returns

()

No values.

Usage notes

This clears the queue; it cannot undo a script that has already run after a teleport.

Example

Example
Luau
queue_on_teleport([[print("This will be cancelled")]])
clear_teleport_queue()
print("No queued teleport script remains")
Kawaii documentation