Class MyCubeBlockDefinition

Inheritance

System.Object

MyDefinitionBase

MyPhysicalModelDefinition

MyCubeBlockDefinition

MyFunctionalBlockDefinition

MyWarheadDefinition

Inherited Members

MyPhysicalModelDefinition.Model

MyPhysicalModelDefinition.PhysicalMaterial

MyPhysicalModelDefinition.Mass

MyPhysicalModelDefinition.UseInstanceRender

MyDefinitionBase.Id

MyDefinitionBase.DisplayNameEnum

MyDefinitionBase.DescriptionEnum

MyDefinitionBase.DisplayNameString

MyDefinitionBase.DescriptionString

MyDefinitionBase.DescriptionArgs

MyDefinitionBase.Icons

MyDefinitionBase.Enabled

MyDefinitionBase.Public

MyDefinitionBase.AvailableInSurvival

MyDefinitionBase.Context

MyDefinitionBase.Init(MyObjectBuilder_DefinitionBase, MyModContext)

MyDefinitionBase.Postprocess()

MyDefinitionBase.ToString()

MyDefinitionBase.CheckDefinitionDLCs(String[])

MyDefinitionBase.DLCs

MyDefinitionBase.DescriptionText

Namespace: Sandbox.Definitions

Assembly: Sandbox.Game.dll

Syntax

[MyDefinitionType]
public class MyCubeBlockDefinition : MyPhysicalModelDefinition

Constructors

MyCubeBlockDefinition()

Declaration

public MyCubeBlockDefinition()

Fields

ActionSound

Declaration

public MySoundPair ActionSound

Field Value

Type	Description
MySoundPair

AimingOffset

Declaration

public Nullable<Vector3> AimingOffset

Field Value

Type	Description
System.Nullable<Vector3>

AllowInteractionThroughBlock

Declaration

public bool AllowInteractionThroughBlock

Field Value

Type	Description
System.Boolean

AmmoExplosionEffect

Declaration

public string AmmoExplosionEffect

Field Value

Type	Description
System.String

AmmoExplosionSound

Declaration

public string AmmoExplosionSound

Field Value

Type	Description
System.String

AutorotateMode

Declaration

public MyAutorotateMode AutorotateMode

Field Value

Type	Description
MyAutorotateMode

BlockPairName

Declaration

public string BlockPairName

Field Value

Type	Description
System.String

BlockStages

Array of block stages. Stage represents other block definition which have different UV mapping, mirrored model, etc (stone rounded corner...). Stages can be cycled when building cubes.

Declaration

public MyDefinitionId[] BlockStages

Field Value

Type	Description
MyDefinitionId[]

BlockTopology

Declaration

public MyBlockTopology BlockTopology

Field Value

Type	Description
MyBlockTopology

BlockVariantsGroup

Declaration

public MyBlockVariantGroup BlockVariantsGroup

Field Value

Type	Description
MyBlockVariantGroup

Bones

Declaration

public Dictionary<Vector3I, Vector3> Bones

Field Value

Type	Description
System.Collections.Generic.Dictionary<Vector3I, Vector3>

BuildMaterial

Build material - always lower case (for walls - "stone", "wood").

Declaration

public string BuildMaterial

Field Value

Type	Description
System.String

BuildProgressModels

Models used when building. They are sorted in ascending order according to their percentage.

Declaration

public MyCubeBlockDefinition.BuildProgressModel[] BuildProgressModels

Field Value

Type	Description
MyCubeBlockDefinition.BuildProgressModel[]

BuildProgressToPlaceGeneratedBlocks

Value of build progress when generated blocks start to generate.

Declaration

public float BuildProgressToPlaceGeneratedBlocks

Field Value

Type	Description
System.Single

BuildType

Building type - always lower case (wall, ...).

Declaration

public MyStringId BuildType

Field Value

Type	Description
MyStringId

Color

Declaration

public Color Color

Field Value

Type	Description
Color

Components

Index 0 is first component on stack, the one which is build first and destroyed last.

Declaration

public MyCubeBlockDefinition.Component[] Components

Field Value

Type	Description
MyCubeBlockDefinition.Component[]

CriticalGroup

Declaration

public ushort CriticalGroup

Field Value

Type	Description
System.UInt16

CriticalIntegrityRatio

Declaration

public float CriticalIntegrityRatio

Field Value

Type	Description
System.Single

CubeDefinition

Declaration

public MyCubeDefinition CubeDefinition

Field Value

Type	Description
MyCubeDefinition

CubeSize

Declaration

public MyCubeSize CubeSize

Field Value

Type	Description
MyCubeSize

DamagedSound

Declaration

public MySoundPair DamagedSound

Field Value

Type	Description
MySoundPair

DamageEffectID

Declaration

public Nullable<int> DamageEffectID

Field Value

Type	Description
System.Nullable<System.Int32>

DamageEffectName

Declaration

public string DamageEffectName

Field Value

Type	Description
System.String

DamageEffectOffset

Declaration

public Nullable<Vector3> DamageEffectOffset

Field Value

Type	Description
System.Nullable<Vector3>

DamageMultiplierExplosion

Declaration

public float DamageMultiplierExplosion

Field Value

Type	Description
System.Single

DamageThreshold

Declaration

public float DamageThreshold

Field Value

Type	Description
System.Single

DeformationRatio

Declaration

public float DeformationRatio

Field Value

Type	Description
System.Single

DepressurizationEffectOffset

Declaration

public Nullable<Vector3> DepressurizationEffectOffset

Field Value

Type	Description
System.Nullable<Vector3>

DestroyEffect

Declaration

public string DestroyEffect

Field Value

Type	Description
System.String

DestroyEffectOffset

Declaration

public Nullable<Vector3> DestroyEffectOffset

Field Value

Type	Description
System.Nullable<Vector3>

DestroyEffectScale

Declaration

public float DestroyEffectScale

Field Value

Type	Description
System.Single

DestroySound

Declaration

public MySoundPair DestroySound

Field Value

Type	Description
MySoundPair

DetonateChance

Declaration

public float DetonateChance

Field Value

Type	Description
System.Single

DisassembleRatio

Declaration

public float DisassembleRatio

Field Value

Type	Description
System.Single

DisplayNameVariant

Declaration

public Nullable<MyStringId> DisplayNameVariant

Field Value

Type	Description
System.Nullable<MyStringId>

EdgeType

Declaration

public string EdgeType

Field Value

Type	Description
System.String

Effects

Declaration

public CubeBlockEffectBase[] Effects

Field Value

Type	Description
CubeBlockEffectBase[]

EmissiveColorPreset

Declaration

public MyStringHash EmissiveColorPreset

Field Value

Type	Description
MyStringHash

EnableUseObjectSimpleTargeting

Declaration

public bool EnableUseObjectSimpleTargeting

Field Value

Type	Description
System.Boolean

EntityComponents

Declaration

public Dictionary<string, MyObjectBuilder_ComponentBase> EntityComponents

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, MyObjectBuilder_ComponentBase>

GeneralDamageMultiplier

Declaration

public float GeneralDamageMultiplier

Field Value

Type	Description
System.Single

GeneratedBlockDefinitions

Declaration

public MyDefinitionId[] GeneratedBlockDefinitions

Field Value

Type	Description
MyDefinitionId[]

GeneratedBlockType

Declaration

public MyStringId GeneratedBlockType

Field Value

Type	Description
MyStringId

HasPhysics

Declaration

public bool HasPhysics

Field Value

Type	Description
System.Boolean

IntegrityPointsPerSec

Declaration

public float IntegrityPointsPerSec

Field Value

Type	Description
System.Single

IsAirTight

Declaration

public Nullable<bool> IsAirTight

Field Value

Type	Description
System.Nullable<System.Boolean>

IsCubePressurized

Declaration

public Dictionary<Vector3I, Dictionary<Vector3I, MyCubeBlockDefinition.MyCubePressurizationMark>> IsCubePressurized

Field Value

Type	Description
System.Collections.Generic.Dictionary<Vector3I, System.Collections.Generic.Dictionary<Vector3I, MyCubeBlockDefinition.MyCubePressurizationMark>>

IsStandAlone

Declaration

public bool IsStandAlone

Field Value

Type	Description
System.Boolean

MaxIntegrity

Declaration

public float MaxIntegrity

Field Value

Type	Description
System.Single

MaxIntegrityRatio

Declaration

public float MaxIntegrityRatio

Field Value

Type	Description
System.Single

MechanicalTopInitialPlacementOffset

Declaration

public Nullable<Vector3> MechanicalTopInitialPlacementOffset

Field Value

Type	Description
System.Nullable<Vector3>

ModelOffset

Declaration

public Vector3 ModelOffset

Field Value

Type	Description
Vector3

MountPoints

Declaration

public MyCubeBlockDefinition.MountPoint[] MountPoints

Field Value

Type	Description
MyCubeBlockDefinition.MountPoint[]

OwnershipIntegrityRatio

Declaration

public float OwnershipIntegrityRatio

Field Value

Type	Description
System.Single

PCU

Declaration

public int PCU

Field Value

Type	Description
System.Int32

PCU_CONSTRUCTION_STAGE_COST

Declaration

public static readonly int PCU_CONSTRUCTION_STAGE_COST

Field Value

Type	Description
System.Int32

PhysicsOption

Declaration

public MyPhysicsOption PhysicsOption

Field Value

Type	Description
MyPhysicsOption

PlaceDecals

Declaration

public bool PlaceDecals

Field Value

Type	Description
System.Boolean

PrimarySound

Declaration

public MySoundPair PrimarySound

Field Value

Type	Description
MySoundPair

SilenceableByShipSoundSystem

Declaration

public bool SilenceableByShipSoundSystem

Field Value

Type	Description
System.Boolean

Size

Declaration

public Vector3I Size

Field Value

Type	Description
Vector3I

Skeleton

Declaration

public List<BoneInfo> Skeleton

Field Value

Type	Description
System.Collections.Generic.List<BoneInfo>

TagDefinition

Declaration

public MyCubeBlockTagDefinition TagDefinition

Field Value

Type	Description
MyCubeBlockTagDefinition

TieredUpdateTimes

Declaration

public List<uint> TieredUpdateTimes

Field Value

Type	Description
System.Collections.Generic.List<System.UInt32>

UniqueVersion

Declaration

public MyCubeBlockDefinition UniqueVersion

Field Value

Type	Description
MyCubeBlockDefinition

UseModelIntersection

Declaration

public bool UseModelIntersection

Field Value

Type	Description
System.Boolean

UseNeighbourOxygenRooms

Flag used by GridGasSystem to determine if this block should exclude from creating pressurize room. If true, this block cannot be pressurize room itself. This is only valid for blocks which are bigger than 1x1x1, because otherwise they are excluded automatically.

Declaration

public bool UseNeighbourOxygenRooms

Field Value

Type	Description
System.Boolean

UsesDeformation

Declaration

public bool UsesDeformation

Field Value

Type	Description
System.Boolean

Variants

Declaration

public List<MyCubeBlockDefinition> Variants

Field Value

Type	Description
System.Collections.Generic.List<MyCubeBlockDefinition>

VoxelPlacement

Defines how much block can penetrate voxel.

Declaration

public Nullable<VoxelPlacementOverride> VoxelPlacement

Field Value

Type	Description
System.Nullable<VoxelPlacementOverride>

WheelPlacementPlacementCollider

Declaration

public MyObjectBuilder_CubeBlockDefinition.WheelPlacementColliderSettings WheelPlacementPlacementCollider

Field Value

Type	Description
MyObjectBuilder_CubeBlockDefinition.WheelPlacementColliderSettings

YesNoToolbarBackground

Declaration

public bool YesNoToolbarBackground

Field Value

Type	Description
System.Boolean

YesNoToolbarNoTooltip

Explains what yes action does

Declaration

public string YesNoToolbarNoTooltip

Field Value

Type	Description
System.String

YesNoToolbarYesTooltip

Explains what yes action does

Declaration

public string YesNoToolbarYesTooltip

Field Value

Type	Description
System.String

Properties

Center

Declaration

public Vector3I Center { get; }

Property Value

Type	Description
Vector3I

Direction

Allowed cube block directions.

Declaration

public MyBlockDirection Direction { get; }

Property Value

Type	Description
MyBlockDirection

DisplayNameText

Declaration

public override string DisplayNameText { get; }

Property Value

Type	Description
System.String

Overrides

MyDefinitionBase.DisplayNameText

GuiVisible

Declaration

public bool GuiVisible { get; set; }

Property Value

Type	Description
System.Boolean

IsGeneratedBlock

Declaration

public bool IsGeneratedBlock { get; }

Property Value

Type	Description
System.Boolean

Mirrored

Declaration

public bool Mirrored { get; }

Property Value

Type	Description
System.Boolean

MirroringBlock

Declaration

public string MirroringBlock { get; }

Property Value

Type	Description
System.String

MirroringCenter

Declaration

public Vector3I MirroringCenter { get; }

Property Value

Type	Description
Vector3I

NewsletterSubscriptionNeeded

Declaration

public bool NewsletterSubscriptionNeeded { get; }

Property Value

Type	Description
System.Boolean

NotWorkingPriorityMultiplier

Declaration

public float NotWorkingPriorityMultiplier { get; }

Property Value

Type	Description
System.Single

PriorityModifier

Declaration

public float PriorityModifier { get; }

Property Value

Type	Description
System.Single

RandomRotation

Declaration

public bool RandomRotation { get; }

Property Value

Type	Description
System.Boolean

Rotation

Allowed cube block rotations.

Declaration

public MyBlockRotation Rotation { get; }

Property Value

Type	Description
MyBlockRotation

SimpleUpdateVisualOnSkinChange

Declaration

public bool SimpleUpdateVisualOnSkinChange { get; }

Property Value

Type	Description
System.Boolean

SymmetryX

Declaration

public MySymmetryAxisEnum SymmetryX { get; }

Property Value

Type	Description
MySymmetryAxisEnum

SymmetryY

Declaration

public MySymmetryAxisEnum SymmetryY { get; }

Property Value

Type	Description
MySymmetryAxisEnum

SymmetryZ

Declaration

public MySymmetryAxisEnum SymmetryZ { get; }

Property Value

Type	Description
MySymmetryAxisEnum

TargetingGroups

Declaration

public List<MyStringHash> TargetingGroups { get; }

Property Value

Type	Description
System.Collections.Generic.List<MyStringHash>

UseVanillaPlacementDetection

Declaration

public bool UseVanillaPlacementDetection { get; }

Property Value

Type	Description
System.Boolean

Methods

ClearPreloadedConstructionModels()

Declaration

public static void ClearPreloadedConstructionModels()

ClearTargetableCache()

ModAPI: Should be called if you modify targeting groups.

Declaration

public void ClearTargetableCache()

ContainsComputer()

Declaration

public bool ContainsComputer()

Returns

Type	Description
System.Boolean

FinalModelThreshold()

Declaration

public float FinalModelThreshold()

Returns

Type	Description
System.Single

GetBuildProgressModelIndex(Single)

Declaration

public int GetBuildProgressModelIndex(float percentageA)

Parameters

Type	Name	Description
System.Single	percentageA

Returns

Type	Description
System.Int32

GetBuildProgressModelMountPoints(Single)

Declaration

public MyCubeBlockDefinition.MountPoint[] GetBuildProgressModelMountPoints(float currentIntegrityRatio)

Parameters

Type	Name	Description
System.Single	currentIntegrityRatio

Returns

Type	Description
MyCubeBlockDefinition.MountPoint[]

GetGeneratedBlockDefinition(MyStringId)

Declaration

public MyCubeBlockDefinition GetGeneratedBlockDefinition(MyStringId additionalModelType)

Parameters

Type	Name	Description
MyStringId	additionalModelType

Returns

Type	Description
MyCubeBlockDefinition

GetLimitType()

Declaration

public string GetLimitType()

Returns

Type	Description
System.String

GetMountPointWallIndex(Base6Directions.Direction)

Declaration

public static int GetMountPointWallIndex(Base6Directions.Direction direction)

Parameters

Type	Name	Description
Base6Directions.Direction	direction

Returns

Type	Description
System.Int32

GetObjectBuilder()

Declaration

public override MyObjectBuilder_DefinitionBase GetObjectBuilder()

Returns

Type	Description
MyObjectBuilder_DefinitionBase

Overrides

MyDefinitionBase.GetObjectBuilder()

Init(MyObjectBuilder_DefinitionBase)

Declaration

protected override void Init(MyObjectBuilder_DefinitionBase builder)

Parameters

Type	Name	Description
MyObjectBuilder_DefinitionBase	builder

Overrides

MyPhysicalModelDefinition.Init(MyObjectBuilder_DefinitionBase)

InitPressurization()

Declaration

public void InitPressurization()

IsTurretTargetable()

Declaration

public bool IsTurretTargetable()

Returns

Type	Description
System.Boolean

MatchingTurretTargetingGroup(MyStringHash)

Declaration

public bool MatchingTurretTargetingGroup(MyStringHash hash)

Parameters

Type	Name	Description
MyStringHash	hash

Returns

Type	Description
System.Boolean

ModelChangeIsNeeded(Single, Single)

Tells, whether a model change is needed, if the block changes integrity from A to B or vice versa.

Declaration

public bool ModelChangeIsNeeded(float was, float now)

Parameters

Type	Name	Description
System.Single	was
System.Single	now

Returns

Type	Description
System.Boolean

MountPointLocalNormalToBlockLocal(Vector3, Base6Directions.Direction)

Declaration

public Vector3 MountPointLocalNormalToBlockLocal(Vector3 normal, Base6Directions.Direction mountPointDirection)

Parameters

Type	Name	Description
Vector3	normal
Base6Directions.Direction	mountPointDirection

Returns

Type	Description
Vector3

MountPointLocalToBlockLocal(Vector3, Base6Directions.Direction)

Declaration

public Vector3 MountPointLocalToBlockLocal(Vector3 coord, Base6Directions.Direction mountPointDirection)

Parameters

Type	Name	Description
Vector3	coord
Base6Directions.Direction	mountPointDirection

Returns

Type	Description
Vector3

NormalToBlockSide(Vector3I)

Declaration

public static BlockSideEnum NormalToBlockSide(Vector3I normal)

Parameters

Type	Name	Description
Vector3I	normal

Returns

Type	Description
BlockSideEnum

PreloadConstructionModels(MyCubeBlockDefinition)

Declaration

public static void PreloadConstructionModels(MyCubeBlockDefinition block)

Parameters

Type	Name	Description
MyCubeBlockDefinition	block

RatioEnoughForDamageEffect(Single)

Declaration

public bool RatioEnoughForDamageEffect(float ratio)

Parameters

Type	Name	Description
System.Single	ratio

Returns

Type	Description
System.Boolean

RatioEnoughForOwnership(Single)

Declaration

public bool RatioEnoughForOwnership(float ratio)

Parameters

Type	Name	Description
System.Single	ratio

Returns

Type	Description
System.Boolean