Browse Source

Linked command & event handler reference to classes.

master
Christopher 9 years ago
parent
commit
419ed9341a
  1. 12
      Docs/command_ref/animation_commands.md
  2. 14
      Docs/command_ref/audio_commands.md
  3. 14
      Docs/command_ref/camera_commands.md
  4. 6
      Docs/command_ref/core_events.md
  5. 34
      Docs/command_ref/flow_commands.md
  6. 2
      Docs/command_ref/input_events.md
  7. 38
      Docs/command_ref/itween_commands.md
  8. 20
      Docs/command_ref/narrative_commands.md
  9. 20
      Docs/command_ref/scripting_commands.md
  10. 16
      Docs/command_ref/sprite_commands.md
  11. 12
      Docs/command_ref/sprite_events.md
  12. 6
      Docs/command_ref/tests_commands.md
  13. 12
      Docs/command_ref/ui_commands.md
  14. 4
      Docs/command_ref/ui_events.md
  15. 18
      Docs/command_ref/variable_commands.md

12
Docs/command_ref/animation_commands.md

@ -3,6 +3,8 @@
## Play Anim State ## Play Anim State
Plays a state of an animator according to the state name Plays a state of an animator according to the state name
Defined in Fungus.Commands.PlayAnimState
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object Animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object
@ -13,6 +15,8 @@ Time | Fungus.Variables.FloatData | Start time of animation
## Reset Anim Trigger ## Reset Anim Trigger
Resets a trigger parameter on an Animator component. Resets a trigger parameter on an Animator component.
Defined in Fungus.Commands.ResetAnimTrigger
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object _animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object
@ -21,6 +25,8 @@ _parameter Name | Fungus.Variables.StringData | Name of the trigger Animator par
## Set Anim Bool ## Set Anim Bool
Sets a boolean parameter on an Animator component to control a Unity animation Sets a boolean parameter on an Animator component to control a Unity animation
Defined in Fungus.Commands.SetAnimBool
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object _animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object
@ -30,6 +36,8 @@ Value | Fungus.Variables.BooleanData | The boolean value to set the parameter to
## Set Anim Float ## Set Anim Float
Sets a float parameter on an Animator component to control a Unity animation Sets a float parameter on an Animator component to control a Unity animation
Defined in Fungus.Commands.SetAnimFloat
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object _animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object
@ -39,6 +47,8 @@ Value | Fungus.Variables.FloatData | The float value to set the parameter to
## Set Anim Integer ## Set Anim Integer
Sets an integer parameter on an Animator component to control a Unity animation Sets an integer parameter on an Animator component to control a Unity animation
Defined in Fungus.Commands.SetAnimInteger
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object _animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object
@ -48,6 +58,8 @@ Value | Fungus.Variables.IntegerData | The integer value to set the parameter to
## Set Anim Trigger ## Set Anim Trigger
Sets a trigger parameter on an Animator component to control a Unity animation Sets a trigger parameter on an Animator component to control a Unity animation
Defined in Fungus.Commands.SetAnimTrigger
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object _animator | Fungus.Variables.AnimatorData | Reference to an Animator component in a game object

14
Docs/command_ref/audio_commands.md

@ -3,6 +3,8 @@
## Control Audio ## Control Audio
Plays, loops, or stops an audiosource. Any AudioSources with the same tag as the target Audio Source will automatically be stoped. Plays, loops, or stops an audiosource. Any AudioSources with the same tag as the target Audio Source will automatically be stoped.
Defined in Fungus.Commands.ControlAudio
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Control | Fungus.Commands.ControlAudioType | What to do to audio Control | Fungus.Commands.ControlAudioType | What to do to audio
@ -15,6 +17,8 @@ Wait Until Finished | System.Boolean | Wait until this command has finished befo
## Play Music ## Play Music
Plays looping game music. If any game music is already playing, it is stopped. Game music will continue playing across scene loads. Plays looping game music. If any game music is already playing, it is stopped. Game music will continue playing across scene loads.
Defined in Fungus.Commands.PlayMusic
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Music Clip | UnityEngine.AudioClip | Music sound clip to play Music Clip | UnityEngine.AudioClip | Music sound clip to play
@ -25,6 +29,8 @@ Fade Duration | System.Single | Length of time to fade out previous playing musi
## Play Sound ## Play Sound
Plays a once-off sound effect. Multiple sound effects can be played at the same time. Plays a once-off sound effect. Multiple sound effects can be played at the same time.
Defined in Fungus.Commands.PlaySound
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Sound Clip | UnityEngine.AudioClip | Sound effect clip to play Sound Clip | UnityEngine.AudioClip | Sound effect clip to play
@ -34,6 +40,8 @@ Wait Until Finished | System.Boolean | Wait until the sound has finished playing
## Play Usfxr Sound ## Play Usfxr Sound
Plays a usfxr synth sound. Use the usfxr editor [Tools > Fungus > Utilities > Generate usfxr Sound Effects] to create the SettingsString. Set a ParentTransform if using positional sound. See https://github.com/zeh/usfxr for more information about usfxr. Plays a usfxr synth sound. Use the usfxr editor [Tools > Fungus > Utilities > Generate usfxr Sound Effects] to create the SettingsString. Set a ParentTransform if using positional sound. See https://github.com/zeh/usfxr for more information about usfxr.
Defined in Fungus.Commands.PlayUsfxrSound
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Parent Transform | UnityEngine.Transform | Transform to use for positional audio Parent Transform | UnityEngine.Transform | Transform to use for positional audio
@ -43,6 +51,8 @@ Wait Duration | System.Single | Time to wait before executing the next command
## Set Audio Pitch ## Set Audio Pitch
Sets the global pitch level for audio played with Play Music and Play Sound commands. Sets the global pitch level for audio played with Play Music and Play Sound commands.
Defined in Fungus.Commands.SetAudioPitch
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Pitch | System.Single | Global pitch level for audio played using the Play Music and Play Sound commands Pitch | System.Single | Global pitch level for audio played using the Play Music and Play Sound commands
@ -52,6 +62,8 @@ Wait Until Finished | System.Boolean | Wait until the pitch change has finished
## Set Audio Volume ## Set Audio Volume
Sets the global volume level for audio played with Play Music and Play Sound commands. Sets the global volume level for audio played with Play Music and Play Sound commands.
Defined in Fungus.Commands.SetAudioVolume
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Volume | System.Single | Global volume level for audio played using Play Music and Play Sound Volume | System.Single | Global volume level for audio played using Play Music and Play Sound
@ -60,3 +72,5 @@ Wait Until Finished | System.Boolean | Wait until the volume fade has completed
## Stop Music ## Stop Music
Stops the currently playing game music. Stops the currently playing game music.
Defined in Fungus.Commands.StopMusic

14
Docs/command_ref/camera_commands.md

@ -3,6 +3,8 @@
## Fade Screen ## Fade Screen
Draws a fullscreen texture over the scene to give a fade effect. Setting Target Alpha to 1 will obscure the screen, alpha 0 will reveal the screen. If no Fade Texture is provided then a default flat color texture is used. Draws a fullscreen texture over the scene to give a fade effect. Setting Target Alpha to 1 will obscure the screen, alpha 0 will reveal the screen. If no Fade Texture is provided then a default flat color texture is used.
Defined in Fungus.Commands.FadeScreen
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Duration | System.Single | Time for fade effect to complete Duration | System.Single | Time for fade effect to complete
@ -14,6 +16,8 @@ Fade Texture | UnityEngine.Texture2D | Optional texture to use when rendering th
## Fade To View ## Fade To View
Fades the camera out and in again at a position specified by a View object. Fades the camera out and in again at a position specified by a View object.
Defined in Fungus.Commands.FadeToView
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Duration | System.Single | Time for fade effect to complete Duration | System.Single | Time for fade effect to complete
@ -26,9 +30,13 @@ Target Camera | UnityEngine.Camera | Camera to use for the fade. Will use main c
## Fullscreen ## Fullscreen
Sets the application to fullscreen, windowed or toggles the current state. Sets the application to fullscreen, windowed or toggles the current state.
Defined in Fungus.Commands.Fullscreen
## Move To View ## Move To View
Moves the camera to a location specified by a View object. Moves the camera to a location specified by a View object.
Defined in Fungus.Commands.MoveToView
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Duration | System.Single | Time for move effect to complete Duration | System.Single | Time for move effect to complete
@ -39,6 +47,8 @@ Target Camera | UnityEngine.Camera | Camera to use for the pan. Will use main ca
## Shake Camera ## Shake Camera
Applies a camera shake effect to the main camera. Applies a camera shake effect to the main camera.
Defined in Fungus.Commands.ShakeCamera
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Duration | System.Single | Time for camera shake effect to complete Duration | System.Single | Time for camera shake effect to complete
@ -48,6 +58,8 @@ Wait Until Finished | System.Boolean | Wait until the shake effect has finished
## Start Swipe ## Start Swipe
Activates swipe panning mode where the player can pan the camera within the area between viewA & viewB. Activates swipe panning mode where the player can pan the camera within the area between viewA & viewB.
Defined in Fungus.Commands.StartSwipe
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
View A | Fungus.View | Defines one extreme of the scrollable area that the player can pan around View A | Fungus.View | Defines one extreme of the scrollable area that the player can pan around
@ -58,3 +70,5 @@ Target Camera | UnityEngine.Camera | Camera to use for the pan. Will use main ca
## Stop Swipe ## Stop Swipe
Deactivates swipe panning mode. Deactivates swipe panning mode.
Defined in Fungus.Commands.StopSwipe

6
Docs/command_ref/core_events.md

@ -2,11 +2,17 @@
## Flowchart Enabled ## Flowchart Enabled
The block will execute when the Flowchart game object is enabled. The block will execute when the Flowchart game object is enabled.
Defined in Fungus.EventHandlers.FlowchartEnabled
## Game Started ## Game Started
The block will execute when the game starts playing. The block will execute when the game starts playing.
Defined in Fungus.EventHandlers.GameStarted
## Message Received ## Message Received
The block will execute when the specified message is received from a Send Message command. The block will execute when the specified message is received from a Send Message command.
Defined in Fungus.EventHandlers.MessageReceived
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Message | System.String | Fungus message to listen for Message | System.String | Fungus message to listen for

34
Docs/command_ref/flow_commands.md

@ -2,9 +2,13 @@
## Break ## Break
Force a loop to terminate immediately. Force a loop to terminate immediately.
Defined in Fungus.Commands.Break
## Call ## Call
Execute another block in the same Flowchart as the command, or in a different Flowchart. Execute another block in the same Flowchart as the command, or in a different Flowchart.
Defined in Fungus.Commands.Call
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Flowchart | Fungus.Flowchart | Flowchart which contains the block to execute. If none is specified then the current Flowchart is used. Target Flowchart | Fungus.Flowchart | Flowchart which contains the block to execute. If none is specified then the current Flowchart is used.
@ -14,9 +18,13 @@ Call Mode | Fungus.Commands.CallMode | Select if the calling block should stop o
## Else ## Else
Marks the start of a command block to be executed when the preceding If statement is False. Marks the start of a command block to be executed when the preceding If statement is False.
Defined in Fungus.Commands.Else
## Else If ## Else If
Marks the start of a command block to be executed when the preceding If statement is False and the test expression is true. Marks the start of a command block to be executed when the preceding If statement is False and the test expression is true.
Defined in Fungus.Commands.ElseIf
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Variable | Fungus.Variable | Variable to use in expression Variable | Fungus.Variable | Variable to use in expression
@ -28,9 +36,13 @@ Compare Operator | Fungus.CompareOperator | The type of comparison to be perform
## End ## End
Marks the end of a conditional block. Marks the end of a conditional block.
Defined in Fungus.Commands.End
## If ## If
If the test expression is true, execute the following command block. If the test expression is true, execute the following command block.
Defined in Fungus.Commands.If
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Variable | Fungus.Variable | Variable to use in expression Variable | Fungus.Variable | Variable to use in expression
@ -43,6 +55,8 @@ Compare Operator | Fungus.CompareOperator | The type of comparison to be perform
## Jump ## Jump
Move execution to a specific Label command in the same block Move execution to a specific Label command in the same block
Defined in Fungus.Commands.Jump
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_target Label | Fungus.Variables.StringData | Name of a label in this block to jump to _target Label | Fungus.Variables.StringData | Name of a label in this block to jump to
@ -50,6 +64,8 @@ _target Label | Fungus.Variables.StringData | Name of a label in this block to j
## Label ## Label
Marks a position in the command list for execution to jump to. Marks a position in the command list for execution to jump to.
Defined in Fungus.Commands.Label
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Key | System.String | Display name for the label Key | System.String | Display name for the label
@ -57,6 +73,8 @@ Key | System.String | Display name for the label
## Load Scene ## Load Scene
Loads a new Unity scene and displays an optional loading image. This is useful for splitting a large game across multiple scene files to reduce peak memory usage. Previously loaded assets will be released before loading the scene to free up memory.The scene to be loaded must be added to the scene list in Build Settings. Loads a new Unity scene and displays an optional loading image. This is useful for splitting a large game across multiple scene files to reduce peak memory usage. Previously loaded assets will be released before loading the scene to free up memory.The scene to be loaded must be added to the scene list in Build Settings.
Defined in Fungus.Commands.LoadScene
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_scene Name | Fungus.Variables.StringData | Name of the scene to load. The scene must also be added to the build settings. _scene Name | Fungus.Variables.StringData | Name of the scene to load. The scene must also be added to the build settings.
@ -64,9 +82,13 @@ Loading Image | UnityEngine.Texture2D | Image to display while loading the scene
## Quit ## Quit
Quits the application. Does not work in Editor or Webplayer builds. Shouldn't generally be used on iOS. Quits the application. Does not work in Editor or Webplayer builds. Shouldn't generally be used on iOS.
Defined in Fungus.Commands.Quit
## Send Message ## Send Message
Sends a message to either the owner Flowchart or all Flowcharts in the scene. Blocks can listen for this message using a Message Received event handler. Sends a message to either the owner Flowchart or all Flowcharts in the scene. Blocks can listen for this message using a Message Received event handler.
Defined in Fungus.Commands.SendMessage
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Message Target | Fungus.Commands.MessageTarget | Target flowchart(s) to send the message to Message Target | Fungus.Commands.MessageTarget | Target flowchart(s) to send the message to
@ -74,9 +96,13 @@ _message | Fungus.Variables.StringData | Name of the message to send
## Stop ## Stop
Stop executing the Block that contains this command. Stop executing the Block that contains this command.
Defined in Fungus.Commands.Stop
## Stop Block ## Stop Block
Stops executing the named Block Stops executing the named Block
Defined in Fungus.Commands.StopBlock
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Flowchart | Fungus.Flowchart | Flowchart containing the Block. If none is specified, the parent Flowchart is used. Flowchart | Fungus.Flowchart | Flowchart containing the Block. If none is specified, the parent Flowchart is used.
@ -85,6 +111,8 @@ Block Name | Fungus.Variables.StringData | Name of the Block to stop
## Stop Flowchart ## Stop Flowchart
Stops execution of all Blocks in a Flowchart Stops execution of all Blocks in a Flowchart
Defined in Fungus.Commands.StopFlowchart
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Stop Parent Flowchart | System.Boolean | Stop all executing Blocks in the Flowchart that contains this command Stop Parent Flowchart | System.Boolean | Stop all executing Blocks in the Flowchart that contains this command
@ -93,6 +121,8 @@ Target Flowcharts | System.Collections.Generic.List`1[Fungus.Flowchart] | Stop a
## Wait ## Wait
Waits for period of time before executing the next command in the block. Waits for period of time before executing the next command in the block.
Defined in Fungus.Commands.Wait
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_duration | Fungus.Variables.FloatData | Duration to wait for _duration | Fungus.Variables.FloatData | Duration to wait for
@ -100,6 +130,8 @@ _duration | Fungus.Variables.FloatData | Duration to wait for
## WaitInput ## WaitInput
Waits for a period of time or for player input before executing the next command in the block. Waits for a period of time or for player input before executing the next command in the block.
Defined in WaitInput
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Duration | System.Single | Duration to wait for. If negative will wait until player input occurs. Duration | System.Single | Duration to wait for. If negative will wait until player input occurs.
@ -107,6 +139,8 @@ Duration | System.Single | Duration to wait for. If negative will wait until pla
## While ## While
Continuously loop through a block of commands while the condition is true. Use the Break command to force the loop to terminate immediately. Continuously loop through a block of commands while the condition is true. Use the Break command to force the loop to terminate immediately.
Defined in Fungus.Commands.While
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Variable | Fungus.Variable | Variable to use in expression Variable | Fungus.Variable | Variable to use in expression

2
Docs/command_ref/input_events.md

@ -3,6 +3,8 @@
## Key Pressed ## Key Pressed
The block will execute when a key press event occurs. The block will execute when a key press event occurs.
Defined in Fungus.EventHandlers.KeyPressed
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Key Press Type | Fungus.EventHandlers.KeyPressType | The type of keypress to activate on Key Press Type | Fungus.EventHandlers.KeyPressType | The type of keypress to activate on

38
Docs/command_ref/itween_commands.md

@ -3,6 +3,8 @@
## Look From ## Look From
Instantly rotates a GameObject to look at the supplied Vector3 then returns it to it's starting rotation over time. Instantly rotates a GameObject to look at the supplied Vector3 then returns it to it's starting rotation over time.
Defined in Fungus.Commands.LookFrom
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_from Transform | Fungus.Variables.TransformData | Target transform that the GameObject will look at _from Transform | Fungus.Variables.TransformData | Target transform that the GameObject will look at
@ -19,6 +21,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Look To ## Look To
Rotates a GameObject to look at a supplied Transform or Vector3 over time. Rotates a GameObject to look at a supplied Transform or Vector3 over time.
Defined in Fungus.Commands.LookTo
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_to Transform | Fungus.Variables.TransformData | Target transform that the GameObject will look at _to Transform | Fungus.Variables.TransformData | Target transform that the GameObject will look at
@ -35,6 +39,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Move Add ## Move Add
Moves a game object by a specified offset over time. Moves a game object by a specified offset over time.
Defined in Fungus.Commands.MoveAdd
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_offset | Fungus.Variables.Vector3Data | A translation offset in space the GameObject will animate to _offset | Fungus.Variables.Vector3Data | A translation offset in space the GameObject will animate to
@ -50,6 +56,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Move From ## Move From
Moves a game object from a specified position back to its starting position over time. The position can be defined by a transform in another object (using To Transform) or by setting an absolute position (using To Position, if To Transform is set to None). Moves a game object from a specified position back to its starting position over time. The position can be defined by a transform in another object (using To Transform) or by setting an absolute position (using To Position, if To Transform is set to None).
Defined in Fungus.Commands.MoveFrom
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_from Transform | Fungus.Variables.TransformData | Target transform that the GameObject will move from _from Transform | Fungus.Variables.TransformData | Target transform that the GameObject will move from
@ -66,6 +74,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Move To ## Move To
Moves a game object to a specified position over time. The position can be defined by a transform in another object (using To Transform) or by setting an absolute position (using To Position, if To Transform is set to None). Moves a game object to a specified position over time. The position can be defined by a transform in another object (using To Transform) or by setting an absolute position (using To Position, if To Transform is set to None).
Defined in Fungus.Commands.MoveTo
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_to Transform | Fungus.Variables.TransformData | Target transform that the GameObject will move to _to Transform | Fungus.Variables.TransformData | Target transform that the GameObject will move to
@ -82,6 +92,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Punch Position ## Punch Position
Applies a jolt of force to a GameObject's position and wobbles it back to its initial position. Applies a jolt of force to a GameObject's position and wobbles it back to its initial position.
Defined in Fungus.Commands.PunchPosition
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_amount | Fungus.Variables.Vector3Data | A translation offset in space the GameObject will animate to _amount | Fungus.Variables.Vector3Data | A translation offset in space the GameObject will animate to
@ -97,6 +109,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Punch Rotation ## Punch Rotation
Applies a jolt of force to a GameObject's rotation and wobbles it back to its initial rotation. Applies a jolt of force to a GameObject's rotation and wobbles it back to its initial rotation.
Defined in Fungus.Commands.PunchRotation
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_amount | Fungus.Variables.Vector3Data | A rotation offset in space the GameObject will animate to _amount | Fungus.Variables.Vector3Data | A rotation offset in space the GameObject will animate to
@ -112,6 +126,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Punch Scale ## Punch Scale
Applies a jolt of force to a GameObject's scale and wobbles it back to its initial scale. Applies a jolt of force to a GameObject's scale and wobbles it back to its initial scale.
Defined in Fungus.Commands.PunchScale
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_amount | Fungus.Variables.Vector3Data | A scale offset in space the GameObject will animate to _amount | Fungus.Variables.Vector3Data | A scale offset in space the GameObject will animate to
@ -126,6 +142,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Rotate Add ## Rotate Add
Rotates a game object by the specified angles over time. Rotates a game object by the specified angles over time.
Defined in Fungus.Commands.RotateAdd
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_offset | Fungus.Variables.Vector3Data | A rotation offset in space the GameObject will animate to _offset | Fungus.Variables.Vector3Data | A rotation offset in space the GameObject will animate to
@ -141,6 +159,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Rotate From ## Rotate From
Rotates a game object from the specified angles back to its starting orientation over time. Rotates a game object from the specified angles back to its starting orientation over time.
Defined in Fungus.Commands.RotateFrom
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_from Transform | Fungus.Variables.TransformData | Target transform that the GameObject will rotate from _from Transform | Fungus.Variables.TransformData | Target transform that the GameObject will rotate from
@ -157,6 +177,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Rotate To ## Rotate To
Rotates a game object to the specified angles over time. Rotates a game object to the specified angles over time.
Defined in Fungus.Commands.RotateTo
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_to Transform | Fungus.Variables.TransformData | Target transform that the GameObject will rotate to _to Transform | Fungus.Variables.TransformData | Target transform that the GameObject will rotate to
@ -173,6 +195,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Scale Add ## Scale Add
Changes a game object's scale by a specified offset over time. Changes a game object's scale by a specified offset over time.
Defined in Fungus.Commands.ScaleAdd
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_offset | Fungus.Variables.Vector3Data | A scale offset in space the GameObject will animate to _offset | Fungus.Variables.Vector3Data | A scale offset in space the GameObject will animate to
@ -187,6 +211,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Scale From ## Scale From
Changes a game object's scale to the specified value and back to its original scale over time. Changes a game object's scale to the specified value and back to its original scale over time.
Defined in Fungus.Commands.ScaleFrom
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_from Transform | Fungus.Variables.TransformData | Target transform that the GameObject will scale from _from Transform | Fungus.Variables.TransformData | Target transform that the GameObject will scale from
@ -202,6 +228,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Scale To ## Scale To
Changes a game object's scale to a specified value over time. Changes a game object's scale to a specified value over time.
Defined in Fungus.Commands.ScaleTo
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_to Transform | Fungus.Variables.TransformData | Target transform that the GameObject will scale to _to Transform | Fungus.Variables.TransformData | Target transform that the GameObject will scale to
@ -217,6 +245,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Shake Position ## Shake Position
Randomly shakes a GameObject's position by a diminishing amount over time. Randomly shakes a GameObject's position by a diminishing amount over time.
Defined in Fungus.Commands.ShakePosition
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_amount | Fungus.Variables.Vector3Data | A translation offset in space the GameObject will animate to _amount | Fungus.Variables.Vector3Data | A translation offset in space the GameObject will animate to
@ -233,6 +263,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Shake Rotation ## Shake Rotation
Randomly shakes a GameObject's rotation by a diminishing amount over time. Randomly shakes a GameObject's rotation by a diminishing amount over time.
Defined in Fungus.Commands.ShakeRotation
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_amount | Fungus.Variables.Vector3Data | A rotation offset in space the GameObject will animate to _amount | Fungus.Variables.Vector3Data | A rotation offset in space the GameObject will animate to
@ -248,6 +280,8 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Shake Scale ## Shake Scale
Randomly shakes a GameObject's rotation by a diminishing amount over time. Randomly shakes a GameObject's rotation by a diminishing amount over time.
Defined in Fungus.Commands.ShakeScale
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_amount | Fungus.Variables.Vector3Data | A scale offset in space the GameObject will animate to _amount | Fungus.Variables.Vector3Data | A scale offset in space the GameObject will animate to
@ -262,9 +296,13 @@ Wait Until Finished | System.Boolean | Wait until the tween has finished before
## Stop Tween ## Stop Tween
Stops an active iTween by name. Stops an active iTween by name.
Defined in Fungus.Commands.StopTween
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_tween Name | Fungus.Variables.StringData | Stop and destroy any Tweens in current scene with the supplied name _tween Name | Fungus.Variables.StringData | Stop and destroy any Tweens in current scene with the supplied name
## Stop Tweens ## Stop Tweens
Stop all active iTweens in the current scene. Stop all active iTweens in the current scene.
Defined in Fungus.Commands.StopTweens

20
Docs/command_ref/narrative_commands.md

@ -3,6 +3,8 @@
## Clear Menu ## Clear Menu
Clears the options from a menu dialogue Clears the options from a menu dialogue
Defined in Fungus.Commands.ClearMenu
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Menu Dialog | Fungus.MenuDialog | Menu Dialog to clear the options on Menu Dialog | Fungus.MenuDialog | Menu Dialog to clear the options on
@ -10,6 +12,8 @@ Menu Dialog | Fungus.MenuDialog | Menu Dialog to clear the options on
## Control Stage ## Control Stage
Controls the stage on which character portraits are displayed. Controls the stage on which character portraits are displayed.
Defined in Fungus.Commands.ControlStage
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Stage | Fungus.Stage | Stage to display characters on Stage | Fungus.Stage | Stage to display characters on
@ -21,9 +25,13 @@ Display | Fungus.Commands.StageDisplayType | Display type
## Conversation ## Conversation
Do multiple say and portrait commands in a single block of text. Format is: [character] [portrait] [stage position] [: Story text] Do multiple say and portrait commands in a single block of text. Format is: [character] [portrait] [stage position] [: Story text]
Defined in Fungus.Commands.Conversation
## Menu ## Menu
Displays a button in a multiple choice menu Displays a button in a multiple choice menu
Defined in Fungus.Commands.Menu
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Text | System.String | Text to display on the menu button Text | System.String | Text to display on the menu button
@ -36,6 +44,8 @@ Set Menu Dialog | Fungus.MenuDialog | A custom Menu Dialog to use to display thi
## Menu Timer ## Menu Timer
Displays a timer bar and executes a target block if the player fails to select a menu option in time. Displays a timer bar and executes a target block if the player fails to select a menu option in time.
Defined in Fungus.Commands.MenuTimer
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_duration | Fungus.Variables.FloatData | Length of time to display the timer for _duration | Fungus.Variables.FloatData | Length of time to display the timer for
@ -44,6 +54,8 @@ Target Block | Fungus.Block | Block to execute when the timer expires
## Portrait ## Portrait
Controls a character portrait. Controls a character portrait.
Defined in Fungus.Commands.Portrait
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Stage | Fungus.Stage | Stage to display portrait on Stage | Fungus.Stage | Stage to display portrait on
@ -66,6 +78,8 @@ Display | Fungus.DisplayType | Display type
## Say ## Say
Writes text in a dialog box. Writes text in a dialog box.
Defined in Fungus.Commands.Say
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Description | System.String | Notes about this story text for other authors, localization, etc. Description | System.String | Notes about this story text for other authors, localization, etc.
@ -83,6 +97,8 @@ Set Say Dialog | Fungus.SayDialog | Sets the active Say dialog with a reference
## Set Language ## Set Language
Set the active language for the scene. A Localization object with a localization file must be present in the scene. Set the active language for the scene. A Localization object with a localization file must be present in the scene.
Defined in Fungus.Commands.SetLanguage
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_language Code | Fungus.Variables.StringData | Code of the language to set. e.g. ES, DE, JA _language Code | Fungus.Variables.StringData | Code of the language to set. e.g. ES, DE, JA
@ -90,6 +106,8 @@ _language Code | Fungus.Variables.StringData | Code of the language to set. e.g.
## Set Menu Dialog ## Set Menu Dialog
Sets a custom menu dialog to use when displaying multiple choice menus Sets a custom menu dialog to use when displaying multiple choice menus
Defined in Fungus.Commands.SetMenuDialog
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Menu Dialog | Fungus.MenuDialog | The Menu Dialog to use for displaying menu buttons Menu Dialog | Fungus.MenuDialog | The Menu Dialog to use for displaying menu buttons
@ -97,6 +115,8 @@ Menu Dialog | Fungus.MenuDialog | The Menu Dialog to use for displaying menu but
## Set Say Dialog ## Set Say Dialog
Sets a custom say dialog to use when displaying story text Sets a custom say dialog to use when displaying story text
Defined in Fungus.Commands.SetSayDialog
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Say Dialog | Fungus.SayDialog | The Say Dialog to use for displaying Say story text Say Dialog | Fungus.SayDialog | The Say Dialog to use for displaying Say story text

20
Docs/command_ref/scripting_commands.md

@ -3,6 +3,8 @@
## Comment ## Comment
Use comments to record design notes and reminders about your game. Use comments to record design notes and reminders about your game.
Defined in Fungus.Commands.Comment
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Commenter Name | System.String | Name of Commenter Commenter Name | System.String | Name of Commenter
@ -11,6 +13,8 @@ Comment Text | System.String | Text to display for this comment
## Call Method ## Call Method
Calls a named method on a GameObject using the GameObject.SendMessage() system. Calls a named method on a GameObject using the GameObject.SendMessage() system.
Defined in Fungus.Commands.CallMethod
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Object | UnityEngine.GameObject | Target monobehavior which contains the method we want to call Target Object | UnityEngine.GameObject | Target monobehavior which contains the method we want to call
@ -20,6 +24,8 @@ Delay | System.Single | Delay (in seconds) before the method will be called
## Debug Log ## Debug Log
Writes a log message to the debug console. Writes a log message to the debug console.
Defined in Fungus.Commands.DebugLog
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Log Type | Fungus.Commands.DebugLogType | Display type of debug log info Log Type | Fungus.Commands.DebugLogType | Display type of debug log info
@ -28,6 +34,8 @@ Log Message | Fungus.Variables.StringDataMulti | Text to write to the debug log.
## Destroy ## Destroy
Destroys a specified game object in the scene. Destroys a specified game object in the scene.
Defined in Fungus.Commands.Destroy
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_target Game Object | Fungus.Variables.GameObjectData | Reference to game object to destroy _target Game Object | Fungus.Variables.GameObjectData | Reference to game object to destroy
@ -35,6 +43,8 @@ _target Game Object | Fungus.Variables.GameObjectData | Reference to game object
## Execute Lua ## Execute Lua
Executes a Lua code chunk using a Lua Environment. Executes a Lua code chunk using a Lua Environment.
Defined in Fungus.Commands.ExecuteLua
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Lua Environment | Fungus.LuaEnvironment | Lua Environment to use to execute this Lua script Lua Environment | Fungus.LuaEnvironment | Lua Environment to use to execute this Lua script
@ -47,6 +57,8 @@ Return Variable | Fungus.Variable | A Flowchart variable to store the returned v
## Invoke Event ## Invoke Event
Calls a list of component methods via the Unity Event System (as used in the Unity UI). This command is more efficient than the Invoke Method command but can only pass a single parameter and doesn't support return values. Calls a list of component methods via the Unity Event System (as used in the Unity UI). This command is more efficient than the Invoke Method command but can only pass a single parameter and doesn't support return values.
Defined in Fungus.Commands.InvokeEvent
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Delay | System.Single | Delay (in seconds) before the methods will be called Delay | System.Single | Delay (in seconds) before the methods will be called
@ -63,6 +75,8 @@ String Event | Fungus.Commands.InvokeEvent+StringEvent | List of methods to call
## Invoke Method ## Invoke Method
Invokes a method of a component via reflection. Supports passing multiple parameters and storing returned values in a Fungus variable. Invokes a method of a component via reflection. Supports passing multiple parameters and storing returned values in a Fungus variable.
Defined in Fungus.Commands.InvokeMethod
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Object | UnityEngine.GameObject | GameObject containing the component method to be invoked Target Object | UnityEngine.GameObject | GameObject containing the component method to be invoked
@ -81,6 +95,8 @@ Call Mode | Fungus.Commands.CallMode | The coroutine call behavior for methods t
## Open URL ## Open URL
Opens the specified URL in the browser. Opens the specified URL in the browser.
Defined in Fungus.Commands.LinkToWebsite
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Url | Fungus.Variables.StringData | URL to open in the browser Url | Fungus.Variables.StringData | URL to open in the browser
@ -88,6 +104,8 @@ Url | Fungus.Variables.StringData | URL to open in the browser
## Set Active ## Set Active
Sets a game object in the scene to be active / inactive. Sets a game object in the scene to be active / inactive.
Defined in Fungus.Commands.SetActive
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_target Game Object | Fungus.Variables.GameObjectData | Reference to game object to enable / disable _target Game Object | Fungus.Variables.GameObjectData | Reference to game object to enable / disable
@ -96,6 +114,8 @@ Active State | Fungus.Variables.BooleanData | Set to true to enable the game obj
## Spawn Object ## Spawn Object
Spawns a new object based on a reference to a scene or prefab game object. Spawns a new object based on a reference to a scene or prefab game object.
Defined in Fungus.Commands.SpawnObject
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
_source Object | Fungus.Variables.GameObjectData | Game object to copy when spawning. Can be a scene object or a prefab. _source Object | Fungus.Variables.GameObjectData | Game object to copy when spawning. Can be a scene object or a prefab.

16
Docs/command_ref/sprite_commands.md

@ -3,6 +3,8 @@
## Fade Sprite ## Fade Sprite
Fades a sprite to a target color over a period of time. Fades a sprite to a target color over a period of time.
Defined in Fungus.Commands.FadeSprite
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Sprite Renderer | UnityEngine.SpriteRenderer | Sprite object to be faded Sprite Renderer | UnityEngine.SpriteRenderer | Sprite object to be faded
@ -13,6 +15,8 @@ Wait Until Finished | System.Boolean | Wait until the fade has finished before e
## Set Clickable 2D ## Set Clickable 2D
Sets a Clickable2D component to be clickable / non-clickable. Sets a Clickable2D component to be clickable / non-clickable.
Defined in Fungus.Commands.SetClickable2D
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Clickable2 D | Fungus.Clickable2D | Reference to Clickable2D component on a gameobject Target Clickable2 D | Fungus.Clickable2D | Reference to Clickable2D component on a gameobject
@ -21,6 +25,8 @@ Active State | Fungus.Variables.BooleanData | Set to true to enable the componen
## Set Collider ## Set Collider
Sets all collider (2d or 3d) components on the target objects to be active / inactive Sets all collider (2d or 3d) components on the target objects to be active / inactive
Defined in Fungus.Commands.SetCollider
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Objects | System.Collections.Generic.List`1[UnityEngine.GameObject] | A list of gameobjects containing collider components to be set active / inactive Target Objects | System.Collections.Generic.List`1[UnityEngine.GameObject] | A list of gameobjects containing collider components to be set active / inactive
@ -30,6 +36,8 @@ Active State | Fungus.Variables.BooleanData | Set to true to enable the collider
## Set Draggable 2D ## Set Draggable 2D
Sets a Draggable2D component to be draggable / non-draggable. Sets a Draggable2D component to be draggable / non-draggable.
Defined in Fungus.Commands.SetDraggable2D
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Draggable2 D | Fungus.Draggable2D | Reference to Draggable2D component on a gameobject Target Draggable2 D | Fungus.Draggable2D | Reference to Draggable2D component on a gameobject
@ -38,6 +46,8 @@ Active State | Fungus.Variables.BooleanData | Set to true to enable the componen
## Set Mouse Cursor ## Set Mouse Cursor
Sets the mouse cursor sprite. Sets the mouse cursor sprite.
Defined in Fungus.Commands.SetMouseCursor
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Cursor Texture | UnityEngine.Texture2D | Texture to use for cursor. Will use default mouse cursor if no sprite is specified Cursor Texture | UnityEngine.Texture2D | Texture to use for cursor. Will use default mouse cursor if no sprite is specified
@ -46,6 +56,8 @@ Hot Spot | UnityEngine.Vector2 | The offset from the top left of the texture to
## Set Sorting Layer ## Set Sorting Layer
Sets the Renderer sorting layer of every child of a game object. Applies to all Renderers (including mesh, skinned mesh, and sprite). Sets the Renderer sorting layer of every child of a game object. Applies to all Renderers (including mesh, skinned mesh, and sprite).
Defined in Fungus.Commands.SetSortingLayer
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Object | UnityEngine.GameObject | Root Object that will have the Sorting Layer set. Any children will also be affected Target Object | UnityEngine.GameObject | Root Object that will have the Sorting Layer set. Any children will also be affected
@ -54,6 +66,8 @@ Sorting Layer | System.String | The New Layer Name to apply
## Set Sprite Order ## Set Sprite Order
Controls the render order of sprites by setting the Order In Layer property of a list of sprites. Controls the render order of sprites by setting the Order In Layer property of a list of sprites.
Defined in Fungus.Commands.SetSpriteOrder
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Sprites | System.Collections.Generic.List`1[UnityEngine.SpriteRenderer] | List of sprites to set the order in layer property on Target Sprites | System.Collections.Generic.List`1[UnityEngine.SpriteRenderer] | List of sprites to set the order in layer property on
@ -62,6 +76,8 @@ Order In Layer | Fungus.Variables.IntegerData | The order in layer value to set
## Show Sprite ## Show Sprite
Makes a sprite visible / invisible by setting the color alpha. Makes a sprite visible / invisible by setting the color alpha.
Defined in Fungus.Commands.ShowSprite
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Sprite Renderer | UnityEngine.SpriteRenderer | Sprite object to be made visible / invisible Sprite Renderer | UnityEngine.SpriteRenderer | Sprite object to be made visible / invisible

12
Docs/command_ref/sprite_events.md

@ -3,6 +3,8 @@
## Drag Cancelled ## Drag Cancelled
The block will execute when the player drags an object and releases it without dropping it on a target object. The block will execute when the player drags an object and releases it without dropping it on a target object.
Defined in Fungus.EventHandlers.DragCancelled
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on
@ -10,6 +12,8 @@ Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag even
## Drag Completed ## Drag Completed
The block will execute when the player drags an object and successfully drops it on a target object. The block will execute when the player drags an object and successfully drops it on a target object.
Defined in Fungus.EventHandlers.DragCompleted
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on
@ -18,6 +22,8 @@ Target Object | UnityEngine.Collider2D | Drag target object to listen for drag e
## Drag Entered ## Drag Entered
The block will execute when the player is dragging an object which starts touching the target object. The block will execute when the player is dragging an object which starts touching the target object.
Defined in Fungus.EventHandlers.DragEntered
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on
@ -26,6 +32,8 @@ Target Object | UnityEngine.Collider2D | Drag target object to listen for drag e
## Drag Exited ## Drag Exited
The block will execute when the player is dragging an object which stops touching the target object. The block will execute when the player is dragging an object which stops touching the target object.
Defined in Fungus.EventHandlers.DragExited
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on Draggable Object | Fungus.Draggable2D | Draggable object to listen for drag events on
@ -33,9 +41,13 @@ Target Object | UnityEngine.Collider2D | Drag target object to listen for drag e
## Drag Started ## Drag Started
The block will execute when the player starts dragging an object. The block will execute when the player starts dragging an object.
Defined in Fungus.EventHandlers.DragStarted
## Object Clicked ## Object Clicked
The block will execute when the user clicks or taps on the clickable object. The block will execute when the user clicks or taps on the clickable object.
Defined in Fungus.EventHandlers.ObjectClicked
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Clickable Object | Fungus.Clickable2D | Object that the user can click or tap on Clickable Object | Fungus.Clickable2D | Object that the user can click or tap on

6
Docs/command_ref/tests_commands.md

@ -2,7 +2,13 @@
## Fail ## Fail
Fails the current integration test Fails the current integration test
Defined in Fungus.FailTest
## Pass ## Pass
Passes the current integration test Passes the current integration test
Defined in Fungus.PassTest
## TestNarrative ## TestNarrative
Test command for narrative integration tests Test command for narrative integration tests
Defined in NarrativeTests

12
Docs/command_ref/ui_commands.md

@ -3,6 +3,8 @@
## Fade UI ## Fade UI
Fades a UI object Fades a UI object
Defined in Fungus.Commands.FadeUI
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Objects | System.Collections.Generic.List`1[UnityEngine.GameObject] | List of objects to be affected by the tween Target Objects | System.Collections.Generic.List`1[UnityEngine.GameObject] | List of objects to be affected by the tween
@ -13,6 +15,8 @@ Duration | Fungus.Variables.FloatData | Time for the tween to complete
## Get Text ## Get Text
Gets the text property from a UI Text object and stores it in a string variable. Gets the text property from a UI Text object and stores it in a string variable.
Defined in Fungus.Commands.GetText
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Text Object | UnityEngine.GameObject | Text object to get text value from Target Text Object | UnityEngine.GameObject | Text object to get text value from
@ -21,6 +25,8 @@ String Variable | Fungus.Variables.StringVariable | String variable to store the
## Set Interactable ## Set Interactable
Set the interactable sate of selectable objects. Set the interactable sate of selectable objects.
Defined in Fungus.Commands.SetInteractable
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Objects | System.Collections.Generic.List`1[UnityEngine.GameObject] | List of objects to be affected by the command Target Objects | System.Collections.Generic.List`1[UnityEngine.GameObject] | List of objects to be affected by the command
@ -29,6 +35,8 @@ Interactable State | Fungus.Variables.BooleanData | Controls if the selectable U
## Set Slider Value ## Set Slider Value
Sets the value property of a slider object Sets the value property of a slider object
Defined in Fungus.Commands.SetSliderValue
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Slider | UnityEngine.UI.Slider | Target slider object to set the value on Slider | UnityEngine.UI.Slider | Target slider object to set the value on
@ -37,6 +45,8 @@ Value | Fungus.Variables.FloatData | Float value to set the slider value to.
## Set Text ## Set Text
Sets the text property on a UI Text object and/or an Input Field object. Sets the text property on a UI Text object and/or an Input Field object.
Defined in Fungus.Commands.SetText
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Text Object | UnityEngine.GameObject | Text object to set text on. Can be a UI Text, Text Field or Text Mesh object. Target Text Object | UnityEngine.GameObject | Text object to set text on. Can be a UI Text, Text Field or Text Mesh object.
@ -46,6 +56,8 @@ Description | System.String | Notes about this story text for other authors, loc
## Write ## Write
Writes content to a UI Text or Text Mesh object. Writes content to a UI Text or Text Mesh object.
Defined in Fungus.Commands.Write
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Text Object | UnityEngine.GameObject | Text object to set text on. Text, Input Field and Text Mesh objects are supported. Text Object | UnityEngine.GameObject | Text object to set text on. Text, Input Field and Text Mesh objects are supported.

4
Docs/command_ref/ui_events.md

@ -3,6 +3,8 @@
## Button Clicked ## Button Clicked
The block will execute when the user clicks on the target UI button object. The block will execute when the user clicks on the target UI button object.
Defined in Fungus.EventHandlers.ButtonClicked
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Button | UnityEngine.UI.Button | The UI Button that the user can click on Target Button | UnityEngine.UI.Button | The UI Button that the user can click on
@ -10,6 +12,8 @@ Target Button | UnityEngine.UI.Button | The UI Button that the user can click on
## End Edit ## End Edit
The block will execute when the user finishes editing the text in the input field. The block will execute when the user finishes editing the text in the input field.
Defined in Fungus.EventHandlers.EndEdit
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Target Input Field | UnityEngine.UI.InputField | The UI Input Field that the user can enter text into Target Input Field | UnityEngine.UI.InputField | The UI Input Field that the user can enter text into

18
Docs/command_ref/variable_commands.md

@ -3,6 +3,8 @@
## Delete Save Key ## Delete Save Key
Deletes a saved value from permanent storage. Deletes a saved value from permanent storage.
Defined in Fungus.Commands.DeleteSaveKey
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Key | System.String | Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber} Key | System.String | Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber}
@ -10,6 +12,8 @@ Key | System.String | Name of the saved value. Supports variable substition e.g.
## Load Variable ## Load Variable
Loads a saved value and stores it in a Boolean, Integer, Float or String variable. If the key is not found then the variable is not modified. Loads a saved value and stores it in a Boolean, Integer, Float or String variable. If the key is not found then the variable is not modified.
Defined in Fungus.Commands.LoadVariable
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Key | System.String | Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber}" Key | System.String | Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber}"
@ -18,6 +22,8 @@ Variable | Fungus.Variable | Variable to store the value in.
## Random Float ## Random Float
Sets an float variable to a random value in the defined range. Sets an float variable to a random value in the defined range.
Defined in Fungus.Commands.RandomFloat
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Variable | Fungus.Variables.FloatVariable | The variable whos value will be set Variable | Fungus.Variables.FloatVariable | The variable whos value will be set
@ -27,6 +33,8 @@ Max Value | Fungus.Variables.FloatData | Maximum value for random range
## Random Integer ## Random Integer
Sets an integer variable to a random value in the defined range. Sets an integer variable to a random value in the defined range.
Defined in Fungus.Commands.RandomInteger
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Variable | Fungus.Variables.IntegerVariable | The variable whos value will be set Variable | Fungus.Variables.IntegerVariable | The variable whos value will be set
@ -36,6 +44,8 @@ Max Value | Fungus.Variables.IntegerData | Maximum value for random range
## Read Text File ## Read Text File
Reads in a text file and stores the contents in a string variable Reads in a text file and stores the contents in a string variable
Defined in Fungus.Commands.ReadTextFile
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Text File | UnityEngine.TextAsset | Text file to read into the string variable Text File | UnityEngine.TextAsset | Text file to read into the string variable
@ -44,6 +54,8 @@ String Variable | Fungus.Variables.StringVariable | String variable to store the
## Reset ## Reset
Resets the state of all commands and variables in the Flowchart. Resets the state of all commands and variables in the Flowchart.
Defined in Fungus.Commands.Reset
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Reset Commands | System.Boolean | Reset state of all commands in the script Reset Commands | System.Boolean | Reset state of all commands in the script
@ -52,6 +64,8 @@ Reset Variables | System.Boolean | Reset variables back to their default values
## Save Variable ## Save Variable
Save an Boolean, Integer, Float or String variable to persistent storage using a string key. The value can be loaded again later using the Load Variable command. You can also use the Set Save Profile command to manage separate save profiles for multiple players. Save an Boolean, Integer, Float or String variable to persistent storage using a string key. The value can be loaded again later using the Load Variable command. You can also use the Set Save Profile command to manage separate save profiles for multiple players.
Defined in Fungus.Commands.SaveVariable
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Key | System.String | Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber} Key | System.String | Name of the saved value. Supports variable substition e.g. "player_{$PlayerNumber}
@ -60,6 +74,8 @@ Variable | Fungus.Variable | Variable to read the value from. Only Boolean, Inte
## Set Save Profile ## Set Save Profile
Sets the active profile that the Save Variable and Load Variable commands will use. This is useful to crete multiple player save games. Once set, the profile applies across all Flowcharts and will also persist across scene loads. Sets the active profile that the Save Variable and Load Variable commands will use. This is useful to crete multiple player save games. Once set, the profile applies across all Flowcharts and will also persist across scene loads.
Defined in Fungus.Commands.SetSaveProfile
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Save Profile Name | System.String | Name of save profile to make active. Save Profile Name | System.String | Name of save profile to make active.
@ -67,6 +83,8 @@ Save Profile Name | System.String | Name of save profile to make active.
## Set Variable ## Set Variable
Sets a Boolean, Integer, Float or String variable to a new value using a simple arithmetic operation. The value can be a constant or reference another variable of the same type. Sets a Boolean, Integer, Float or String variable to a new value using a simple arithmetic operation. The value can be a constant or reference another variable of the same type.
Defined in Fungus.Commands.SetVariable
Property | Type | Description Property | Type | Description
--- | --- | --- --- | --- | ---
Variable | Fungus.Variable | The variable whos value will be set Variable | Fungus.Variable | The variable whos value will be set

Loading…
Cancel
Save