IMyCubeBlock Interface |
[This is preliminary documentation and is subject to change.]
Namespace: VRage.Game.ModAPI
public interface IMyCubeBlock : IMyCubeBlock, IMyEntity
The IMyCubeBlock type exposes the following members.
Name | Description | |
---|---|---|
BlockDefinition | ||
CastShadows | (Inherited from IMyEntity.) | |
CheckConnectionAllowed |
Whether the grid should call the ConnectionAllowed method for this block
(ConnectionAllowed checks mount points and other per-block requirements)
| |
Closed | (Inherited from IMyEntity.) | |
Components | (Inherited from IMyEntity.) | |
CubeGrid |
Grid in which the block is placed
| |
DebugAsyncLoading | (Inherited from IMyEntity.) | |
DefinitionDisplayNameText |
Definition name
| |
DisassembleRatio |
Is set in definition
Ratio at which is the block disassembled (grinding)
| |
DisplayName | (Inherited from IMyEntity.) | |
DisplayNameText |
Translated block name
| |
EntityId | (Inherited from IMyEntity.) | |
FastCastShadowResolve | (Inherited from IMyEntity.) | |
Flags | (Inherited from IMyEntity.) | |
GameLogic | (Inherited from IMyEntity.) | |
Hierarchy | (Inherited from IMyEntity.) | |
InScene | (Inherited from IMyEntity.) | |
InvalidateOnMove | (Inherited from IMyEntity.) | |
IsBeingHacked | ||
IsCCDForProjectiles | (Inherited from IMyEntity.) | |
IsFunctional |
True if integrity is above breaking threshold
| |
IsVolumetric | (Inherited from IMyEntity.) | |
IsWorking |
True if block is able to do its work depening on block type (is functional, powered, enabled, etc...)
| |
LocalAABB | (Inherited from IMyEntity.) | |
LocalAABBHr | (Inherited from IMyEntity.) | |
LocalMatrix | (Inherited from IMyEntity.) | |
LocalVolume | (Inherited from IMyEntity.) | |
LocalVolumeOffset | (Inherited from IMyEntity.) | |
LocationForHudMarker | (Inherited from IMyEntity.) | |
MarkedForClose | (Inherited from IMyEntity.) | |
Mass |
Block mass
| |
Max |
Maximum coordinates of grid cells occupied by this block
| |
MaxGlassDistSq | (Inherited from IMyEntity.) | |
Min |
Minimum coordinates of grid cells occupied by this block
| |
Name | (Inherited from IMyEntity.) | |
NearFlag | (Inherited from IMyEntity.) | |
NeedsDraw | (Inherited from IMyEntity.) | |
NeedsDrawFromParent | (Inherited from IMyEntity.) | |
NeedsResolveCastShadow | (Inherited from IMyEntity.) | |
NeedsUpdate | (Inherited from IMyEntity.) | |
NumberInGrid |
Order in which were the blocks of same type added to grid
Used in default display name
| |
Orientation |
Returns block orientation in base 6 directions
| |
OwnerId |
Id of player owning block (not steam Id)
| |
Parent | (Inherited from IMyEntity.) | |
PersistentFlags | (Inherited from IMyEntity.) | |
Physics | (Inherited from IMyEntity.) | |
Position |
Position in grid coordinates
| |
PositionComp | (Inherited from IMyEntity.) | |
Render | (Inherited from IMyEntity.) | |
Save | (Inherited from IMyEntity.) | |
ShadowBoxLod | (Inherited from IMyEntity.) | |
SkipIfTooSmall | (Inherited from IMyEntity.) | |
SyncObject | (Inherited from IMyEntity.) | |
Transparent | (Inherited from IMyEntity.) | |
UpgradeValues |
Get all values changed by upgrade modules
Should only be used as read-only
| |
Visible | (Inherited from IMyEntity.) | |
WorldAABB | (Inherited from IMyEntity.) | |
WorldAABBHr | (Inherited from IMyEntity.) | |
WorldMatrix | (Inherited from IMyEntity.) | |
WorldMatrixInvScaled | (Inherited from IMyEntity.) | |
WorldMatrixNormalizedInv | (Inherited from IMyEntity.) | |
WorldVolume | (Inherited from IMyEntity.) | |
WorldVolumeHr | (Inherited from IMyEntity.) |
Name | Description | |
---|---|---|
AddToGamePruningStructure | (Inherited from IMyEntity.) | |
AddUpgradeValue |
Preferred way of registering a block for upgrades
Adding directly to the dictionary can have unintended consequences
when multiple mods are involved.
| |
BeforeSave | (Inherited from IMyEntity.) | |
CalcLocalMatrix | ||
CalculateCurrentModel |
Calculates model currently used by block depending on its build progress and other factors
| |
Close | (Inherited from IMyEntity.) | |
DebugDraw |
Debug only method. Effects may wary through time.
| |
DebugDrawInvalidTriangles | (Inherited from IMyEntity.) | |
Delete | (Inherited from IMyEntity.) | |
DoOverlapSphereTest | (Inherited from IMyEntity.) | |
EnableColorMaskForSubparts | (Inherited from IMyEntity.) | |
GetChildren | (Inherited from IMyEntity.) | |
GetDiffuseColor | (Inherited from IMyEntity.) | |
GetDistanceBetweenCameraAndBoundingSphere | (Inherited from IMyEntity.) | |
GetDistanceBetweenCameraAndPosition | (Inherited from IMyEntity.) | |
GetFriendlyName | (Inherited from IMyEntity.) | |
GetIntersectionWithLineAndBoundingSphere | (Inherited from IMyEntity.) | |
GetIntersectionWithSphere | (Inherited from IMyEntity.) | |
GetLargestDistanceBetweenCameraAndBoundingSphere | (Inherited from IMyEntity.) | |
GetObjectBuilder | (Inherited from IMyEntity.) | |
GetObjectBuilderCubeBlock |
Returns block object builder which can be serialized or added to grid
| |
GetOwnerFactionTag | ||
GetPlayerRelationToOwner | ||
GetPosition | (Inherited from IMyEntity.) | |
GetSmallestDistanceBetweenCameraAndBoundingSphere | (Inherited from IMyEntity.) | |
GetSubpart | (Inherited from IMyEntity.) | |
GetTopMostParent | (Inherited from IMyEntity.) | |
GetTrianglesIntersectingSphere | (Inherited from IMyEntity.) | |
GetUserRelationToOwner | ||
GetViewMatrix | (Inherited from IMyEntity.) | |
GetWorldMatrixNormalizedInv | (Inherited from IMyEntity.) | |
Init |
Reloads block model and interactive objects (doors, terminals, etc...)
| |
Init(MyObjectBuilder_CubeBlock, IMyCubeGrid) |
Initializes block state from object builder
| |
IsVisible | (Inherited from IMyEntity.) | |
OnAddedToScene | (Inherited from IMyEntity.) | |
OnBuildSuccess |
Method called when a block has been built (after adding to the grid).
This is called right after placing the block and it doesn't matter whether
it is fully built (creative mode) or is only construction site.
Note that it is not called for blocks which do not create FatBlock at that moment.
| |
OnDestroy |
Called when block is destroyed before being removed from grid
| |
OnModelChange |
Called when the model referred by the block is changed
| |
OnRegisteredToGridSystems |
Called at the end of registration from grid systems (after block has been registered).
| |
OnRemovedByCubeBuilder |
Method called when user removes a cube block from grid. Useful when block
has to remove some other attached block (like motors).
| |
OnRemovedFromScene | (Inherited from IMyEntity.) | |
OnUnregisteredFromGridSystems |
Called at the end of unregistration from grid systems (after block has been unregistered).
| |
RaycastDetectors |
Gets the name of interactive object intersected by defined line
| |
ReloadDetectors |
Reloads detectors (interactive objects) in model
| |
RemoveFromGamePruningStructure | (Inherited from IMyEntity.) | |
SetColorMaskForSubparts | (Inherited from IMyEntity.) | |
SetDamageEffect |
Start or stop dammage effect on cube block
| |
SetEmissiveParts |
Sets the emissive value of a specific emissive material on entity.
(Inherited from IMyEntity.) | |
SetEmissivePartsForSubparts |
Sets the emissive value of a specific emissive material on all entity subparts.
(Inherited from IMyEntity.) | |
SetLocalMatrix | (Inherited from IMyEntity.) | |
SetPosition | (Inherited from IMyEntity.) | |
SetWorldMatrix | (Inherited from IMyEntity.) | |
TryGetSubpart | (Inherited from IMyEntity.) | |
UpdateGamePruningStructure | (Inherited from IMyEntity.) | |
UpdateIsWorking |
Force refresh working state. Call if you change block state that could affect its working status.
| |
UpdateVisual |
Updates block visuals (ie. block emissivity)
|
Name | Description | |
---|---|---|
IsWorkingChanged | ||
OnClose | (Inherited from IMyEntity.) | |
OnClosing | (Inherited from IMyEntity.) | |
OnMarkForClose | (Inherited from IMyEntity.) | |
OnPhysicsChanged | (Inherited from IMyEntity.) | |
OnUpgradeValuesChanged |
Event called when upgrade values are changed
Either upgrades were built or destroyed, or they become damaged or unpowered
|