Parasol Framework
  • Gallery
  • API
  • Wiki
  • GitHub
    •  Overview
    • SetVariable()
    • Audio
    • Core
    • Display
    • Fluid
    • Font
    • Network
    • Regex
    • Vector
    • XML
    • XPath
      • Audio
      • Sound
      • File
      • MetaClass
      • Module
      • StorageDevice
      • Task
      • Thread
      • Time
      • Compression
      • CompressedStream
      • Config
      • Script
      • XML
      • XQuery
      • 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
      • NetClient
      • NetLookup
      • 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

Fluid is a customised scripting language for the Script class.

Functions

SetVariable

Constants

JOF

SetVariable()

Sets any variable in a loaded Fluid script.

ERR fl::SetVariable(objScript * 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_INT, FD_DOUBLE, FD_INT64.
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

JOF Type

JIT behaviour options

NameDescription
JOF::DIAGNOSECancels aborting on error so that the full script is parsed. Enables deeper log tracing.
JOF::DUMP_BYTECODEPrint a disassembly of bytecode instructions after parsing.
JOF::PROFILEUse timers to profile JIT parsing. Required to configure run-time profiling.
JOF::TRACESynonym for TRACE_TOKENS | TRACE_EXPECT | TRACE_BOUNDARY | TRACE_OPERATORS | TRACE_REGISTERS | TRACE_CFG | TRACE_ASSIGNMENTS | TRACE_VALUE_CATEGORY
JOF::TRACE_ASSIGNMENTSTrace PreparedAssignment lifecycle and hazard handling.
JOF::TRACE_BOUNDARYEnable log messages for AST boundary crossing.
JOF::TRACE_CFGTrace ControlFlowGraph edge creation and patching.
JOF::TRACE_EXPECTEnable trace expectation messages during parsing.
JOF::TRACE_OPERATORSTrace OperatorEmitter method calls and decisions.
JOF::TRACE_REGISTERSTrace RegisterAllocator reservations and releases.
JOF::TRACE_TOKENSTrace the emission of tokens.
JOF::TRACE_VALUE_CATEGORYTrace ValueUse/ValueSlot/LValue operations.
Fluid module documentation © Paul Manias © 2006-2025