Parasol Framework
  • Gallery
  • API
  • Wiki
  • GitHub
    •  Overview
    • SetVariable()
    • Audio
    • Core
    • Display
    • Fluid
    • Font
    • Network
    • Vector
      • Audio
      • Sound
      • File
      • MetaClass
      • Module
      • StorageDevice
      • Task
      • Thread
      • Time
      • Compression
      • Config
      • Script
      • XML
      • Controller
      • BlurFX
      • ColourFX
      • CompositeFX
      • ConvolveFX
      • DisplacementFX
      • FilterEffect
      • FloodFX
      • ImageFX
      • LightingFX
      • MergeFX
      • MorphologyFX
      • OffsetFX
      • RemapFX
      • SourceFX
      • TurbulenceFX
      • WaveFunctionFX
      • Scintilla
      • ScintillaSearch
      • Bitmap
      • Clipboard
      • Display
      • Document
      • Font
      • Picture
      • Pointer
      • Surface
      • SVG
      • ClientSocket
      • HTTP
      • NetSocket
      • Proxy
      • Vector
      • VectorClip
      • VectorColour
      • VectorEllipse
      • VectorFilter
      • VectorGradient
      • VectorGroup
      • VectorImage
      • VectorPath
      • VectorPattern
      • VectorPolygon
      • VectorRectangle
      • VectorScene
      • VectorShape
      • VectorSpiral
      • VectorText
      • VectorTransition
      • VectorViewport
      • VectorWave
      • Linux Builds
      • Windows Builds
      • Customising Your Build
      • Parasol Objects
      • Parasol In Depth
      • Fluid Reference Manual
      • Common API
      • FileSearch API
      • GUI API
      • JSON API
      • VFX API
      • Widgets
      • RIPL Reference Manual
      • Parasol Cmd Tool
      • Flute / Unit Testing
      • Embedded Document Format
      • FDL Reference Manual
      • FDL Tools
      • Action Reference Manual
      • System Error Codes

Fluid Module

Functions

SetVariable

SetVariable()

Sets any variable in a loaded Fluid script.

ERR fl::SetVariable(OBJECTPTR Script, CSTRING Name, INT Type, ...)
ParameterDescription
ScriptPointer to a Fluid script.
NameThe name of the variable to set.
TypeA valid field type must be indicated, e.g. FD_STRING, FD_POINTER, FD_LONG, FD_DOUBLE, FD_LARGE.
VariableA variable that matches the indicated Type.

The SetVariable() function provides a method for setting global variables in a Fluid script prior to execution of that script. If the script is cached, the variable settings will be available on the next activation.

Error Codes

OkayThe variable was defined successfully.
ArgsInvalid arguments passed to function.
ObjectCorruptPrivately maintained memory has become inaccessible.
FieldTypeMismatchA valid field type was not specified in the Type parameter.
Fluid module documentation © Paul Manias © 2006-2025