FlexScript Class Reference
The following table lists all object types that are available in FlexScript.
Agent | Provides access to data and methods related to Agents who are members of an Agent System. |
Agent.SocialForceState | Provides access to data and methods related to an agent's social force state. |
Agent.System | Provides access to data and methods related to a System of an Agents. |
AGV | Provides access to data and methods related to AGV travel. |
AGV.AllocatableObject | An object that can be allocated by an AGV. |
AGV.AllocationPoint | A structure containing information about a planned AGV allocation. |
AGV.BodyOffset | Enumerates possible AGV body offset values |
AGV.Connections | An interface for accessing AGV control point connections. |
AGV.Request | An enumeration of values to be returned by an AGV.AllocatableObject's OnRequest trigger. |
AGV.RequestState | An enumeration of possible values for the AGV.AllocationPoint.requestState property. |
AGV.RoutingConstraint | Enumerates possible routing constraint values used in AGV.AllocatableObject.routingConstraint |
AGV.Trailer | Provides access to data and methods related a trailer attached to an AGV. |
AGV.TravelPathSection | A structure representing a traversal of a specific section of path during an AGV's travel operation. |
AGV.TraversalPoint | A structure containing information about a planned AGV 'traversal'. |
Animation | A class that represents an object animation. |
Array | A dynamic array of Variants. |
AStar | Provides access to data related to the A* module. |
AStar.Allocation | Provides access to data and methods associated with an A* grid cell allocation. |
AStar.Cell | Provides access to data and methods associated with an A* grid cell. |
AStar.Direction | An enumeration of integer values associated with four A* travel directions. |
AStar.Navigator | Provides access to data and methods related to a model's A* navigator. |
AStar.Traveler | Provides access to data and methods related to an A* traveler. |
Color | A class containing rgba values for an object's color. |
Conveyor | A class that provides properties and methods for monitoring and controlling a conveyor. |
Conveyor.DecisionPoint | A class that provides properties for monitoring a conveyor decision point, photo eye, or station. |
Conveyor.Item | A class that provides properties and methods for monitoring and controlling an item on a conveyor. |
Conveyor.MergeController | Allows access to the lanes of a MergeController object |
Conveyor.Motor | A class that provides properties and methods for controlling a conveyor motor. |
Conveyor.SlugBuilder | Accesses data dealing with a conveyor's slug building state |
Coroutine | An opaque class representing a paused coroutine. |
Database.Connection | A class for connecting to and querying a database. |
Database.DataType | A class that enumerates various database storage types. |
Database.PreparedStatement | A class for execution and manipulation of a database SQL statement. |
Database.ResultSet | A class for retrieving the result of a database SQL query. |
DateTime | A class containing functions for getting and manipulating dates and times. |
Delay | An opaque awaitable type, specifically used in coroutines, representing an abstract delay time. |
Dispatcher | A class that represents an Object with a task sequence queue, and implements logic to receive and dispatch TaskSequences. |
double | A number type that represents a wide, dynamic range of values by using a floating point. |
ElevatorBank | A class that represents a bank of elevators. |
ElevatorBank.Elevator | A class that represents an elevator member of an ElevatorBank. |
ElevatorBank.Request | A class that represents a request for an ElevatorBank.Elevator. |
Empirical | A class that represents an Empirical Distribution. |
Emulation | A class that provides properties for reading from the Emulation object. |
Emulation.Connection | A class that provides properties for reading from a Emulation Connection. |
Emulation.Variable | A class that allows you to read and write from a Emulation variable. |
Event | An opaque awaitable type, specifically used in coroutines, representing an event owned by a specific object, that can be 'awaited', or listened to. |
Group | A class for grouping objects. |
Http.Method | An enumeration of integer values representing Http Request Methods. |
Http.Request | A class for creating a Http Request. |
Http.Response | A class representing the Response to a Http Request. |
int | A number type that holds a finite range of integers. Min Value = -2147483647 Max Value = 2147483647 |
JSON | A class containing common JSON functions. |
lambda | Allows an expression to be passed in as a parameter without immediatly being evaulated. |
List | A class that represents a list. |
List.BackOrder | A class that represents a list back order. |
List.Entry | A class that represents a list entry. |
List.PullResult | A class that represents the result of a call to List.pull(). |
List.PushResult | A class that represents the result of a call to List.push(). |
Map | An associative array of Variant keys and values. |
Math | A class containing common math functions. |
Model | A class containing data and functions for the model. |
MQTT.Client | This class allows you to create client connections to an MQTT broker. |
MQTT.Message | This class defines an MQTT message. The MQTT.Client class sends and receives MQTT messages. |
Navigator | A class that represents a TaskExecuter's navigator. In other words, the object that manages travel tasks for the task executer. |
Object | A class that represents objects in the model. |
PowerPoint | A class for accessing PowerPoint. |
PowerPoint.Layout | An enumeration of integer values associated with PowerPoint slide layouts. |
PowerPoint.Presentation | A class for creating, opening, and editing PowerPoint presentations. |
PowerPoint.Shape | A class for managing and editing PowerPoint shapes. |
PowerPoint.ShapeType | An enumeration of integer values associated with PowerPoint shape types. |
PowerPoint.Slide | A class for managing and editing PowerPoint slides. |
PowerPoint.SlideSizeType | An enumeration of integer values associated with PowerPoint slide size types. |
RegExp | Allows regular expressions to be used as function parameters. |
RegExResult | A class that handles the results of a RegEx match |
StatisticsCollector | A class that represents a Statistics Collector |
StatisticsCollector.CollectedData | Provides access to data that may be used in Statistics Collector callbacks. |
Storage | The storage namespace. |
Storage.Bay | A class that represents a storage bay. |
Storage.Item | A class that includes properties and functionality associated with the storage and assignment of a flow item to Storage.Slots. |
Storage.Item.State | A class that enumerates the storage item states. |
Storage.Level | A class that represents a storage level within a bay. |
Storage.Object | A storage object, with functionality and data for storing items in a 2-dimensional grid of bays, levels, and slots |
Storage.QueryFlags | Enumerates possible flags that can be passed as the flags parameter into Storage.System.findSlot(), Storage.System.querySlots(), Storage.System.findItem(), or Storage.System.queryItems(). |
Storage.Slot | A slot that is part of a storage object's grid of storable slots. |
Storage.Slot.Item | A class that represents a storage slot item. |
Storage.System | A class that represents a storage system. |
string | A class that represents a sequence of characters. |
Table | A class that represents a table structure. |
Table.IndexType | Enumerates types of indices on the table. |
TableValidation | A class that represents a Table Validation. |
TableValidation.Context | A class that represents a TableValidation Context. The context stores data that persists through the duration of a rule. |
TaskExecuter | A class that represents a Dispatcher that can also execute TaskSequences. |
TaskSequence | A class representing a sequence of tasks to be performed by a TaskExecuter. |
TaskSequence.Task | A class representing an individual task in a TaskSequence. |
Token | A class that represents a Process Flow token. |
Tools | A class for creating and getting Tool nodes. |
TrackedVariable | A class that represents a tracked variable. |
treenode | A class that represents a reference to a node in FlexSim's tree. |
USD.Attribute | A class that represents a USD Property. |
USD.Prim | A class that represents a USD Prim. |
USD.Property | A class that represents a USD Property. |
USD.Relationship | A class that represents a USD Relationship. |
USD.Stage | A class that represents a USD Stage. |
Variant | A type that can hold either a number, a string, a treenode or an Array. |
Vec2 | Represents positions, rotations, size, 2D vectors, and points. Contains functions for doing common vector operations. |
Vec3 | Represents positions, rotations, size, 3D vectors, and points. Contains functions for doing common vector operations. |
XML | Namespace for the XML functions. Contains a few static functions. |
XML.Comment | A class that represents an XML Comment. |
XML.Declaration | A class that represents an XML Declaration. |
XML.Document | A class that represents an XML Document. |
XML.Element | A class that represents an XML Element. |
XML.Node | A base class for other XML Nodes. |
XML.NodePlacement | An enumeration of integer values associated with XML node placement. Primarily used with the XML.Node's create functions. XML.NodePlacement. Last is default behavior. |
XML.Text | A class that represents an XML Text. |
XML.Unknown | A class that represents something the XML parser doesn't recognize. |