Difference between revisions of "Workflow Functions"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 11: Line 11:
 
  if cs ~= nil then cond = game.CurrentScene.Conditions[cond] else cond = Conditions[cond] end -- check global or direct path
 
  if cs ~= nil then cond = game.CurrentScene.Conditions[cond] else cond = Conditions[cond] end -- check global or direct path
 
  -- + --
 
  -- + --
  if val == nil then -- toggle
+
  if val == nil then -- check if condition should be toggled
   if cond.Value then cond.Value = false else Cond.Value = true end
+
   if cond.Value then cond.Value = false else Cond.Value = true end -- toggle condition
 
  else
 
  else
 
   cond.Value = val -- update condition based on val (true or false)
 
   cond.Value = val -- update condition based on val (true or false)

Revision as of 18:59, 20 August 2022

What is a workflow function? A workflow function is a function that you can script to save yourself time by reducing the amount of work you need to do. The function could perform one specific task, or it could perform multiple tasks.

Anyway, let's crack on...


Example #1: Condition

Script section > definition type script:

function setCond(cond, val, cs)
 if cs ~= nil then cond = game.CurrentScene.Conditions[cond] else cond = Conditions[cond] end -- check global or direct path
 -- + --
 if val == nil then -- check if condition should be toggled
  if cond.Value then cond.Value = false else Cond.Value = true end -- toggle condition
 else
  cond.Value = val -- update condition based on val (true or false)
 end
end

Usage example #1: set condition example as true, access globally

setCond("example", true)

Usage example #2: toggle condition example, access condition belonging to current scene

setCond("example", nil, true)