====== not ======

===== Description =====

Negate a boolean value.

===== Function prototype =====

<code>
bool not <bool:arg>
</code>



===== Arguments =====

^  Name  ^  Type  ^ Comment ^
|  //arg//  |  bool  | The boolean value to be negated. |

===== Return value =====

False if //arg// was true, and true if //arg// was false.


===== Example =====

<code>
// create two new boolean variables...
bool b1
bool b2

// ...and set one to true and one to false
set b1 true
set b2 false

// call 'not b1', and pipe result to event log via echo
echo <zs:not b1>

// call 'not b2', and pipe result to event log via echo
echo <zs:not b2>
</code>

... the output of which is written to the event log by [[plugins:general:zeoscript:reference:functions:echo]] as:

<file>
false
true
</file>

===== Comments =====

None.

===== See also =====

  * [[plugins:general:zeoscript:reference:functions:and]]
  * [[plugins:general:zeoscript:reference:functions:or]]
  * [[plugins:general:zeoscript:reference:functions:xor]]