|
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...
|
|
|
static T | GetInstance< T > (EGID egid, Func< EGID, T > constructor, Type type=null) |
| Returns a cached instance if there's an actively used instance of the object already. Objects still get garbage collected and then they will be removed from the cache. More...
|
|
static WeakDictionary< EGID, EcsObjectBase > | GetInstances (Type type) |
|
static Block | New (EGID egid, bool signaling=false) |
| Returns a correctly typed instance of this block. The instances are shared for a specific block. If an instance is no longer referenced a new instance is returned. 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...
|
|
BlockComplexity | Complexity [get, set] |
| Block complexity used for build rules. Determines the 'cost' of the block. 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] |
|
EGID | Id [get] |
|
uint | InputCount [get] |
| The input port count. More...
|
|
bool | InputIsExtension [get, set] |
| Gets or sets the Piston's InputIsExtension property. Tweakable stat. 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...
|
|
float | Mass [get] |
| The mass of the block. More...
|
|
BlockMaterial?? | Material [get, set] |
|
float | MaxExtension [get, set] |
| Gets or sets the Piston's MaxExtension property. Tweakable stat. More...
|
|
float | MaximumForce [get, set] |
| Gets or sets the Piston's MaximumForce property. Tweakable stat. More...
|
|
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...
|
|
bool | Static [get, set] |
| Whether the block should be static in simulation. If set, it cannot be moved. The effect is temporary, it will not be saved with the block. 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...
|
|
◆ Piston() [1/2]
TechbloxModdingAPI.Blocks.Piston.Piston |
( |
EGID |
egid | ) |
|
|
inline |
Constructs a(n) Piston object representing an existing block.
◆ Piston() [2/2]
TechbloxModdingAPI.Blocks.Piston.Piston |
( |
uint |
id | ) |
|
|
inline |
Constructs a(n) Piston object representing an existing block.
◆ 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()
OptionalRef<ChannelDataStruct> TechbloxModdingAPI.Blocks.SignalingBlock.GetChannelData |
( |
EGID |
portId | ) |
|
|
inlineprotectedinherited |
[EXPERIMENTAL] Gets the channel data.
- Returns
- The channel data.
- Parameters
-
◆ 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 |
( |
PortEntityStruct |
port, |
|
|
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.
◆ GetInstance< T >()
static T TechbloxModdingAPI.EcsObjectBase.GetInstance< T > |
( |
EGID |
egid, |
|
|
Func< EGID, T > |
constructor, |
|
|
Type |
type = null |
|
) |
| |
|
inlinestaticpackageinherited |
Returns a cached instance if there's an actively used instance of the object already. Objects still get garbage collected and then they will be removed from the cache.
- Parameters
-
egid | The EGID of the entity |
constructor | The constructor to construct the object |
- Template Parameters
-
- Returns
◆ GetInstances()
|
inlinestaticpackageinherited |
◆ 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, |
|
|
bool |
signaling = false |
|
) |
| |
|
inlinestaticpackageinherited |
Returns a correctly typed instance of this block. The instances are shared for a specific block. If an instance is no longer referenced a new instance is returned.
- Parameters
-
egid | The EGID of the block |
signaling | Whether the block is definitely a signaling block |
- Returns
◆ 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
bool TechbloxModdingAPI.Block.Exists => BlockEngine.BlockExists(Id) |
|
inherited |
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
◆ Complexity
Block complexity used for build rules. Determines the 'cost' of the block.
◆ 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
EGID TechbloxModdingAPI.EcsObjectBase.Id |
|
getinherited |
◆ InputCount
uint TechbloxModdingAPI.Blocks.SignalingBlock.InputCount |
|
getinherited |
◆ InputIsExtension
bool TechbloxModdingAPI.Blocks.Piston.InputIsExtension |
|
getset |
Gets or sets the Piston's InputIsExtension property. Tweakable stat.
◆ 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.
◆ Mass
float TechbloxModdingAPI.Block.Mass |
|
getinherited |
◆ Material
◆ MaxExtension
float TechbloxModdingAPI.Blocks.Piston.MaxExtension |
|
getset |
Gets or sets the Piston's MaxExtension property. Tweakable stat.
◆ MaximumForce
float TechbloxModdingAPI.Blocks.Piston.MaximumForce |
|
getset |
Gets or sets the Piston's MaximumForce property. Tweakable stat.
◆ 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.
◆ Static
bool TechbloxModdingAPI.Block.Static |
|
getsetinherited |
Whether the block should be static in simulation. If set, it cannot be moved. The effect is temporary, it will not be saved with the block.
◆ 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: