`packet.pass`

Cancels an earlier packet.drop() in the same event, so the packet is delivered, including any edits already made.

Syntax

Atlas Script

packet.pass()

Parameters

This method does not accept arguments.

Return value

See the remarks for the returned value and runtime behavior.

Remarks

Cancels an earlier packet.drop() in the same event, so the packet is delivered, including any edits already made. Delivering is the default.

Examples

Show capture status on the video.atlas

event on_start() {
    if (!network.capture("udp and udp.DstPort == 9000")) {
        system.log("Network capture could not start");
    }
}

event on_frame() {
    if (network.error != "") {
        ui.status("Capture unavailable: " + network.error);
    } else if (network.active) {
        ui.status(string.format("Capture: {} sent, {} received, {} dropped",
            network.sent, network.received, network.dropped));
    } else {
        ui.status("Capture is not running");
    }
}

event on_network_send() {
    packet.pass();
}