2,736
edits
Nasal library: Difference between revisions
Jump to navigation
Jump to search
→setlistener(): Finish doc
Red Leader (talk | contribs) m (→setlistener()) |
Red Leader (talk | contribs) (→setlistener(): Finish doc) |
||
| Line 2,000: | Line 2,000: | ||
=== setlistener() === | === setlistener() === | ||
{{Nasal doc | {{Nasal doc | ||
|syntax = setlistener(node, code[, init[, type]]); | |syntax = setlistener(node, code[, init[, type]]); | ||
|private = _setlistener() | |||
|source = {{flightgear file|src/Scripting/Nasal|l=499|t=Part 1}} {{!}} {{flightgear file|src/Scripting/Nasal|l=1350|t=Part 2}}<br>''Listener implemented using the {{API Link|flightgear|class|FGNasalListener}} class.'' | |source = {{flightgear file|src/Scripting/Nasal|l=499|t=Part 1}} {{!}} {{flightgear file|src/Scripting/Nasal|l=1350|t=Part 2}}<br>''Listener implemented using the {{API Link|flightgear|class|FGNasalListener}} class.'' | ||
|text = Creates a listener which will be triggered when the given property is changed (depending on the '''type'''). A unique integer ID is returned; this can later be used as the argument to {{func link|removelistener}}. | |text = Creates a listener which will be triggered when the given property is changed (depending on the '''type'''). A unique integer ID is returned; this can later be used as the argument to {{func link|removelistener}}. | ||
| Line 2,022: | Line 2,022: | ||
|param4 = type | |param4 = type | ||
|param4text = Integer specifying the listener's behavior. 0 means that the listener will only trigger when the property is changed. 1 means that the trigger will always be triggered when the property is written to. 2 will mean that the listener will be triggered even if child properties are modified. This argument is optional and defaults to 1. | |param4text = Integer specifying the listener's behavior. 0 means that the listener will only trigger when the property is changed. 1 means that the trigger will always be triggered when the property is written to. 2 will mean that the listener will be triggered even if child properties are modified. This argument is optional and defaults to 1. | ||
|example1 = var prop = props.globals.initNode("/sim/test", "", "STRING"); # create property | |||
var id = setlistener("/sim/test", func(n){ # create listener | |||
print("Value: ", n.getValue()); | |||
}); | |||
setprop("/sim/test", "blah"); # trigger listener | |||
removelistener(id); # remove listener | |||
prop.remove(); # remove property | |||
}} | }} | ||