Difference between revisions of "var.monitor"

From Inspired-Lua Wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by 2 users not shown)
Line 3: Line 3:
 
<br>  
 
<br>  
  
This function turns on monitoring of a variable (given in the arguments). When another script/program modifies the variable it will trigger on.varChange.<br>  
+
This function turns on monitoring of a variable (given in the arguments). When another script/program modifies the variable it will trigger [[on.varChange|on.varChange]].<br>  
  
 
== Syntax  ==
 
== Syntax  ==
  
var.'''monitor(varname)'''<br> starts monitoring the variable varname (must be a string).  
+
var.'''monitor(varname)'''<br> starts monitoring the variable varname (must not be of an exotic type or it will return an error).<br />
 +
See example below.
  
 
== Example  ==
 
== Example  ==

Latest revision as of 15:07, 2 November 2011

var.monitor is a function that is part of the Var Library.


This function turns on monitoring of a variable (given in the arguments). When another script/program modifies the variable it will trigger on.varChange.

Syntax

var.monitor(varname)
starts monitoring the variable varname (must not be of an exotic type or it will return an error).
See example below.

Example

function on.create()
	var.monitor("sol")
	--turn monitoring on for the variable "sol"
end

function on.varChange(list)
	--The variable got changed!
	return 0 -- allow the change
end

See also