Template:LSL Function/Pass

From Second Life Wiki
Jump to: navigation, search
#var value
p__desc PASS_* flag
Constant Value Script No Script Description
PASS_IF_NOT_HANDLED 0 not passed passed {{{3}}} are passed if there is no script handling the event in the prim.
PASS_ALWAYS 1 passed passed {{{3}}} are always passed to the root.
PASS_NEVER 2 not passed not passed {{{3}}} are never passed to the root.
  • Has no known effect if called from within the root prim.

TRUE & FALSE vs. PASS_* flags

Prior to Server Version 1.40.2, was couched in terms of being a boolean and the only meaningful values were 0 and 1. The best practice at that time was to use the integer constants TRUE and FALSE. The design of this function left much to be desired. The problem was that while TRUE always caused all {{{3}}} to be passed along to the the root, FALSE would only not pass {{{3}}} if there the prim had a script that handled a {{{2}}} event. This meant to fully utilize this function the prim must contain a script that handled {{{2}}} events! With the release of Server Version 1.40.2, the PASS_* flags were introduced and the subtype of the was changed. Specifically the introduction of PASS_NEVER solved this problem, allowing content creators to eliminate scripts that were only in the object to tweak the passing of {{{2}}} events.