Reflection
Classes
Object Object
The base class of every object.
Properties
Int Hash hash
A Hash of this object. This is a value that nearly uniquely identifies this object.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
String internalName internalName
The unreal engine internal name of this object.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
String internalPath internalPath
The unreal engine internal path name of this object.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Int Hash hash
A Hash of this object. This is a value that nearly uniquely identifies this object.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Hash getHash
(Int Hash hash
out)
Returns the hash of this class. This is a value that nearly uniquely idenfies this object.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Hash
hash
Int out
The hash of this class.
Get Type getType
(Object(Class) Type type
out)
Returns the type (aka class) of this class instance.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Type
type
Object(Class) out
The type of this class instance
Actor Actor
Parent |
This is the base class of all things that can exist within the world by them self.
Properties
Struct(Vector) Location location
The location of the actor in the world.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Struct(Vector) Scale scale
The scale of the actor in the world.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Struct(Rotator) Rotation rotation
The rotation of the actor in the world.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Power Connectors getPowerConnectors
(Array(Trace(PowerConnection)) Connectors connectors
out)
Returns a list of power connectors this actor might have.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Connectors
connectors
Array(Trace(PowerConnection)) out
The power connectors this actor has.
Get Factory Connectors getFactoryConnectors
(Array(Trace(FactoryConnection)) Connectors connectors
out)
Returns a list of factory connectors this actor might have.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Connectors
connectors
Array(Trace(FactoryConnection)) out
The factory connectors this actor has.
Get Pipe Connectors getPipeConnectors
(Array(Trace(PipeConnection)) Connectors connectors
out)
Returns a list of pipe connectors this actor might have.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Connectors
connectors
Array(Trace(PipeConnection)) out
The factory connectors this actor has.
Get Inventories getInventories
(Array(Trace(Inventory)) Inventories inventories
out)
Returns a list of inventories this actor might have.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Inventories
inventories
Array(Trace(Inventory)) out
The inventories this actor has.
Get Network Connectors getNetworkConnectors
(Array(Trace(ActorComponent)) Connectors connectors
out)
Returns the name of network connectors this actor might have.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Connectors
connectors
Array(Trace(ActorComponent)) out
The factory connectors this actor has.
Circuite Bridget CircuitBridge
Parent |
A building that can connect two circuit networks together.
Circuit Switch CircuitSwitch
Parent |
A circuit bridge that can be activated and deactivate by the player.
Light Source LightsControlPanel
Parent |
A control panel to configure multiple lights at once.
Properties
Bool Is Light Enabled isLightEnabled
True if the lights should be enabled
Flags |
RuntimeSync RuntimeParallel |
Functions
Set Color from Slot setColorFromSlot
(Int Slot slot
, Struct(Color) Color color
)
Allows to update the light color that is referenced by the given slot.
Flags |
RuntimeSync |
- Parameters
-
Name Type Description Slot
slot
Int
The slot you want to update the referencing color for.
Color
color
Struct(Color)
The color this slot should now reference.
Computer Case ComputerCase
Parent |
Signals
File System Update FileSystemUpdate
(Int Type type
, String From from
, String To to
)
Triggers when something in the filesystem changes.
Flags |
|
- Parameters
-
Name Type Description Type
type
Int
The type of the change.
From
from
String
The file path to the FS node that has changed.
To
to
String
The new file path of the node if it has changed.
Factory Factory
Parent |
The base class of most machines you can build.
Properties
Float Progress progress
The current production progress of the current production cycle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Producing Power Consumption powerConsumProducing
The power consumption when producing.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Productivity productivity
The productivity of this factory.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Cycle Time cycleTime
The time that passes till one production cycle is finsihed.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Max Potential maxPotential
The maximum potential this factory can be set to.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Docking Station DockingStation
Parent |
A docking station for wheeled vehicles to transfer cargo.
Properties
Functions
Get Fueld Inventory getFuelInv
(Trace(Inventory) Inventory inventory
out)
Returns the fuel inventory of the docking station.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Inventory
inventory
Trace(Inventory) out
The fuel inventory of the docking station.
Get Inventory getInv
(Trace(Inventory) Inventory inventory
out)
Returns the cargo inventory of the docking staiton.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Inventory
inventory
Trace(Inventory) out
The cargo inventory of this docking station.
Codeable Merger CodeableMerger
Parent |
Functions
Transfer Item transferItem
(Int Input input
, Bool Transfered transfered
out)
Allows to transfer an item from the given input queue to the output queue if possible.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Input
input
Int
The index of the input queue you want to transfer the next item to the output queue. (0 = right, 1 = middle, 2 = left)
- Return Values
-
Name Type Description Transfered
transfered
Bool out
true if it was able to transfer the item.
Get Input getInput
(Int Input input
, Struct(Item) Item item
out)
Returns the next item in the given input queue.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Input
input
Int
The index of the input queue you want to check (0 = right, 1 = middle, 2 = left)
- Return Values
-
Name Type Description Item
item
Struct(Item) out
The next item in the input queue.
Signals
Item Request ItemRequest
(Int Input input
, Struct(Item) Item item
)
Triggers when a new item is ready in one of the input queues.
Flags |
|
- Parameters
-
Name Type Description Input
input
Int
The index of the input queue at which the item is ready.
Item
item
Struct(Item) out
The new item in the input queue.
Codeable Splitter CodeableSplitter
Parent |
Functions
Transfer Item transferItem
(Int Output output
, Bool Transfered transfered
out)
Allows to transfer an item from the input queue to the given output queue if possible.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Output
output
Int
The index of the output queue you want to transfer the next item to (0 = left, 1 = middle, 2 = right)
- Return Values
-
Name Type Description Transfered
transfered
Bool out
true if it was able to transfer the item.
Get Input getInput
(Struct(Item) Item item
out)
Returns the next item in the input queue.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Item
item
Struct(Item) out
The next item in the input queue.
Can Output canOutput
(Int Output output
, Bool Can Transfer canTransfer
out)
Allows to check if we can transfer an item to the given output queue.
Flags |
RuntimeSync |
- Parameters
-
Name Type Description Output
output
Int
The index of the output queue you want to check (0 = left, 1 = middle, 2 = right)
- Return Values
-
Name Type Description Can Transfer
canTransfer
Bool out
True if you could transfer an item to the given output queue.
Signals
Item Request ItemRequest
(Struct(Item) Item item
)
Triggers when a new item is ready in the input queue.
Flags |
|
- Parameters
-
Name Type Description Item
item
Struct(Item) out
The new item in the input queue.
Item Outputted ItemOutputted
(Int Output output
, Struct(Item) Item item
)
Triggers when an item is popped from on of the output queues (aka it got transferred to a conveyor).
Flags |
|
- Parameters
-
Name Type Description Output
output
Int
The index of the output queue from which the item got removed.
Item
item
Struct(Item) out
The item removed from the output queue.
PipelinePump PipelinePump
Parent |
A building that can pump fluids to a higher level within a pipeline.
Properties
Float Max Headlift maxHeadlift
The maximum amount of headlift this pump can provide.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Designed Headlift designedHeadlift
The amomunt of headlift this pump is designed for.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Manufacturer Manufacturer
Parent |
The base class of every machine that uses a recipe to produce something automatically.
Functions
Get Recipe getRecipe
(Class(Recipe) Recipe recipe
out)
Returns the currently set recipe of the manufacturer.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Recipe
recipe
Class(Recipe) out
The currently set recipe.
Get Recipes getRecipes
(Array(Class(Recipe)) Recipes recipes
out)
Returns the list of recipes this manufacturer can get set to and process.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Recipes
recipes
Array(Class(Recipe)) out
The list of avalible recipes.
Set Recipe setRecipe
(Class(Recipe) Recipe recipe
, Bool Got Set gotSet
out)
Sets the currently producing recipe of this manufacturer.
Flags |
RuntimeSync |
- Parameters
-
Name Type Description Recipe
recipe
Class(Recipe)
The recipe this manufacturer should produce.
- Return Values
-
Name Type Description Got Set
gotSet
Bool out
True if the current recipe got successfully set to the new recipe.
Pipe Reservoir PipeReservoir
Parent |
The base class for all fluid tanks.
Properties
Float Fluid Content fluidContent
The amount of fluid in the tank.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Max Fluid Content maxFluidContent
The maximum amount of fluid this tank can hold.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Flow Fill flowFill
The currentl inflow rate of fluid.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Power Storage PowerStorage
Parent |
A building that can store power for later usage.
Properties
Float Power Store powerStore
The current amount of energy stored in the storage.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Power Capacity powerCapacity
The amount of energy the storage can hold max.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Power Store Percent powerStorePercent
The current power store in percent.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Power Input powerIn
The amount of power coming into the storage.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Power Output powerOut
The amount of power going out from the storage.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Time until Full timeUntilFull
The time in seconds until the storage is filled.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Time until Empty timeUntilEmpty
The time in seconds until the storage is empty.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Railroad Switch Control RailroadSwitchControl
Parent |
The controler object for a railroad switch.
Train Platform TrainPlatform
Parent |
The base class for all train station parts.
Properties
Functions
Get Track Graph getTrackGraph
(Struct(TrackGraph) Graph graph
out)
Returns the track graph of which this platform is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Graph
graph
Struct(TrackGraph) out
The track graph of which this platform is part of.
Get Track Pos getTrackPos
(Trace(RailroadTrack) Track track
out, Float Offset offset
out, Float Forward forward
out)
Returns the track pos at which this train platform is placed.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Track
track
Trace(RailroadTrack) out
The track the track pos points to.
Offset
offset
Float out
The offset of the track pos.
Forward
forward
Float out
The forward direction of the track pos. 1 = with the track direction, -1 = against the track direction
Get Connected Platform getConnectedPlatform
(Int Direction direction
, Trace(TrainPlatform) Platform platform
out)
Returns the connected platform in the given direction.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Direction
direction
Int
The direction in which you want to get the connected platform.
- Return Values
-
Name Type Description Platform
platform
Trace(TrainPlatform) out
The platform connected to this platform in the given direction.
Get Docked Vehicle getDockedVehicle
(Trace(Vehicle) Vehicle vehicle
out)
Returns the currently docked vehicle.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Vehicle
vehicle
Trace(Vehicle) out
The currently docked vehicle
Get Master getMaster
(Trace(RailroadVehicle) Master master
out)
Returns the master platform of this train station.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Master
master
Trace(RailroadVehicle) out
The master platform of this train station.
Get Docked Locomotive getDockedLocomotive
(Trace(RailroadVehicle) Locomotive locomotive
out)
Returns the currently docked locomotive at the train station.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Locomotive
locomotive
Trace(RailroadVehicle) out
The currently docked locomotive at the train station.
Railroad Station RailroadStation
Parent |
The train station master platform. This platform holds the name and manages docking of trains.
Train Platform Cargo TrainPlatformCargo
Parent |
A train platform that allows for loading and unloading cargo cars.
Properties
Bool Is Loading isLoading
True if the cargo platform is currently loading the docked cargo vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Is Unloading isUnloading
True if the cargo platform is currently unloading the docked cargo vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Docked Offset dockedOffset
The offset to the track start of the platform at were the vehicle docked.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Output Flow outputFlow
The current output flow rate.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Computer GPU T1 GPUT1
Parent |
Functions
Set Text setText
(Int X x
, Int Y y
, String String str
)
Draws the given text at the given position to the hidden screen buffer.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description X
x
Int
The x coordinate at which the text should get drawn.
Y
y
Int
The y coordinate at which the text should get drawn.
String
str
String
The text you want to draw on-to the buffer.
Set Size setSize
(Int Width w
, Int Height h
)
Changes the size of the text-grid (and buffer).
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Width
w
Int
The width of the text-gird.
Height
h
Int
The height of the text-grid.
Set Foreground Color setForeground
(Float Red r
, Float Green g
, Float Blue b
, Float Alpha a
)
Changes the foreground color that is used for the next draw calls.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description Red
r
Float
The red portion of the foreground color. (0.0 - 1.0)
Green
g
Float
The green portion of the foreground color. (0.0 - 1.0)
Blue
b
Float
The blue portion of the foreground color. (0.0 - 1.0)
Alpha
a
Float
The opacity of the foreground color. (0.0 - 1.0)
Set Buffer setBuffer
(Struct(GPUT1Buffer) Buffer buffer
)
Allows to change the back buffer of the GPU to the given buffer.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description Buffer
buffer
Struct(GPUT1Buffer)
The Buffer you want to now use as back buffer.
Set Background Color setBackground
(Float Red r
, Float Green g
, Float Blue b
, Float Alpha a
)
Changes the background color that is used for the next draw calls.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description Red
r
Float
The red portion of the background color. (0.0 - 1.0)
Green
g
Float
The green portion of the background color. (0.0 - 1.0)
Blue
b
Float
The blue portion of the background color. (0.0 - 1.0)
Alpha
a
Float
The opacity of the background color. (0.0 - 1.0)
Get Size getSize
(Int Width w
out, Int Height h
out)
Returns the size of the text-grid (and buffer).
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Width
w
Int out
The width of the text-gird.
Height
h
Int out
The height of the text-grid.
Get Screen getScreen
(Object(Object) Screen screen
out)
Returns the currently bound screen.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Screen
screen
Object(Object) out
The currently bound screen.
Get Buffer getBuffer
(Struct(GPUT1Buffer) Buffer buffer
out)
Returns the back buffer as struct to be able to use advanced buffer handling functions. (struct is a copy)
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Return Values
-
Name Type Description Buffer
buffer
Struct(GPUT1Buffer) out
The Buffer that is currently the back buffer.
Flush flush
()
Flushes the hidden screen buffer to the visible screen buffer and so makes the draw calls visible.
Flags |
RuntimeSync RuntimeParallel |
Fill fill
(Int X x
, Int Y y
, Int DX dx
, Int DY dy
, String String str
)
Draws the given character at all given positions in the given rectangle on-to the hidden screen buffer.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description X
x
Int
The x coordinate at which the rectangle should get drawn. (upper-left corner)
Y
y
Int
The y coordinate at which the rectangle should get drawn. (upper-left corner)
DX
dx
Int
The width of the rectangle.
DY
dy
Int
The height of the rectangle.
String
str
String
The character you want to use for the rectangle. (first char in the given string)
Signals
Screen Size Changed ScreenSizeChanged
(Int old Width oldW
, Int old Height oldH
)
Triggers when the size of the text grid changed.
Flags |
|
- Parameters
-
Name Type Description old Width
oldW
Int
The old width of the screen.
old Height
oldH
Int
The old height of the screen.
On Mouse Up OnMouseUp
(Int X x
, Int Y y
, Int Button btn
)
Triggers when a mouse button got released.
Flags |
|
- Parameters
-
Name Type Description X
x
Int
The x position of the cursor.
Y
y
Int
The y position of the cursor.
Button
btn
Int
The Button-Bit-Field providing information about the released button event.
Bits:
1th left mouse pressed
2th right mouse button pressed
3th ctrl key pressed
4th shift key pressed
5th alt key pressed
6th cmd key pressed
On Mouse Move OnMouseMove
(Int X x
, Int Y y
, Int Button btn
)
Triggers when the mouse cursor moves on the screen.
Flags |
|
- Parameters
-
Name Type Description X
x
Int
The x position of the cursor.
Y
y
Int
The y position of the cursor.
Button
btn
Int
The Button-Bit-Field providing information about the move event.
Bits:
1th left mouse pressed
2th right mouse button pressed
3th ctrl key pressed
4th shift key pressed
5th alt key pressed
6th cmd key pressed
On Mouse Down OnMouseDown
(Int X x
, Int Y y
, Int Button btn
)
Triggers when a mouse button got pressed.
Flags |
|
- Parameters
-
Name Type Description X
x
Int
The x position of the cursor.
Y
y
Int
The y position of the cursor.
Button
btn
Int
The Button-Bit-Field providing information about the pressed button event.
Bits:
1th left mouse pressed
2th right mouse button pressed
3th ctrl key pressed
4th shift key pressed
5th alt key pressed
6th cmd key pressed
On Key Up OnKeyUp
(Int C c
, Int Code code
, Int Button btn
)
Triggers when a key got released.
Flags |
|
- Parameters
-
Name Type Description C
c
Int
The ASCII number of the character typed in.
Code
code
Int
The number code of the pressed key.
Button
btn
Int
The Button-Bit-Field providing information about the key release event.
Bits:
1th left mouse pressed
2th right mouse button pressed
3th ctrl key pressed
4th shift key pressed
5th alt key pressed
6th cmd key pressed
On Key Down OnKeyDown
(Int C c
, Int Code code
, Int Button btn
)
Triggers when a key got pressed.
Flags |
|
- Parameters
-
Name Type Description C
c
Int
The ASCII number of the character typed in.
Code
code
Int
The number code of the pressed key.
Button
btn
Int
The Button-Bit-Field providing information about the key press event.
Bits:
1th left mouse pressed
2th right mouse button pressed
3th ctrl key pressed
4th shift key pressed
5th alt key pressed
6th cmd key pressed
On Key Character OnKeyChar
(String Character c
, Int Button btn
)
Triggers when a character key got 'clicked' and essentially a character got typed in, usful for text input.
Flags |
|
- Parameters
-
Name Type Description Character
c
String
The character that got typed in as string.
Button
btn
Int
The Button-Bit-Field providing information about the key release event.
Bits:
1th left mouse pressed
2th right mouse button pressed
3th ctrl key pressed
4th shift key pressed
5th alt key pressed
6th cmd key pressed
FINInternetCard FINInternetCard
Parent |
Functions
Request request
(String URL url
, String Method method
, String Data data
, Struct(Future) ReturnValue ReturnValue
out)
Does an HTTP-Request. If a payload is given, the Content-Type header has to be set. All additional parameters have to be strings and in pairs of two for defining the http headers and values.
Flags |
RuntimeSync RuntimeParallel VarArgs |
- Parameters
-
Name Type Description URL
url
String
The URL for which you want to make an HTTP Request.
Method
method
String
The http request method/verb you want to make the request. f.e. 'GET', 'POST'
Data
data
String
The http request payload you want to sent.
- Return Values
-
Name Type Description ReturnValue
ReturnValue
Struct(Future) out
Network Card NetworkCard
Parent |
Functions
Send Message send
(String Receiver receiver
, Int Port port
)
Sends a network message to the receiver with the given address on the given port. The data you want to add can be passed as additional parameters. Max amount of such parameters is 7 and they can only be nil, booleans, numbers and strings.
Flags |
RuntimeSync RuntimeParallel VarArgs |
- Parameters
-
Name Type Description Receiver
receiver
String
The component ID as string of the component you want to send the network message to.
Port
port
Int
The port on which the network message should get sent. For outgoing network messages a port does not need to be opened.
Open Port open
(Int Port port
)
Opens the given port so the network card is able to receive network messages on the given port.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Port
port
Int
The port you want to open.
Close All Ports closeAll
()
Closes all ports of the network card so no further messages are able to get received
Flags |
RuntimeSync RuntimeParallel |
Close Port close
(Int Port port
)
Closes the given port so the network card wont receive network messages on the given port.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Port
port
Int
The port you want to close.
Broadcast Message broadcast
(Int Port port
)
Sends a network message to all components in the network message network (including networks sepperated by network routers) on the given port. The data you want to add can be passed as additional parameters. Max amount of such parameters is 7 and they can only be nil, booleans, numbers and strings.
Flags |
RuntimeSync RuntimeParallel VarArgs |
- Parameters
-
Name Type Description Port
port
Int
The port on which the network message should get sent. For outgoing network messages a port does not need to be opened.
Signals
Network Message NetworkMessage
(String Sender sender
, Int Port port
)
Triggers when the network card receives a network message on one of its opened ports. The additional arguments are the data that is contained within the network message.
Flags |
VarArgs |
- Parameters
-
Name Type Description Sender
sender
String
The component id of the sender of the network message.
Port
port
Int
The port on which the network message got sent.
Large Micro Display Module LargeMicroDisplayModule
Parent |
Provides a relatively small text only display for Control Panels.
Text height is fixed, but text is squeezed to fit horizontally.
Illuminable 2 Position Switch MCP_Mod_2Pos_Switch_C
Parent |
This Switch Module for modular I/O Panels is used to toggle between a true and false value. It has an illuminable spot on the knob and you can use them to trigger specific programmed events.
Illuminable 3 Position Switch MCP_Mod_3Pos_Switch_C
Parent |
This Switch Module for modular I/O Panels is used to toggle between three different settings. It has an illuminable spot on the knob and you can use them to trigger specific programmed events.
Encoder MCP_Mod_Encoder_C
Parent |
This Potentiometer Module allows for input of a value with infinite range, this because it only fires how much the value changed since last, not how much it is at.
Mini Gauge MCP_Mod_Guage_C
Parent |
A small analogue Gauge for use on Micro Enclosures. The red portion and needle position can be changed through FIN
Potentiometer MCP_Mod_Potentiometer_C
Parent |
This Potentiometer Module allows for input of a fixed value range and fires a signal with the new value each time the internal counter changes.
Potentiometer with Readout MCP_Mod_PotWNum_C
Parent |
This Potentiometer Module allows for input of a fixed value range and fires a signal with the new value each time the internal counter changes. This version has a readout display on it.
Micro Display Module MicroDisplayModule
Parent |
Provides a small text only display for Control Panels.
Can display up to 3 digits, One additional dot may be used.
Big Gauge Module_BigGuage_C
Parent |
A medium analogue Gauge for use on Large Panels. The red portion and needle position can be changed through FIN
Module Button ModuleButton
Parent |
This Button Module for modular I/O Panels can have different knob color and brightnesses and you can use them to trigger specific programmed events.
Module Potentiometer ModulePotentiometer
Parent |
The Potentiometer Module for the Modular I/O Control Panel allows you to have rotation input value for you programs.
You can rotate it indefinetly into any direction where every rotation triggers a computer network signal.
Module Stop Button ModuleStopButton
Parent |
This Stop Button Module for the modular I/O Panel is used to trigger important programmable events.
Lever Module ModuleSwitch_C
Parent |
The Lever Module for the modular I/O Panel is used to switch a programm state between two different value (on or off).
Text Display ModuleTextDisplay_C
Parent |
The FicsIt-Networks Text-Display Module for the Modular Control Panel is a simple GPU and Screen combined!
It allows you to display any kind of text with differnt font sizes and you can even switch between two fonts!
But you can’t interact with it, nor change the background/foreground color as you can do with a GPU.
Mushroom Pushbutton Module MushroomPushbuttonModule
Parent |
This Mushroom Button Module for modular I/O Panels can have different knob color and brightnesses and you can use them to trigger specific programmed events.
Pushbutton Module PushbuttonModule
Parent |
This Button Module for modular I/O Panels can have different knob color and brightnesses and you can use them to trigger specific programmed events.
Sizeable Module Panel SizeableModulePanel
Parent |
This panel allows for dynamic sizeing. For placing on walls.
Indicator Pole IndicatorPole
Parent |
Functions
Set Color setColor
(Float Red r
, Float Green g
, Float Blue b
, Float Emissive e
)
Allows to change the color and light intensity of the indicator lamp.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description Red
r
Float
The red part of the color in which the light glows. (0.0 - 1.0)
Green
g
Float
The green part of the color in which the light glows. (0.0 - 1.0)
Blue
b
Float
The blue part of the color in which the light glows. (0.0 - 1.0)
Emissive
e
Float
The light intensity of the pole. (0.0 - 5.0)
Get Top Pole getTopPole
(Object(IndicatorPole) Top Pole topPole
out)
Allows to get the pole placed on top of this pole.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Top Pole
topPole
Object(IndicatorPole) out
The pole placed on top of this pole.
Get Color getColor
(Float Red r
out, Float Green g
out, Float Blue b
out, Float Emissive e
out)
Allows to get the color and light intensity of the indicator lamp.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Red
r
Float out
The red part of the color in which the light glows. (0.0 - 1.0)
Green
g
Float out
The green part of the color in which the light glows. (0.0 - 1.0)
Blue
b
Float out
The blue part of the color in which the light glows. (0.0 - 1.0)
Emissive
e
Float out
The light intensity of the pole. (0.0 - 5.0)
getBottomPole getBottomPole
(Object(IndicatorPole) ReturnValue ReturnValue
out)
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description ReturnValue
ReturnValue
Object(IndicatorPole) out
Signals
Color Changed ColorChanged
(Float Red r
, Float Green g
, Float Blue b
, Float Emissive e
)
Triggers when the color of the indicator pole changes.
Flags |
|
- Parameters
-
Name Type Description Red
r
Float
The red part of the color in which the light glows. (0.0 - 1.0)
Green
g
Float
The green part of the color in which the light glows. (0.0 - 1.0)
Blue
b
Float
The blue part of the color in which the light glows. (0.0 - 1.0)
Emissive
e
Float
The light intensity of the pole. (0.0 - 5.0)
Large Control Panel LargeControlPanel
Parent |
This large modular I/O control panel allows you to attach multiple different modules on to it and use them as I/O to control you programms.
You can connect it to the FicsIt-Network.
Important to note is that every module is it’s own component, that means if you want to listen to the signals, you will need to listen to each of them individually.
Large Vertical Control Panel LargeVerticalControlPanel
Parent |
This large verical modular I/O control panel allows you to attach multiple different modules on to it and use them as I/O to control you programms.
You can connect it to the FicsIt-Network.
Important to note is that every module is it’s own component, that means if you want to listen to the signals, you will need to listen to each of them individually.
Light Source LightSource
Parent |
The base class for all light you can build.
Properties
Functions
Get Color from Slot getColorFromSlot
(Int Slot slot
, Struct(Color) Color color
out)
Returns the light color that is referenced by the given slot.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Slot
slot
Int
The slot you want to get the referencing color from.
- Return Values
-
Name Type Description Color
color
Struct(Color) out
The color this slot references.
Set Color from Slot setColorFromSlot
(Int Slot slot
, Struct(Color) Color color
)
Allows to update the light color that is referenced by the given slot.
Flags |
RuntimeSync |
- Parameters
-
Name Type Description Slot
slot
Int
The slot you want to update the referencing color for.
Color
color
Struct(Color)
The color this slot should now reference.
ModulePanel ModulePanel
Parent |
Enclosure for 1 command points
Functions
getYModule getYModule
(Int Y Y
, Object(Actor) Module Module
out)
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Y
Y
Int
- Return Values
-
Name Type Description Module
Module
Object(Actor) out
getXModule getXModule
(Int X X
, Object(Actor) Module Module
out)
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description X
X
Int
- Return Values
-
Name Type Description Module
Module
Object(Actor) out
Network Router NetworkRouter
Parent |
Functions
Set Port List setPortList
(Array(Int) Ports ports
out)
Overrides the port filter list with the given array.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Ports
ports
Array(Int) out
The port array you want to override the filter list with.
Set Address List setAddrList
(Array(String) Addresses addresses
out)
Overrides the address filter list with the given array.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Addresses
addresses
Array(String) out
The address array you want to override the filter list with.
Remove Port from List removePortList
(Int Port port
)
Removes the given port from the port filter list.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Port
port
Int
The port you want to remove from the list.
Remove Address from List removeAddrList
(String Address addr
)
Removes the given address from the address filter list.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Address
addr
String
The address you want to remove from the list.
Get Port List getPortList
(Array(Int) Ports ports
out)
Allows to get all the ports of the port filter list as array.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Ports
ports
Array(Int) out
The port array of the filter list.
Get Address List getAddrList
(Array(String) Addresses addresses
out)
Allows to get all the addresses of the address filter list as array.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Addresses
addresses
Array(String) out
The address array of the filter list.
Railroad Signal RailroadSignal
Parent |
A train signal to control trains on a track.
Properties
Bool Is Path Signal isPathSignal
True if this signal is a path-signal.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Is Bi-Directional isBiDirectional
True if this signal is bi-directional. (trains can pass into both directions)
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Has Observed Block hasObservedBlock
True if this signal is currently observing at least one block.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Int Block Validation blockValidation
Any error states of the block.
0 = Unknown
1 = No Error
2 = No Exit Signal
3 = Contains Loop
4 = Contains Mixed Entry Signals
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Int Aspect aspect
The aspect of the signal. The aspect shows if a train is allowed to pass (clear) or not and if it should dock.
0 = Unknown
1 = The track is clear and the train is allowed to pass.
2 = The next track is Occupied and the train should stop
3 = The train should dock.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Is Block Occupied isBlockOccupied
True if the block this signal is observing is currently occupied by a vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Railroad Track RailroadTrack
Parent |
A peice of railroad track over which trains can drive.
Functions
Get Closeset Track Position getClosestTrackPosition
(Struct(Vector) World Pos worldPos
, Trace(RailroadTrack) Track track
out, Float Offset offset
out, Float Forward forward
out)
Returns the closes track position from the given world position
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description World Pos
worldPos
Struct(Vector)
The world position form which you want to get the closest track position.
- Return Values
-
Name Type Description Track
track
Trace(RailroadTrack) out
The track the track pos points to.
Offset
offset
Float out
The offset of the track pos.
Forward
forward
Float out
The forward direction of the track pos. 1 = with the track direction, -1 = against the track direction
Get World Location And Rotation At Position getWorldLocAndRotAtPos
(Trace(RailroadTrack) Track track
, Float Offset offset
, Float Forward forward
, Struct(Vector) Location location
out, Struct(Vector) Rotation rotation
out)
Returns the world location and world rotation of the track position from the given track position.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Track
track
Trace(RailroadTrack)
The track the track pos points to.
Offset
offset
Float
The offset of the track pos.
Forward
forward
Float
The forward direction of the track pos. 1 = with the track direction, -1 = against the track direction
Get Connection getConnection
(Int Direction direction
, Trace(RailroadTrackConnection) Connection connection
out)
Returns the railroad track connection at the given direction.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Direction
direction
Int
The direction of which you want to get the connector from. 0 = front, 1 = back
- Return Values
-
Name Type Description Connection
connection
Trace(RailroadTrackConnection) out
The connection component in the given direction.
Get Track Graph getTrackGraph
(Struct(TrackGraph) Track track
out)
Returns the track graph of which this track is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Track
track
Struct(TrackGraph) out
The track graph of which this track is part of.
Widget Sign WidgetSign
Parent |
The type of sign that allows you to define layouts, images, texts and colors manually.
Functions
Set Prefab Sign Data setPrefabSignData
(Struct(PrefabSignData) Prefab Sign Data prefabSignData
)
Sets the prefabg sign data e.g. the user settings like colo and more to define the signs content.
Flags |
RuntimeSync |
- Parameters
-
Name Type Description Prefab Sign Data
prefabSignData
Struct(PrefabSignData)
The new prefab sign data for this sign.
Get Prefab Sign Data getPrefabSignData
(Struct(PrefabSignData) Prefab Sign Data prefabSignData
out)
Returns the prefabg sign data e.g. the user settings like colo and more to define the signs content.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Prefab Sign Data
prefabSignData
Struct(PrefabSignData) out
The new prefab sign data for this sign.
Speaker Pole SpeakerPole
Parent |
This speaker pole allows to play custom sound files, In-Game
Functions
Play Sound playSound
(String Sound sound
, Float Start Point startPoint
)
Plays a custom sound file ingame
Flags |
RuntimeSync |
- Parameters
-
Name Type Description Sound
sound
String
The sound file (without the file ending) you want to play
Start Point
startPoint
Float
The start point in seconds at which the system should start playing
Speaker-Pole Speakers_C
Parent |
The FicsIt-Networks speaker pole is a network component which allows you to use one more sense of the pioneers to give commands to them or to just make ambient better.
The speaker pole can play sound files located in the Computer Folder "/Sounds" in your Satisfactory Save-Games-Folder. The FicsIt-Networks speaker pole is only able to play .ogg files cause FicsIt Inc. has the opinion other file formates are useless.
Functions
setVolume setVolume
(Float Volume Volume
)
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Volume
Volume
Float
setRange setRange
(Float Range Range
)
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Range
Range
Float
Vehicle Scanner VehicleScanner
Parent |
Functions
Set Color setColor
(Float Red r
, Float Green g
, Float Blue b
, Float Emissive e
)
Allows to change the color and light intensity of the scanner.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description Red
r
Float
The red part of the color in which the scanner glows. (0.0 - 1.0)
Green
g
Float
The green part of the color in which the scanner glows. (0.0 - 1.0)
Blue
b
Float
The blue part of the color in which the scanner glows. (0.0 - 1.0)
Emissive
e
Float
The light intensity of the scanner. (0.0 - 5.0)
Get Last Vehicle getLastVehicle
(Object(Vehicle) Vehicle vehicle
out)
Returns the last vehicle that entered the scanner.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Vehicle
vehicle
Object(Vehicle) out
The vehicle that entered the scanner. null if it has already left the scanner.
Get Color getColor
(Float Red r
out, Float Green g
out, Float Blue b
out, Float Emissive e
out)
Allows to get the color and light intensity of the scanner.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Red
r
Float out
The red part of the color in which the scanner glows. (0.0 - 1.0)
Green
g
Float out
The green part of the color in which the scanner glows. (0.0 - 1.0)
Blue
b
Float out
The blue part of the color in which the scanner glows. (0.0 - 1.0)
Emissive
e
Float out
The light intensity of the scanner. (0.0 - 5.0)
Target List TargetList
Parent |
The list of targets/path-waypoints a autonomous vehicle can drive
Functions
Get Target getTarget
(Struct(TargetPoint) Target target
out)
Returns the target struct at with the given index in the target list.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Target
target
Struct(TargetPoint) out
The TargetPoint-Struct with the given index in the target list.
Remove Target removeTarget
(Int Index index
)
Removes the target with the given index from the target list.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The index of the target point you want to remove from the target list.
Add Target addTarget
(Struct(TargetPoint) Target target
)
Adds the given target point struct at the end of the target list.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Target
target
Struct(TargetPoint)
The target point you want to add.
Set Target setTarget
(Int Index index
, Struct(TargetPoint) Target target
)
Allows to set the target at the given index to the given target point struct.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The index of the target point you want to update with the given target point struct.
Target
target
Struct(TargetPoint)
The new target point struct for the given index.
Get Targets getTargets
(Array(Struct(TargetPoint)) Targets targets
out)
Returns a list of target point structs of all the targets in the target point list.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Targets
targets
Array(Struct(TargetPoint)) out
A list of target point structs containing all the targets of the target point list.
Set Targets setTargets
(Array(Struct(TargetPoint)) Targets targets
)
Removes all targets from the target point list and adds the given array of target point structs to the empty target point list.
Flags |
RuntimeSync |
- Parameters
-
Name Type Description Targets
targets
Array(Struct(TargetPoint))
A list of target point structs you want to place into the empty target point list.
Time Table TimeTable
Parent |
Contains the time table information of train.
Functions
Add Stop addStop
(Int Index index
, Trace(RailroadStation) Station station
, Struct(TrainDockingRuleSet) Rule Set ruleSet
, Bool Added added
out)
Adds a stop to the time table.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The index at which the stop should get added.
Station
station
Trace(RailroadStation)
The railroad station at which the stop should happen.
Rule Set
ruleSet
Struct(TrainDockingRuleSet)
The docking rule set that descibes when the train will depart from the station.
- Return Values
-
Name Type Description Added
added
Bool out
True if the stop got sucessfully added to the time table.
Remove Stop removeStop
(Int Index index
)
Removes the stop with the given index from the time table.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The index at which the stop should get added.
Get Stops getStops
(Array(Struct(TimeTableStop)) Stops stops
out)
Returns a list of all the stops this time table has
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Stops
stops
Array(Struct(TimeTableStop)) out
A list of time table stops this time table has.
Set Stops setStops
(Bool Got Set gotSet
out)
Allows to empty and fill the stops of this time table with the given list of new stops.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Got Set
gotSet
Bool out
True if the stops got sucessfully set.
Is Valid Stop isValidStop
(Int Index index
, Bool Valid valid
out)
Allows to check if the given stop index is valid.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The stop index you want to check its validity.
- Return Values
-
Name Type Description Valid
valid
Bool out
True if the stop index is valid.
Get Stop getStop
(Int Index index
, Struct(TimeTableStop) Stop stop
out)
Returns the stop at the given index.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The index of the stop you want to get.
- Return Values
-
Name Type Description Stop
stop
Struct(TimeTableStop) out
The time table stop at the given index.
Set Current Stop setCurrentStop
(Int Index index
)
Sets the stop, to which the train trys to drive to right now.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The index of the stop the train should drive to right now.
Train Train
Parent |
This class holds information and references about a trains (a collection of multiple railroad vehicles) and its timetable f.e.
Properties
Bool Is Player Driven isPlayerDriven
True if the train is currently player driven.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Is Self Driving isSelfDriving
True if the train is currently self driving.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Int Self Driving Error selfDrivingError
The last self driving error.
0 = No Error
1 = No Power
2 = No Time Table
3 = Invalid Next Stop
4 = Invalid Locomotive Placement
5 = No Path
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Has Time Table hasTimeTable
True if the train has currently a time table.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Name getName
(String Name name
out)
Returns the name of this train.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Name
name
String out
The name of this train.
Set Name setName
(String Name name
)
Allows to set the name of this train.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Name
name
String
The new name of this trian.
Get Track Graph getTrackGraph
(Struct(TrackGraph) Track track
out)
Returns the track graph of which this train is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Track
track
Struct(TrackGraph) out
The track graph of which this train is part of.
Set Self Driving setSelfDriving
(Bool Self Driving selfDriving
)
Allows to set if the train should be self driving or not.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Self Driving
selfDriving
Bool
True if the train should be self driving.
Get Master getMaster
(Trace(RailroadVehicle) Master master
out)
Returns the master locomotive that is part of this train.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Master
master
Trace(RailroadVehicle) out
The master locomotive of this train.
Get Time Table getTimeTable
(Trace(TimeTable) Time Table timeTable
out)
Returns the timetable of this train.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Time Table
timeTable
Trace(TimeTable) out
The timetable of this train.
New Time Table newTimeTable
(Trace(TimeTable) Time Table timeTable
out)
Creates and returns a new timetable for this train.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Time Table
timeTable
Trace(TimeTable) out
The new timetable for this train.
Get First getFirst
(Trace(RailroadVehicle) First first
out)
Returns the first railroad vehicle that is part of this train.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description First
first
Trace(RailroadVehicle) out
The first railroad vehicle that is part of this train.
Get Last getLast
(Trace(RailroadVehicle) Last last
out)
Returns the last railroad vehicle that is part of this train.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Last
last
Trace(RailroadVehicle) out
The last railroad vehicle that is part of this train.
Dock dock
()
Trys to dock the train to the station it is currently at.
Flags |
RuntimeSync RuntimeParallel |
Get Vehicles getVehicles
(Array(Trace(RailroadVehicle)) Vehicles vehicles
out)
Returns a list of all the vehicles this train has.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Vehicles
vehicles
Array(Trace(RailroadVehicle)) out
A list of all the vehicles this train has.
Vehicle Vehicle
Parent |
A base class for all vehciles.
Railroad Vehicle RailroadVehicle
Parent |
The base class for any vehicle that drives on train tracks.
Properties
Float Length length
The length of this vehicle on the track.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Train getTrain
(Trace(Train) Train train
out)
Returns the train of which this vehicle is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Train
train
Trace(Train) out
The train of which this vehicle is part of
Is Coupled isCoupled
(Int Coupler coupler
, Bool Coupled coupled
out)
Allows to check if the given coupler is coupled to another car.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Coupler
coupler
Int
The Coupler you want to check. 0 = Front, 1 = Back
- Return Values
-
Name Type Description Coupled
coupled
Bool out
True of the give coupler is coupled to another car.
Get Coupled getCoupled
(Int Coupler coupler
, Trace(RailroadVehicle) Coupled coupled
out)
Allows to get the coupled vehicle at the given coupler.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Coupler
coupler
Int
The Coupler you want to get the car from. 0 = Front, 1 = Back
- Return Values
-
Name Type Description Coupled
coupled
Trace(RailroadVehicle) out
The coupled car of the given coupler is coupled to another car.
Get Track Graph getTrackGraph
(Struct(TrackGraph) Track track
out)
Returns the track graph of which this vehicle is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Track
track
Struct(TrackGraph) out
The track graph of which this vehicle is part of.
Get Track Pos getTrackPos
(Trace(RailroadTrack) Track track
out, Float Offset offset
out, Float Forward forward
out)
Returns the track pos at which this vehicle is.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Track
track
Trace(RailroadTrack) out
The track the track pos points to.
Offset
offset
Float out
The offset of the track pos.
Forward
forward
Float out
The forward direction of the track pos. 1 = with the track direction, -1 = against the track direction
Get Movement getMovement
(Trace(RailroadVehicleMovement) Movement movement
out)
Returns the vehicle movement of this vehicle.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Movement
movement
Trace(RailroadVehicleMovement) out
The movement of this vehicle.
Wheeled Vehicle WheeledVehicle
Parent |
The base class for all vehicles that used wheels for movement.
Properties
Float Speed speed
The current forward speed of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Burn Ratio burnRatio
The amount of fuel this vehicle burns.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Int Wheels On Ground wheelsOnGround
The number of wheels currenlty on the ground.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Has Fuel hasFuel
True if the vehicle has currently fuel to drive.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Fuel Inventory getFuelInv
(Trace(Inventory) Inventory inventory
out)
Returns the inventory that contains the fuel of the vehicle.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Inventory
inventory
Trace(Inventory) out
The fuel inventory of the vehicle.
Get Storage Inventory getStorageInv
(Trace(Inventory) Inventory inventory
out)
Returns the inventory that contains the storage of the vehicle.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Inventory
inventory
Trace(Inventory) out
The storage inventory of the vehicle.
Is Valid Fuel isValidFuel
(Class(ItemType) Item item
, Bool Is Valid isValid
out)
Allows to check if the given item type is a valid fuel for this vehicle.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Item
item
Class(ItemType)
The item type you want to check.
- Return Values
-
Name Type Description Is Valid
isValid
Bool out
True if the given item type is a valid fuel for this vehicle.
Get Current Target getCurrentTarget
(Int Index index
out)
Returns the index of the target that the vehicle tries to move to right now.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Index
index
Int out
The index of the current target.
Next Target nextTarget
()
Sets the current target to the next target in the list.
Flags |
RuntimeSync RuntimeParallel |
Set Current Target setCurrentTarget
(Int Index index
)
Sets the target with the given index as the target this vehicle tries to move to right now.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The index of the target this vehicle should move to now.
Get Target List getTargetList
(Trace(TargetList) Target List targetList
out)
Returns the list of targets/path waypoints.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Target List
targetList
Trace(TargetList) out
The list of targets/path-waypoints.
Actor Component ActorComponent
Parent |
A component/part of an actor in the world.
Properties
Trace(Actor) Owner owner
The parent actor of which this component is part of
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Factory Connection FactoryConnection
Parent |
A actor component that is a connection point to which a conveyor or pipe can get attached to.
Properties
Int Type type
Returns the type of the connection. 0 = Conveyor, 1 = Pipe
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Functions
Inventory Inventory
Parent |
A actor component that can hold multiple item stacks.
Properties
Pipe Connection PipeConnection
Parent |
A actor component that is a connection point to which a conveyor or pipe can get attached to.
Properties
Bool Is Connected isConnected
True if something is connected to this connection.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Fluid Box Content fluidBoxContent
Returns the amount of fluid this fluid container contains
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Fluid Box Height fluidBoxHeight
Returns the height of this fluid container
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Fluid Box Laminar Height fluidBoxLaminarHeight
Returns the laminar height of this fluid container
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Fluid Box Flow Through fluidBoxFlowThrough
Returns the amount of fluid flowing through this fluid container
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Fluid Box Flow Fill fluidBoxFlowFill
Returns the fill rate of this fluid container
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Fluid Box Flow Drain fluidBoxFlowDrain
Returns the drain rate of this fluid container
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Power Connection PowerConnection
Parent |
A actor component that allows for a connection point to the power network. Basically a point were a power cable can get attached to.
Properties
Functions
Get Power getPower
(Trace(PowerInfo) Power power
out)
Returns the power info component of this power connection.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Power
power
Trace(PowerInfo) out
The power info compoent this power connection uses.
Get Circuit getCircuit
(Trace(PowerCircuit) Circuit circuit
out)
Returns the power circuit to which this connection component is attached to.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Circuit
circuit
Trace(PowerCircuit) out
The Power Circuit this connection component is attached to.
Power Info PowerInfo
Parent |
A actor component that provides information and mainly statistics about the power connection it is attached to.
Properties
Float Dynamic Production dynProduction
The production cpacity this connection provided last tick.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Base Production baseProduction
The base production capactiy this connection always provides.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Max Dynamic Production maxDynProduction
The maximum production capactiy this connection could have provided to the circuit in the last tick.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Target Consumption targetConsumption
The amount of energy the connection wanted to consume from the circuit in the last tick.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Circuit getCircuit
(Trace(PowerCircuit) Circuit circuit
out)
Returns the power circuit this info component is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Circuit
circuit
Trace(PowerCircuit) out
The Power Circuit this info component is attached to.
Railroad Track Connection RailroadTrackConnection
Parent |
This is a actor component for railroad tracks that allows to connecto to other track connections and so to connection multiple tracks with each eather so you can build a train network.
Properties
Struct(Vector) Connector Location connectorLocation
The world location of the the connection.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Struct(Vector) Connector Normal connectorNormal
The normal vecotr of the connector.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Is Connected isConnected
True if the connection has any connection to other connections.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Is Facing Switch isFacingSwitch
True if this connection is pointing to the merge/spread point of the switch.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Connection getConnection
(Trace(RailroadTrackConnection) Connection connection
out, Int Index index
)
Returns the connected connection with the given index.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Index
index
Int
The index of the connected connection you want to get.
- Return Values
-
Name Type Description Connection
connection
Trace(RailroadTrackConnection) out
The connected connection at the given index.
Get Connections getConnections
(Array(Trace(RailroadTrackConnection)) Connections connections
out)
Returns a list of all connected connections.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Connections
connections
Array(Trace(RailroadTrackConnection)) out
A list of all connected connections.
Get Track Pos getTrackPos
(Trace(RailroadTrack) Track track
out, Float Offset offset
out, Float Forward forward
out)
Returns the track pos at which this connection is.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Track
track
Trace(RailroadTrack) out
The track the track pos points to.
Offset
offset
Float out
The offset of the track pos.
Forward
forward
Float out
The forward direction of the track pos. 1 = with the track direction, -1 = against the track direction
Get Track getTrack
(Trace(RailroadTrack) Track track
out)
Returns the track of which this connection is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Track
track
Trace(RailroadTrack) out
The track of which this connection is part of.
Get Switch Control getSwitchControl
(Trace(RailroadSwitchControl) Switch switchControl
out)
Returns the switch control of this connection.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Switch
switchControl
Trace(RailroadSwitchControl) out
The switch control of this connection.
Get Station getStation
(Trace(RailroadStation) Station station
out)
Returns the station of which this connection is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Station
station
Trace(RailroadStation) out
The station of which this connection is part of.
Get Facing Signal getFacingSignal
(Trace(RailroadSignal) Signal signal
out)
Returns the signal this connection is facing to.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Signal
signal
Trace(RailroadSignal) out
The signal this connection is facing.
Get Trailing Signal getTrailingSignal
(Trace(RailroadSignal) Signal signal
out)
Returns the signal this connection is trailing from.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Signal
signal
Trace(RailroadSignal) out
The signal this connection is trailing.
Get Opposite getOpposite
(Trace(RailroadTrackConnection) Opposite opposite
out)
Returns the opposite connection of the track this connection is part of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Opposite
opposite
Trace(RailroadTrackConnection) out
The opposite connection of the track this connection is part of.
Get Next getNext
(Trace(RailroadTrackConnection) Next next
out)
Returns the next connection in the direction of the track. (used the correct path switched point to)
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Next
next
Trace(RailroadTrackConnection) out
The next connection in the direction of the track.
Railroad Vehicle Movement RailroadVehicleMovement
Parent |
This actor component contains all the infomation about the movement of a railroad vehicle.
Properties
Float Orientation orientation
The orientation of the vehicle
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Payload Mass payloadMass
The mass of the payload of the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Speed speed
The current forward speed of the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Relative Speed relativeSpeed
The current relative forward speed to the ground.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Max Speed maxSpeed
The maximum forward speed the vehicle can reach.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Gravitationl Force gravitationalForce
The current gravitational force acting on the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Tractive Force tractiveForce
The current tractive force acting on the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Resistive Froce resistiveForce
The resistive force currently acting on the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Gradient Force gradientForce
The gradient force currently acting on the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Braking Force brakingForce
The braking force currently acting on the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Air Braking Force airBrakingForce
The air braking force currently acting on the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Dynamic Braking Force dynamicBrakingForce
The dynamic braking force currently acting on the vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Max Tractive Effort maxTractiveEffort
The maximum tractive effort of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Max Dynamic Braking Effort maxDynamicBrakingEffort
The maximum dynamic braking effort of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Max Air Braking Effort maxAirBrakingEffort
The maximum air braking effort of this vehcile.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Track Grade trackGrade
The current track grade of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Track Curvature trackCurvature
The current track curvature of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Wheelset Angle wheelsetAngle
The wheelset angle of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Rolling Resistance rollingResistance
The current rolling resistance of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Curvature Resistance curvatureResistance
The current curvature resistance of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Air Resistance airResistance
The current air resistance of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Gradient Resistance gradientResistance
The current gardient resistance of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Wheel Rotation wheelRotation
The current wheel rotation of this vehicle.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Vehicle getVehicle
(Trace(RailroadVehicle) Vehicle vehicle
out)
Returns the vehicle this movement component holds the movement information of.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Vehicle
vehicle
Trace(RailroadVehicle) out
The vehicle this movement component holds the movement information of.
Get Wheelset Rotation getWheelsetRotation
(Int Wheelset wheelset
, Float X x
out, Float Y y
out, Float Z z
out)
Returns the current rotation of the given wheelset.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Wheelset
wheelset
Int
The index of the wheelset you want to get the rotation of.
- Return Values
-
Name Type Description X
x
Float out
The wheelset’s rotation X component.
Y
y
Float out
The wheelset’s rotation Y component.
Z
z
Float out
The wheelset’s rotation Z component.
Get Wheelset Offset getWheelsetOffset
(Int Wheelset wheelset
, Float Offset offset
out)
Returns the offset of the wheelset with the given index from the start of the vehicle.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Wheelset
wheelset
Int
The index of the wheelset you want to get the offset of.
- Return Values
-
Name Type Description Offset
offset
Float out
The offset of the wheelset.
Get Coupler Rotation And Extention getCouplerRotationAndExtention
(Int Coupler coupler
, Float X x
out, Float Y y
out, Float Z z
out, Float Extention extention
out)
Returns the normal vector and the extention of the coupler with the given index.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Coupler
coupler
Int
The index of which you want to get the normal and extention of.
- Return Values
-
Name Type Description X
x
Float out
The X component of the coupler normal.
Y
y
Float out
The Y component of the coupler normal.
Z
z
Float out
The Z component of the coupler normal.
Extention
extention
Float out
The extention of the coupler.
Item Type ItemType
Parent |
The type of an item (iron plate, iron rod, leaves)
Properties
Int Form form
The matter state of this resource.
1: Solid
2: Liquid
3: Gas
4: Heat
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Float Energy energy
How much energy this resource provides if used as fuel.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Float Radioactive Decay radioactiveDecay
The amount of radiation this item radiates.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
String Description description
The description of this item.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Int Max max
The maximum stack size of this item.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Bool Can be Discarded canBeDiscarded
True if this item can be discarded.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Class(ItemCategory) Category category
The category in which this item is in.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Struct(Color) Fluid Color fluidColor
The color of this fluid.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Power Circuit PowerCircuit
Parent |
A Object that represents a whole power circuit.
Properties
Float Production production
The amount of power produced by the whole circuit in the last tick.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Consumption consumption
The power consumption of the whole circuit in thge last tick.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Capacity capacity
The power capacity of the whole network in the last tick. (The max amount of power available in the last tick)
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Battery Input batteryInput
The power that gone into batteries in the last tick.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Max Power Consumption maxPowerConsumption
The maximum consumption of power in the last tick.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Is Fuesed isFuesed
True if the fuse in the network triggered.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Bool Has Batteries hasBatteries
True if the power circuit has batteries connected to it.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Battery Capacity batteryCapacity
The energy capacity all batteries of the network combined provide.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Battery Store batteryStore
The amount of energy currently stored in all battereies of the network combined.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Battery Store Percentage batteryStorePercent
The fill status in percent of all battereies of the network combined.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Battery Time until Full batteryTimeUntilFull
The time in seconds until every battery in the network is filled.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Float Battery Time until Empty batteryTimeUntilEmpty
The time in seconds until every battery in the network is empty.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Recipe Recipe
Parent |
A struct that holds information about a recipe in its class. Means don’t use it as object, use it as class type!
Functions
Get Products getProducts
(Array(Struct(ItemAmount)) Products products
out)
Returns a array of item amounts, this recipe returns (outputs) when the recipe is processed once.
Flags |
ClassFunc RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Products
products
Array(Struct(ItemAmount)) out
The products of this recipe.
Get Ingredients getIngredients
(Array(Struct(ItemAmount)) Ingredients ingredients
out)
Returns a array of item amounts, this recipe needs (input) so the recipe can be processed.
Flags |
ClassFunc RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Ingredients
ingredients
Array(Struct(ItemAmount)) out
The ingredients of this recipe.
Reflection Base ReflectionBase
Parent |
The base class for all things of the reflection system.
Function Function
Parent |
A reflection object representing a function.
Properties
Int Flags flags
The function bit flag register defining some behaviour of it.
Bits and their meaing (least significant bit first):
Is this function has a variable amount of input parameters.
Can this function get called in syncrounus runtime.
Can this function can get called in parallel runtime.
Can this function get called in asynchronus runtime.
Is this function a member function.
The function is a class function.
The function is a static function.
The function has a variable amount of return values.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Property Property
Parent |
A Reflection object that holds information about properties and parameters.
Properties
Int Data Type dataType
The data type of this property.
0: nil, 1: bool, 2: int, 3: float, 4: str, 5: object, 6: class, 7: trace, 8: struct, 9: array, 10: anything
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Int Flags flags
The property bit flag register defining some behaviour of it.
Bits and their meaing (least significant bit first):
Is this property a member attribute.
Is this property read only.
Is this property a parameter.
Is this property a output paramter.
Is this property a return value.
Can this property get accessed in syncrounus runtime.
Can this property can get accessed in parallel runtime.
Can this property get accessed in asynchronus runtime.
This property is a class attribute.
Flags |
RuntimeSync RuntimeParallel ReadOnly |
Struct Struct
Parent |
Reflection Object that holds information about structures.
Functions
Get Parent getParent
(Object(Class) Parent parent
out)
Returns the parent type of this type.
Flags |
RuntimeSync |
- Return Values
-
Name Type Description Parent
parent
Object(Class) out
The parent type of this type.
Get Properties getProperties
(Array(Object(Property)) Properties properties
out)
Returns all the properties of this type.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Properties
properties
Array(Object(Property)) out
The properties this specific type implements (excluding properties from parent types).
Get All Properties getAllProperties
(Array(Object(Property)) Properties properties
out)
Returns all the properties of this and parent types.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Properties
properties
Array(Object(Property)) out
The properties this type implements including properties from parent types.
Get Functions getFunctions
(Array(Object(Function)) Functions functions
out)
Returns all the functions of this type.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Functions
functions
Array(Object(Function)) out
The functions this specific type implements (excluding properties from parent types).
Get All Functions getAllFunctions
(Array(Object(Property)) Functions functions
out)
Returns all the functions of this and parent types.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Functions
functions
Array(Object(Property)) out
The functions this type implements including functions from parent types.
Is Child Of isChildOf
(Object(Struct) Parent parent
, Bool Is Child isChild
out)
Allows to check if this struct is a child struct of the given struct or the given struct it self.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Parent
parent
Object(Struct)
The parent struct you want to check if this struct is a child of.
- Return Values
-
Name Type Description Is Child
isChild
Bool out
True if this struct is a child of parent.
Class Class
Parent |
Object that contains all information about a type.
Functions
Get Signals getSignals
(Array(Object(Signal)) Signals signals
out)
Returns all the signals of this type.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Signals
signals
Array(Object(Signal)) out
The signals this specific type implements (excluding properties from parent types).
Sign Type SignType
Parent |
Describes the type of a sign.
Properties
Struct(Vector2D) Dimensions dimensions
The canvas dimensions of this sign.
Flags |
ClassProp RuntimeSync RuntimeParallel ReadOnly |
Functions
Get Colors getColors
(Struct(Color) Foreground foreground
out, Struct(Color) Background background
out, Struct(Color) Auxiliary auxiliary
out)
Returns the default foreground/background/auxiliary colors of this sign type.
Flags |
ClassFunc RuntimeSync RuntimeParallel |
Get Prefabs getPrefabs
(Array(Class(SignPrefab)) Prefabs prefabs
out)
Returns a list of all sign prefabs this sign can use.
Flags |
ClassFunc RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Prefabs
prefabs
Array(Class(SignPrefab)) out
The sign prefabs this sign can use
Get Text Elements getTextElements
(Array(String) Text Elements Default Values textElementsDefaultValues
out)
Returns a list of element names and their default text values.
Flags |
ClassFunc RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Text Elements Default Values
textElementsDefaultValues
Array(String) out
A list of default values for the text elements of this type.
Get Icon Elements getIconElements
(Array(Object(Object)) Icon Elements Default Values iconElementsDefaultValues
out)
Returns a list of element names and their default icon values.
Flags |
ClassFunc RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Icon Elements Default Values
iconElementsDefaultValues
Array(Object(Object)) out
A list of default values for the icon elements of this type.
Structs
GPU T1 Buffer GPUT1Buffer
A structure that can hold a buffer of characters and colors that can be displayed with a gpu
Functions
Get Size getSize
(Float Width width
out, Float Height height
out)
Allows to get the dimensions of the buffer.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Return Values
-
Name Type Description Width
width
Float out
The width of this buffer
Height
height
Float out
The height of this buffer
Set Size setSize
(Float Width width
, Float Height height
)
Allows to set the dimensions of the buffer.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description Width
width
Float
The width this buffer should now have
Height
height
Float
The height this buffer now have
Get get
(Int X x
, Int Y y
, String Char c
out, Struct(Color) Foreground Color foreground
out, Struct(Color) Background Color background
out)
Allows to get a single pixel from the buffer at the given position
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description X
x
Int
The x position of the character you want to get
Y
y
Int
The y position of the character you want to get
Set set
(Int X x
, Int Y y
, String Char c
, Struct(Color) Foreground Color foreground
, Struct(Color) Background Color background
, Bool Done done
out)
Allows to set a single pixel of the buffer at the given position
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description X
x
Int
The x position of the character you want to set
Y
y
Int
The y position of the character you want to set
Char
c
String
The character the pixel should have
Foreground Color
foreground
Struct(Color)
The foreground color the pixel at the given position should have
Background Color
background
Struct(Color)
The background color the pixel at the given position should have
- Return Values
-
Name Type Description Done
done
Bool out
True if the pixel got set successfully
Copy copy
(Int X x
, Int Y y
, Struct(GPUT1Buffer) Buffer buffer
, Int Text Blend Mode textBlendMode
, Int Foreground Color Blend Mode foregroundBlendMode
, Int Background Color Blend Mode backgroundBlendMode
)
Copies the given buffer at the given offset of the upper left corner into this buffer.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description X
x
Int
The x offset of the upper left corner of the buffer relative to this buffer
Y
y
Int
The y offset of the upper left corener of the buffer relative to this buffer
Buffer
buffer
Struct(GPUT1Buffer)
The buffer from wich you want to copy from
Text Blend Mode
textBlendMode
Int
The blend mode that is used for the text.
0 = Overwrite this with the content of the given buffer
1 = Overwrite with only characters that are not ' '
2 = Overwrite only were this characters are ' '
3 = Keep this bufferForeground Color Blend Mode
foregroundBlendMode
Int
The blend mode that is used for the foreground color.
0 = Overwrite with the given color
1 = Normal alpha composition
2 = Multiply
3 = Divide
4 = Addition
5 = Subtraction
6 = Difference
7 = Darken Only
8 = Lighten Only
9 = NoneBackground Color Blend Mode
backgroundBlendMode
Int
The blend mode that is used for the background color.
0 = Overwrite with the given color
1 = Normal alpha composition
2 = Multiply
3 = Divide
4 = Addition
5 = Subtraction
6 = Difference
7 = Darken Only
8 = Lighten Only
9 = None
Set Text setText
(Int X x
, Int Y y
, String Text text
, Struct(Color) Foreground foreground
, Struct(Color) Background background
)
Allows to write the given text onto the buffer and with the given offset.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description X
x
Int
The X Position at which the text should begin to get written.
Y
y
Int
The Y Position at which the text should begin to get written.
Text
text
String
The text that should get written.
Foreground
foreground
Struct(Color)
The foreground color which will be used to write the text.
Background
background
Struct(Color)
The background color which will be used to write the text.
Fill fill
(Int X x
, Int Y y
, Int Width width
, Int Height height
, String Character character
, Struct(Color) Foreground foreground
, Struct(Color) Background background
)
Draws the given character at all given positions in the given rectangle on-to the hidden screen buffer.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description X
x
Int
The x coordinate at which the rectangle should get drawn. (upper-left corner)
Y
y
Int
The y coordinate at which the rectangle should get drawn. (upper-left corner)
Width
width
Int
The width of the rectangle.
Height
height
Int
The height of the rectangle.
Character
character
String
A string with a single character that will be used for each pixel in the range you want to fill.
Foreground
foreground
Struct(Color)
The foreground color which will be used to fill the rectangle.
Background
background
Struct(Color)
The background color which will be used to fill the rectangle.
Set Raw setRaw
(String Characters characters
, Array(Float) Foreground Color foreground
, Array(Float) Background Color background
, Bool Success success
out)
Allows to set the internal data of the buffer more directly.
Flags |
RuntimeSync RuntimeParallel RuntimeAsync |
- Parameters
-
Name Type Description Characters
characters
String
The characters you want to draw with a length of exactly width*height.
Foreground Color
foreground
Array(Float)
The values of the foreground color slots for each character were a group of four values give one color. so the length has to be exactly width*height*4.
Background Color
background
Array(Float)
The values of the background color slots for each character were a group of four values give one color. so the length has to be exactly width*height*4.
- Return Values
-
Name Type Description Success
success
Bool out
True if the raw data was successfully written
Clone clone
(Struct(GPUT1Buffer) Buffer buffer
out)
Clones this buffer into a new struct
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Buffer
buffer
Struct(GPUT1Buffer) out
The clone of this buffer
Item Stack ItemStack
A structure that holds item information and item amount to represent an item stack.
Prefab Sign Data PrefabSignData
This structure stores all data that defines what a sign displays.
Properties
Class(Object) Layout layout
The object that actually displayes the layout
Flags |
RuntimeSync RuntimeParallel |
Class(SignType) Sign Type signType
The type of sign this prefab fits to.
Flags |
RuntimeSync RuntimeParallel |
Functions
Get Text Elements getTextElements
(Array(String) Text Elements textElements
out, Array(String) Text Element Values textElementValues
out)
Returns all text elements and their values.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Text Elements
textElements
Array(String) out
The element names for all text elements.
Text Element Values
textElementValues
Array(String) out
The values for all text elements.
Get Icon Elements getIconElements
(Array(String) Icon Elements iconElements
out, Array(Int) Icon Element Values iconElementValues
out)
Returns all icon elements and their values.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Icon Elements
iconElements
Array(String) out
The element names for all icon elements.
Icon Element Values
iconElementValues
Array(Int) out
The values for all icon elements.
Set Text Elements setTextElements
(Array(String) Text Elements textElements
, Array(String) Text Element Values textElementValues
)
Sets all text elements and their values.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Text Elements
textElements
Array(String)
The element names for all text elements.
Text Element Values
textElementValues
Array(String)
The values for all text elements.
Set Icon Elements setIconElements
(Array(String) Icon Elements iconElements
, Array(Int) Icon Element Values iconElementValues
)
Sets all icon elements and their values.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Icon Elements
iconElements
Array(String)
The element names for all icon elements.
Icon Element Values
iconElementValues
Array(Int)
The values for all icon elements.
Set Text Element setTextElement
(String Element Name elementName
, String Value value
)
Sets a text element with the given element name.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Element Name
elementName
String
The name of the text element
Value
value
String
The value of the text element
Set Icon Element setIconElement
(String Element Name elementName
, Int Value value
)
Sets a icon element with the given element name.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Element Name
elementName
String
The name of the icon element
Value
value
Int
The value of the icon element
Get Text Element getTextElement
(String Element Name elementName
, Int Value value
out)
Gets a text element with the given element name.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Element Name
elementName
String
The name of the text element
- Return Values
-
Name Type Description Value
value
Int out
The value of the text element
Get Icon Element getIconElement
(String Element Name elementName
, Int Value value
out)
Gets a icon element with the given element name.
Flags |
RuntimeSync RuntimeParallel |
- Parameters
-
Name Type Description Element Name
elementName
String
The name of the icon element
- Return Values
-
Name Type Description Value
value
Int out
The value of the icon element
Rotator Rotator
Contains rotation information about a object in 3D spaces using 3 rotation axis in a gimble.
Target Point TargetPoint
Target Point in the waypoint list of a wheeled vehicle.
Properties
Struct(Vector) Pos pos
The position of the target point in the world.
Flags |
RuntimeSync RuntimeParallel |
Struct(Rotator) Rot rot
The rotation of the target point in the world.
Flags |
RuntimeSync RuntimeParallel |
Time Table Stop TimeTableStop
Information about a train stop in a time table.
Properties
Trace(RailroadStation) Station station
The station at which the train should stop
Flags |
RuntimeSync RuntimeParallel |
Struct(TrainDockingRuleSet) Rule Set ruleset
The rule set wich describe when the train will depart from the train station
Flags |
RuntimeSync RuntimeParallel |
Track Graph TrackGraph
Struct that holds a cache of a whole train/rail network.
Functions
Get Trains getTrains
(Array(Trace(Train)) Trains trains
out)
Returns a list of all trains in the network.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Trains
trains
Array(Trace(Train)) out
The list of trains in the network.
Get Stations getStations
(Array(Trace(RailroadStation)) Stations stations
out)
Returns a list of all trainstations in the network.
Flags |
RuntimeSync RuntimeParallel |
- Return Values
-
Name Type Description Stations
stations
Array(Trace(RailroadStation)) out
The list of trainstations in the network.
Train Docking Rule Set TrainDockingRuleSet
Contains infromation about the rules that descibe when a trian should depart from a station
Properties
Int Defintion definition
0 = Load/Unload Once, 1 = Fully Load/Unload
Flags |
RuntimeSync RuntimeParallel |
Float Duration duration
The amount of time the train will dock at least.
Flags |
RuntimeSync RuntimeParallel |
Bool Is Duration and Rule isDurationAndRule
True if the duration of the train stop and the other rules have to be applied.
Flags |
RuntimeSync RuntimeParallel |
Array(Class(ItemType)) Load Filters loadFilters
The types of items that will be loaded.
Flags |
RuntimeSync RuntimeParallel |
Array(Class(ItemType)) Unload Filters unloadFilters
The types of items that will be unloaded.
Flags |
RuntimeSync RuntimeParallel |