Difference between revisions of "Basic lua: Operators"

From The Official Visionaire Studio: Adventure Game Engine Wiki
m
 
(126 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Lua operators are expressions used to perform calculations or to pass arguments between different value types. __NOTOC__
+
{| class="in"
 +
|-
 +
| class="i_arrow clickablecell" |  [[basic_lua:_Basics|<]]
 +
| class="i_norm clickablecell" | '''[[basic_lua:_Index|Index]]'''
 +
| class="i_arrow clickablecell" | [[basic_lua:_Types|>]]
 +
|}
 +
<hr>
 +
Lua operators are expressions used to perform calculations or to pass arguments between different value types.
 +
 
 
== Conditional Operators ==
 
== Conditional Operators ==
 
{| class="ts"
 
{| class="ts"
 
|-
 
|-
| if || width="90%" | Query if something does or does not meet a certain condition.
+
| <span class="vsyellow">if</span> || Query if something does or does not meet a certain condition.
 
|-
 
|-
| else || Do something else if the query condition was not met.
+
| <span class="vsyellow">else</span> || Do something else if the query condition was not met.
 
|-
 
|-
| elseif || Used to add additional if queries, if the initial query condition was not met.
+
| <span class="vsyellow">elseif</span> || Used to add additional if queries, if the initial query condition was not met.
 
|-
 
|-
| end || This is used to close various queries or functions; there must be the same amount of '''end''' as '''if'''; except in instances where '''elseif''' has been used.
+
| <span class="vsyellow">end</span> || This is used to close various queries or functions; there must be the same amount of '''end''' as '''if'''; except in instances where '''elseif''' has been used.
 
|}  
 
|}  
  
 +
=== if ===
 +
{| class="ts"
 +
|-
 +
! if condition is true (method 1) !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = true
  
Example 1: if condition is true (method 1)
+
if a then
{| style="width:100%"
+
  print("a = true")
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(conditional_operators)_1.png|frameless|center|180px]]
 +
|}
 +
<hr>
 +
{| class="ts"
 
|-
 
|-
| <syntaxhighlight>
+
! if condition is true (method 2) !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 
local a = true
 
local a = true
 +
 +
if a == true then
 +
  print("a = true")
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(conditional_operators)_2.png|frameless|center|180px]]
 +
|}
 +
<hr>
 +
{| class="ts"
 +
|-
 +
! if condition is false !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = false
 +
 +
if a == false then
 +
  print("a = false")
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(conditional_operators)_3.png|frameless|center|180px]]
 +
|}
 +
 +
=== else ===
 +
{| class="ts"
 +
|-
 +
! if condition is not met, then do else !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = false
 +
 +
if a then
 +
  print("a = true")
 +
else
 +
  print("a = false")
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(conditional_operators)_4.png|frameless|center|180px]]
 +
|}
 +
 +
=== elseif ===
 +
{| class="ts"
 +
|-
 +
! if condition is not met, then do elseif !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = false
  
 
if a then
 
if a then
print("a = true")
+
  print("a = true")
 +
elseif a == false then
 +
  print("a = false")
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(conditional_operators)_5.png|frameless|center|180px]]
 +
|}
 +
 
 +
== Logical Operators ==
 +
{| class="ts"
 +
|-
 +
| <span class="vsyellow">and</span> || width="90%" | Allows you to check multiple conditions in a single if query.
 +
|-
 +
| <span class="vsyellow">or</span> || Allows you to add an alternative if query into a single if query.
 +
|-
 +
| <span class="vsyellow">not</span> || Checks if condition equals false or negative.
 +
|}
 +
 
 +
=== and ===
 +
{| class="ts"
 +
|-
 +
! if condition a is true and condition b is false then !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = true
 +
local b = false
 +
 
 +
if a == true and b == false then
 +
  print("a = true", "b = false")
 
end
 
end
</syntaxhighlight> || width="200px" | [[File:lb_operators_001.png|thumb|right|180px|click to enlarge]]
+
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(logical_operators)_1.png|frameless|center|180px]]
 
|}
 
|}
  
Example 2: if condition is true (method 2)
+
=== or ===
{| style="width:100%"
+
{| class="ts"
 
|-
 
|-
| <syntaxhighlight>
+
! if condition is true or condition == true then !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 
local a = true
 
local a = true
  
if a == true then
+
if a or a == true then
 
  print("a = true")
 
  print("a = true")
 
end
 
end
</syntaxhighlight> || width="200px" | [[File:lb_operators_002.png|thumb|right|180px|click to enlarge]]
+
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(logical_operators)_2.png|frameless|center|180px]]
 
|}
 
|}
  
Example 3: if condition is false (method 1)
+
=== not ===
{| style="width:100%"
+
{| class="ts"
 
|-
 
|-
| <syntaxhighlight>
+
! if condition is not true !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 
local a = false
 
local a = false
  
Line 46: Line 142:
 
  print("a = false")
 
  print("a = false")
 
end
 
end
</syntaxhighlight> || width="200px" | [[File:lb_operators_003.png|thumb|right|180px|click to enlarge]]
+
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(logical_operators)_3.png|frameless|center|180px]]
 +
|}
 +
 
 +
== Comparison Operators ==
 +
{| class="ts"
 +
|-
 +
| <span class="vsyellow">==</span> || width="90%" | Equal to.
 +
|-
 +
| <span class="vsyellow">~=</span> || Does not equal.
 +
|-
 +
| <span class="vsyellow">>=</span> || Greater than or equal to.
 +
|-
 +
| <span class="vsyellow">></span> || Greater than.
 +
|-
 +
| <span class="vsyellow"><=</span> || Less than or equal to.
 +
|-
 +
| <span class="vsyellow"><</span> || Less than.
 +
|}
 +
 
 +
=== equal to ===
 +
{| class="ts"
 +
|-
 +
!  if a equals 1 !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 1
 +
 
 +
if a == 1 then
 +
print("a = 1")
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(comparison_operators)_1.png|frameless|center|180px]]
 
|}
 
|}
  
Example 4: if condition is false (method 2)
+
=== does not equal ===
{| style="width:100%"
+
{| class="ts"
 +
|-
 +
! if a does not equal 2 !!
 
|-
 
|-
| <syntaxhighlight>
+
| <syntaxhighlight lang="lua">
local a = false
+
local a = 1
 +
 
 +
if a ~= 2 then
 +
print("a = " .. a)
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(comparison_operators)_2.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== greater than or equal to ===
 +
{| class="ts"
 +
|-
 +
! if a is greater than or equal to 2 !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 5
 +
 
 +
if a >= 2 then
 +
print("a = " .. a)
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(comparison_operators)_3.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== greater than ===
 +
{| class="ts"
 +
|-
 +
! if a is greater than 2 !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 3
 +
 
 +
if a > 2 then
 +
print("a = " .. a)
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(comparison_operators)_4.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== less than or equal to ===
 +
{| class="ts"
 +
|-
 +
! if a less than or equal to 2  !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 2
 +
 
 +
if a <=  2 then
 +
print("a = " .. a)
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(comparison_operators)_5.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== less than ===
 +
{| class="ts"
 +
|-
 +
! if a less than 2  !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 0
 +
 
 +
if a <  2 then
 +
print("a = " .. a)
 +
end
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(comparison_operators)_6.png|frameless|center|180px]]
 +
|}
 +
 
 +
== Mathematical Operators ==
 +
{| class="ts"
 +
|-
 +
| <span class="vsyellow">+</span> || width="90%" | Add
 +
|-
 +
| <span class="vsyellow">-</span> || Subtract or invert
 +
|-
 +
| <span class="vsyellow">*</span> || Multiply
 +
|-
 +
| <span class="vsyellow">/</span> || Divide
 +
|-
 +
| <span class="vsyellow">^</span> || Power
 +
|-
 +
| <span class="vsyellow">%</span> || Remainder
 +
|}
 +
 
 +
=== add ===
 +
{| class="ts"
 +
|-
 +
! 1 + 2 = 3 !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 1
 +
local b = 2
 +
local result = a + b
 +
 
 +
print( result )
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(mathematical_operators)_1.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== subtract ===
 +
{| class="ts"
 +
|-
 +
! 3 - 2 = 1 !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 3
 +
local b = 2
 +
local result = a - b
 +
 
 +
print( result )
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(mathematical_operators)_2.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== inverse ===
 +
{| class="ts"
 +
|-
 +
! ''<small>inv</small>'' of 3 = -3 !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 3
 +
local result = -a
 +
 
 +
print( "original value: " .. a, "inversed value: " .. result )
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(mathematical_operators)_3.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== multiply ===
 +
{| class="ts"
 +
|-
 +
! 2 x 2 = 4 !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 2
 +
local result = a * a
 +
 
 +
print( result )
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(mathematical_operators)_4.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== divide ===
 +
{| class="ts"
 +
|-
 +
! 10 ÷ 5 = 2  !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a = 10
 +
local b = 5
 +
local result = a / b
 +
 
 +
print( result )
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(mathematical_operators)_5.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== power ===
 +
{| class="ts"
 +
|-
 +
! base of 2, power of 8 (2ⁿ) = 256 (2x2=4x2=8x2=16x2=32x2=64x2=128x2=256) !!
 +
|-
 +
| <syntaxhighlight lang="lua">
 +
local a, b = 2, 8
 +
local result = a ^ b -- generate answer
  
if a == false then
+
-- break down power function into string result (ignore this code)
  print("a = false")
+
function power(i1, i2)
 +
local val = "" -- clear string
 +
--+--
 +
for i = 1, i2 do -- generate the longhand math formula
 +
  if i < i2 then val = val..i1.."*" else val = val..i1 end
 +
end
 +
  return "which is the equivalent of " .. val
 
end
 
end
</syntaxhighlight> || width="200px" | [[File:lb_operators_004.png|thumb|right|180px|click to enlarge]]
+
 
 +
print("power value of "..a.." & "..b.." = " .. result, power(a,b))
 +
 
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(mathematical_operators)_6.png|frameless|center|180px]]
 +
|}
 +
 
 +
=== remainder ===
 +
{| class="ts"
 +
|-
 +
! remainder of 25 ÷ 4 = 1 (25 ÷ 4 = 6.25 - 6 = 0.25 * 4 = 1) !!
 +
|-
 +
| style="max-width:680px;" | <syntaxhighlight lang="lua">
 +
local a = 25
 +
local b = 4
 +
local result = a / b -- 25 ÷ 4 = 6.25
 +
local result_decimal = math.fmod(result, 1) -- 6.25 - 6 = 0.25
 +
local result_rounded = math.modf(result) -- 6.25 - 0.25 = 6
 +
local remainder = a % b -- 0.25 * 4 = 1
 +
 
 +
print("result: " .. result .. ", decimal: " .. result_decimal .. ", rounded: " .. result_rounded .. ", remainder: " .. remainder)
 +
</syntaxhighlight> || width="180px" style="vertical-align:middle;" | [[File:Basic_lua_(mathematical_operators)_7.png|frameless|center|180px]]
 
|}
 
|}
 +
<hr>
 +
{| class="in"
 +
|-
 +
| class="i_arrow" |  [[basic_lua:_Basics|<]]
 +
| class="i_norm" | '''[[basic_lua:_Index|Index]]'''
 +
| class="i_arrow" | [[basic_lua:_Types|>]]
 +
|}{{toc}}

Latest revision as of 13:50, 5 September 2022

< Index >

Lua operators are expressions used to perform calculations or to pass arguments between different value types.

Conditional Operators

if Query if something does or does not meet a certain condition.
else Do something else if the query condition was not met.
elseif Used to add additional if queries, if the initial query condition was not met.
end This is used to close various queries or functions; there must be the same amount of end as if; except in instances where elseif has been used.

if

if condition is true (method 1)
local a = true

if a then
  print("a = true")
end
Basic lua (conditional operators) 1.png

if condition is true (method 2)
local a = true

if a == true then
  print("a = true")
end
Basic lua (conditional operators) 2.png

if condition is false
local a = false

if a == false then
  print("a = false")
end
Basic lua (conditional operators) 3.png

else

if condition is not met, then do else
local a = false

if a then
  print("a = true")
else
  print("a = false")
end
Basic lua (conditional operators) 4.png

elseif

if condition is not met, then do elseif
local a = false

if a then
  print("a = true")
elseif a == false then
  print("a = false")
end
Basic lua (conditional operators) 5.png

Logical Operators

and Allows you to check multiple conditions in a single if query.
or Allows you to add an alternative if query into a single if query.
not Checks if condition equals false or negative.

and

if condition a is true and condition b is false then
local a = true
local b = false

if a == true and b == false then
  print("a = true", "b = false")
end
Basic lua (logical operators) 1.png

or

if condition is true or condition == true then
local a = true

if a or a == true then
 print("a = true")
end
Basic lua (logical operators) 2.png

not

if condition is not true
local a = false

if not a then
 print("a = false")
end
Basic lua (logical operators) 3.png

Comparison Operators

== Equal to.
~= Does not equal.
>= Greater than or equal to.
> Greater than.
<= Less than or equal to.
< Less than.

equal to

if a equals 1
local a = 1

if a == 1 then
 print("a = 1")
end
Basic lua (comparison operators) 1.png

does not equal

if a does not equal 2
local a = 1

if a ~= 2 then
 print("a = " .. a)
end
Basic lua (comparison operators) 2.png

greater than or equal to

if a is greater than or equal to 2
local a = 5

if a >= 2 then
 print("a = " .. a)
end
Basic lua (comparison operators) 3.png

greater than

if a is greater than 2
local a = 3

if a > 2 then
 print("a = " .. a)
end
Basic lua (comparison operators) 4.png

less than or equal to

if a less than or equal to 2
local a = 2

if a <=  2 then
 print("a = " .. a)
end
Basic lua (comparison operators) 5.png

less than

if a less than 2
local a = 0

if a <  2 then
 print("a = " .. a)
end
Basic lua (comparison operators) 6.png

Mathematical Operators

+ Add
- Subtract or invert
* Multiply
/ Divide
^ Power
% Remainder

add

1 + 2 = 3
local a = 1
local b = 2
local result = a + b

print( result )
Basic lua (mathematical operators) 1.png

subtract

3 - 2 = 1
local a = 3
local b = 2
local result = a - b

print( result )
Basic lua (mathematical operators) 2.png

inverse

inv of 3 = -3
local a = 3
local result = -a

print( "original value: " .. a, "inversed value: " .. result )
Basic lua (mathematical operators) 3.png

multiply

2 x 2 = 4
local a = 2
local result = a * a

print( result )
Basic lua (mathematical operators) 4.png

divide

10 ÷ 5 = 2
local a = 10
local b = 5
local result = a / b

print( result )
Basic lua (mathematical operators) 5.png

power

base of 2, power of 8 (2ⁿ) = 256 (2x2=4x2=8x2=16x2=32x2=64x2=128x2=256)
local a, b = 2, 8
local result = a ^ b -- generate answer

-- break down power function into string result (ignore this code)
function power(i1, i2)
 local val = "" -- clear string
 --+--
 for i = 1, i2 do -- generate the longhand math formula
  if i < i2 then val = val..i1.."*" else val = val..i1 end
 end
 return "which is the equivalent of " .. val
end

print("power value of "..a.." & "..b.." = " .. result, power(a,b))
Basic lua (mathematical operators) 6.png

remainder

remainder of 25 ÷ 4 = 1 (25 ÷ 4 = 6.25 - 6 = 0.25 * 4 = 1)
local a = 25
local b = 4
local result = a / b -- 25 ÷ 4 = 6.25
local result_decimal = math.fmod(result, 1) -- 6.25 - 6 = 0.25
local result_rounded = math.modf(result) -- 6.25 - 0.25 = 6
local remainder = a % b -- 0.25 * 4 = 1

print("result: " .. result .. ", decimal: " .. result_decimal .. ", rounded: " .. result_rounded .. ", remainder: " .. remainder)
Basic lua (mathematical operators) 7.png

< Index >