|
static Block | GetLastPlacedBlock () |
| Returns the most recently placed block. More...
|
|
static void | Init () |
|
static Block | PlaceNew (BlockIDs block, float3 position, bool autoWire=false, Player player=null) |
| Place a new block at the given position. If scaled, position means the center of the block. The default block size is 0.2 in terms of position. Place blocks next to each other to connect them. The placed block will be a complete block with a placement grid and collision which will be saved along with the game. More...
|
|
|
bool | Exists => BlockEngine.BlockExists(Id) |
| Whether the block exists. The other properties will return a default value if the block doesn't exist. If the block was just placed, then this will also return false but the properties will work correctly. More...
|
|
|
BlockGroup??????? | BlockGroup [get, set] |
| Returns the block group this block is a part of. Block groups can also be placed using blueprints. Returns null if not part of a group, although all blocks should have their own by default.
Setting the group after the block has been initialized will not update everything properly, so you can only set this property on blocks newly placed by your code.
To set it for existing blocks, you can use the Copy() method and set the property on the resulting block (and remove this block). More...
|
|
BlockColor? | Color [get, set] |
| The block's color. Returns BlockColors.Default if the block no longer exists. More...
|
|
float4 | CustomColor [get, set] |
| The block's exact color. Gets reset to the palette color (Color property) after reentering the game. More...
|
|
bool? | Flipped [get, set] |
|
override EGID | Id [get] |
|
uint | InputCount [get] |
| The input port count. More...
|
|
string? | Label [get, set] |
| The text displayed on the block if applicable, or null. Setting it is temporary to the session, it won't be saved. More...
|
|
BlockMaterial? | Material [get, set] |
|
uint | OutputCount [get] |
| The output port count. More...
|
|
float3 | Position [get, set] |
| The block's current position or zero if the block no longer exists. A block is 0.2 wide by default in terms of position. More...
|
|
float3 | Rotation [get, set] |
| The block's current rotation in degrees or zero if the block doesn't exist. More...
|
|
float3 | Scale [get, set] |
| The block's non-uniform scale or zero if the block's invalid. Independent of the uniform scaling. The default scale of 1 means 0.2 in terms of position. More...
|
|
string | Text [get, set] |
| The text block's current text. More...
|
|
string | TextBlockId [get, set] |
| The text block's current text block ID (used in ChangeTextBlockCommand). More...
|
|
BlockIDs? | Type [get] |
| The block's type (ID). Returns BlockIDs.Invalid if the block doesn't exist anymore. More...
|
|
int | UniformScale [get, set] |
| The block's uniform scale or zero if the block's invalid. Also sets the non-uniform scale. The default scale of 1 means 0.2 in terms of position. More...
|
|
◆ TextBlock() [1/2]
TechbloxModdingAPI.Blocks.TextBlock.TextBlock |
( |
EGID |
id | ) |
|
|
inline |
◆ TextBlock() [2/2]
TechbloxModdingAPI.Blocks.TextBlock.TextBlock |
( |
uint |
id | ) |
|
|
inline |
◆ Connect()
Wire TechbloxModdingAPI.Blocks.SignalingBlock.Connect |
( |
byte |
sourcePort, |
|
|
SignalingBlock |
destination, |
|
|
byte |
destinationPort |
|
) |
| |
|
inlineinherited |
Connect an output on this block to an input on another block.
- Parameters
-
sourcePort | Output port number. |
destination | Input block. |
destinationPort | Input port number. |
- Returns
- The wire connection
- Exceptions
-
◆ ConnectedToOutput()
Wire [] TechbloxModdingAPI.Blocks.SignalingBlock.ConnectedToOutput |
( |
byte |
port | ) |
|
|
inlineinherited |
All wires connected to the output port. These wires will always be wired output -> input.
- Parameters
-
- Returns
- Wires connected to the output port.
◆ Copy()
Block TechbloxModdingAPI.Block.Copy |
( |
| ) |
|
|
inlineinherited |
Creates a copy of the block in the game with the same properties, stats and wires.
- Returns
◆ Equals() [1/3]
bool TechbloxModdingAPI.Block.Equals |
( |
Block |
other | ) |
|
|
inlineinherited |
◆ Equals() [2/3]
bool TechbloxModdingAPI.Block.Equals |
( |
EGID |
other | ) |
|
|
inlineinherited |
◆ Equals() [3/3]
override bool TechbloxModdingAPI.Block.Equals |
( |
object |
obj | ) |
|
|
inlineinherited |
◆ GetChannelData()
ref ChannelDataStruct TechbloxModdingAPI.Blocks.SignalingBlock.GetChannelData |
( |
EGID |
portId, |
|
|
out bool |
exists |
|
) |
| |
|
inlineprotectedinherited |
[EXPERIMENTAL] Gets the channel data.
- Returns
- The channel data.
- Parameters
-
portId | Port identifier. |
exists | Whether the channel actually exists. |
◆ GetConnectedCubes()
Block [] TechbloxModdingAPI.Block.GetConnectedCubes |
( |
| ) |
|
|
inlineinherited |
Returns an array of blocks that are connected to this one. Returns an empty array if the block doesn't exist.
◆ GetConnectedWire()
ref WireEntityStruct TechbloxModdingAPI.Blocks.SignalingBlock.GetConnectedWire |
( |
EGID |
portId, |
|
|
out bool |
connected |
|
) |
| |
|
inlineprotectedinherited |
Gets the connected wire.
- Returns
- The connected wire.
- Parameters
-
portId | Port identifier. |
connected | Whether the port has a wire connected to it. |
◆ GetHashCode()
override int TechbloxModdingAPI.Block.GetHashCode |
( |
| ) |
|
|
inlineinherited |
◆ GetInputIds()
EGID [] TechbloxModdingAPI.Blocks.SignalingBlock.GetInputIds |
( |
| ) |
|
|
inlineprotectedinherited |
Generates the input port identifiers.
- Returns
- The input identifiers.
◆ GetLastPlacedBlock()
static Block TechbloxModdingAPI.Block.GetLastPlacedBlock |
( |
| ) |
|
|
inlinestaticinherited |
Returns the most recently placed block.
- Returns
- The block object or null if doesn't exist
◆ GetOutputIds()
EGID [] TechbloxModdingAPI.Blocks.SignalingBlock.GetOutputIds |
( |
| ) |
|
|
inlineprotectedinherited |
Generates the output port identifiers.
- Returns
- The output identifiers.
◆ Init()
static void TechbloxModdingAPI.Block.Init |
( |
| ) |
|
|
inlinestaticinherited |
◆ InputPortName()
string TechbloxModdingAPI.Blocks.SignalingBlock.InputPortName |
( |
byte |
port | ) |
|
|
inlineinherited |
The input port's name.
- Parameters
-
- Returns
- The port name, localized to the user's language.
◆ New()
static Block TechbloxModdingAPI.Block.New |
( |
EGID |
egid | ) |
|
|
inlinestaticpackageinherited |
◆ PlaceNew()
static Block TechbloxModdingAPI.Block.PlaceNew |
( |
BlockIDs |
block, |
|
|
float3 |
position, |
|
|
bool |
autoWire = false , |
|
|
Player |
player = null |
|
) |
| |
|
inlinestaticinherited |
Place a new block at the given position. If scaled, position means the center of the block. The default block size is 0.2 in terms of position. Place blocks next to each other to connect them. The placed block will be a complete block with a placement grid and collision which will be saved along with the game.
- Parameters
-
block | The block's type |
position | The block's position - default block size is 0.2 |
autoWire | Whether the block should be auto-wired (if functional) |
player | The player who placed the block |
- Returns
- The placed block or null if failed
◆ PortName()
string TechbloxModdingAPI.Blocks.SignalingBlock.PortName |
( |
byte |
port, |
|
|
bool |
input |
|
) |
| |
|
inlineinherited |
The port's name. This is localized to the user's language, so this is not reliable for port identification.
- Parameters
-
port | Port number. |
input | Whether the port is an input (true) or an output (false). |
- Returns
- The localized port name.
◆ ToString()
override string TechbloxModdingAPI.Block.ToString |
( |
| ) |
|
|
inlineinherited |
◆ BlockCloneEngine
◆ BlockEngine
◆ BlockEventsEngine
◆ Exists
Whether the block exists. The other properties will return a default value if the block doesn't exist. If the block was just placed, then this will also return false but the properties will work correctly.
◆ InitData
◆ MovementEngine
◆ PlacementEngine
◆ RemovalEngine
◆ RotationEngine
◆ ScalingEngine
◆ SignalEngine
◆ BlockGroup
BlockGroup??????? TechbloxModdingAPI.Block.BlockGroup |
|
getsetinherited |
Returns the block group this block is a part of. Block groups can also be placed using blueprints. Returns null if not part of a group, although all blocks should have their own by default.
Setting the group after the block has been initialized will not update everything properly, so you can only set this property on blocks newly placed by your code.
To set it for existing blocks, you can use the Copy() method and set the property on the resulting block (and remove this block).
◆ Color
◆ CustomColor
float4 TechbloxModdingAPI.Block.CustomColor |
|
getsetinherited |
The block's exact color. Gets reset to the palette color (Color property) after reentering the game.
◆ Flipped
bool? TechbloxModdingAPI.Block.Flipped |
|
getsetinherited |
Whether the block is flipped.
◆ Id
override EGID TechbloxModdingAPI.Block.Id |
|
getinherited |
◆ InputCount
uint TechbloxModdingAPI.Blocks.SignalingBlock.InputCount |
|
getinherited |
◆ Label
string? TechbloxModdingAPI.Block.Label |
|
getsetinherited |
The text displayed on the block if applicable, or null. Setting it is temporary to the session, it won't be saved.
◆ Material
◆ OutputCount
uint TechbloxModdingAPI.Blocks.SignalingBlock.OutputCount |
|
getinherited |
◆ Position
float3 TechbloxModdingAPI.Block.Position |
|
getsetinherited |
The block's current position or zero if the block no longer exists. A block is 0.2 wide by default in terms of position.
◆ Rotation
float3 TechbloxModdingAPI.Block.Rotation |
|
getsetinherited |
The block's current rotation in degrees or zero if the block doesn't exist.
◆ Scale
float3 TechbloxModdingAPI.Block.Scale |
|
getsetinherited |
The block's non-uniform scale or zero if the block's invalid. Independent of the uniform scaling. The default scale of 1 means 0.2 in terms of position.
◆ Text
string TechbloxModdingAPI.Blocks.TextBlock.Text |
|
getset |
The text block's current text.
◆ TextBlockId
string TechbloxModdingAPI.Blocks.TextBlock.TextBlockId |
|
getset |
The text block's current text block ID (used in ChangeTextBlockCommand).
◆ Type
The block's type (ID). Returns BlockIDs.Invalid if the block doesn't exist anymore.
◆ UniformScale
int TechbloxModdingAPI.Block.UniformScale |
|
getsetinherited |
The block's uniform scale or zero if the block's invalid. Also sets the non-uniform scale. The default scale of 1 means 0.2 in terms of position.
◆ Placed
An event that fires each time a block is placed.
◆ Removed
An event that fires each time a block is removed.
The documentation for this class was generated from the following file: