Click or drag to resize
IMyPistonTop Interface

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "T:Sandbox.ModAPI.IMyPistonTop"]

Namespace: Sandbox.ModAPI
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0
Syntax
C#
public interface IMyPistonTop : IMyCubeBlock, 
	IMyPistonTop, IMyCubeBlock, IMyEntity

The IMyPistonTop type exposes the following members.

Properties
  NameDescription
Public propertyBlockDefinition (Inherited from IMyCubeBlock.)
Public propertyCastShadows (Inherited from IMyEntity.)
Public propertyCheckConnectionAllowed
Whether the grid should call the ConnectionAllowed method for this block (ConnectionAllowed checks mount points and other per-block requirements)
(Inherited from IMyCubeBlock.)
Public propertyClosed (Inherited from IMyEntity.)
Public propertyComponents (Inherited from IMyEntity.)
Public propertyCubeGrid
Grid in which the block is placed
(Inherited from IMyCubeBlock.)
Public propertyDebugAsyncLoading (Inherited from IMyEntity.)
Public propertyDefinitionDisplayNameText
Definition name
(Inherited from IMyCubeBlock.)
Public propertyDisassembleRatio
Is set in definition Ratio at which is the block disassembled (grinding)
(Inherited from IMyCubeBlock.)
Public propertyDisplayName (Inherited from IMyEntity.)
Public propertyDisplayNameText
Translated block name
(Inherited from IMyCubeBlock.)
Public propertyEntityId (Inherited from IMyEntity.)
Public propertyFastCastShadowResolve (Inherited from IMyEntity.)
Public propertyFlags (Inherited from IMyEntity.)
Public propertyGameLogic (Inherited from IMyEntity.)
Public propertyHierarchy (Inherited from IMyEntity.)
Public propertyInScene (Inherited from IMyEntity.)
Public propertyInvalidateOnMove (Inherited from IMyEntity.)
Public propertyIsAttached (Inherited from IMyPistonTop.)
Public propertyIsBeingHacked (Inherited from IMyCubeBlock.)
Public propertyIsCCDForProjectiles (Inherited from IMyEntity.)
Public propertyIsFunctional
True if integrity is above breaking threshold
(Inherited from IMyCubeBlock.)
Public propertyIsVolumetric (Inherited from IMyEntity.)
Public propertyIsWorking
True if block is able to do its work depening on block type (is functional, powered, enabled, etc...)
(Inherited from IMyCubeBlock.)
Public propertyLocalAABB (Inherited from IMyEntity.)
Public propertyLocalAABBHr (Inherited from IMyEntity.)
Public propertyLocalMatrix (Inherited from IMyEntity.)
Public propertyLocalVolume (Inherited from IMyEntity.)
Public propertyLocalVolumeOffset (Inherited from IMyEntity.)
Public propertyLocationForHudMarker (Inherited from IMyEntity.)
Public propertyMarkedForClose (Inherited from IMyEntity.)
Public propertyMass
Block mass
(Inherited from IMyCubeBlock.)
Public propertyMax
Maximum coordinates of grid cells occupied by this block
(Inherited from IMyCubeBlock.)
Public propertyMaxGlassDistSq (Inherited from IMyEntity.)
Public propertyMin
Minimum coordinates of grid cells occupied by this block
(Inherited from IMyCubeBlock.)
Public propertyName (Inherited from IMyEntity.)
Public propertyNearFlag (Inherited from IMyEntity.)
Public propertyNeedsDraw (Inherited from IMyEntity.)
Public propertyNeedsDrawFromParent (Inherited from IMyEntity.)
Public propertyNeedsResolveCastShadow (Inherited from IMyEntity.)
Public propertyNeedsUpdate (Inherited from IMyEntity.)
Public propertyNumberInGrid
Order in which were the blocks of same type added to grid Used in default display name
(Inherited from IMyCubeBlock.)
Public propertyOrientation
Returns block orientation in base 6 directions
(Inherited from IMyCubeBlock.)
Public propertyOwnerId
Id of player owning block (not steam Id)
(Inherited from IMyCubeBlock.)
Public propertyParent (Inherited from IMyEntity.)
Public propertyPersistentFlags (Inherited from IMyEntity.)
Public propertyPhysics (Inherited from IMyEntity.)
Public propertyPiston
Gets the attached piston block
Public propertyPosition
Position in grid coordinates
(Inherited from IMyCubeBlock.)
Public propertyPositionComp (Inherited from IMyEntity.)
Public propertyRender (Inherited from IMyEntity.)
Public propertySave (Inherited from IMyEntity.)
Public propertyShadowBoxLod (Inherited from IMyEntity.)
Public propertySkipIfTooSmall (Inherited from IMyEntity.)
Public propertySyncObject (Inherited from IMyEntity.)
Public propertyTransparent (Inherited from IMyEntity.)
Public propertyUpgradeValues
Get all values changed by upgrade modules Should only be used as read-only
(Inherited from IMyCubeBlock.)
Public propertyVisible (Inherited from IMyEntity.)
Public propertyWorldAABB (Inherited from IMyEntity.)
Public propertyWorldAABBHr (Inherited from IMyEntity.)
Public propertyWorldMatrix (Inherited from IMyEntity.)
Public propertyWorldMatrixInvScaled (Inherited from IMyEntity.)
Public propertyWorldMatrixNormalizedInv (Inherited from IMyEntity.)
Public propertyWorldVolume (Inherited from IMyEntity.)
Public propertyWorldVolumeHr (Inherited from IMyEntity.)
Top
Methods
  NameDescription
Public methodAddToGamePruningStructure (Inherited from IMyEntity.)
Public methodAddUpgradeValue
Preferred way of registering a block for upgrades Adding directly to the dictionary can have unintended consequences when multiple mods are involved.
(Inherited from IMyCubeBlock.)
Public methodBeforeSave (Inherited from IMyEntity.)
Public methodCalcLocalMatrix
(Inherited from IMyCubeBlock.)
Public methodCalculateCurrentModel
Calculates model currently used by block depending on its build progress and other factors
(Inherited from IMyCubeBlock.)
Public methodClose (Inherited from IMyEntity.)
Public methodDebugDraw
Debug only method. Effects may wary through time.
(Inherited from IMyCubeBlock.)
Public methodDebugDrawInvalidTriangles (Inherited from IMyEntity.)
Public methodDelete (Inherited from IMyEntity.)
Public methodDoOverlapSphereTest (Inherited from IMyEntity.)
Public methodEnableColorMaskForSubparts (Inherited from IMyEntity.)
Public methodGetChildren (Inherited from IMyEntity.)
Public methodGetDiffuseColor (Inherited from IMyEntity.)
Public methodGetDistanceBetweenCameraAndBoundingSphere (Inherited from IMyEntity.)
Public methodGetDistanceBetweenCameraAndPosition (Inherited from IMyEntity.)
Public methodGetFriendlyName (Inherited from IMyEntity.)
Public methodGetIntersectionWithLineAndBoundingSphere (Inherited from IMyEntity.)
Public methodGetIntersectionWithSphere (Inherited from IMyEntity.)
Public methodGetLargestDistanceBetweenCameraAndBoundingSphere (Inherited from IMyEntity.)
Public methodGetObjectBuilder (Inherited from IMyEntity.)
Public methodGetObjectBuilderCubeBlock
Returns block object builder which can be serialized or added to grid
(Inherited from IMyCubeBlock.)
Public methodGetOwnerFactionTag
(Inherited from IMyCubeBlock.)
Public methodGetPlayerRelationToOwner
(Inherited from IMyCubeBlock.)
Public methodGetPosition (Inherited from IMyEntity.)
Public methodGetSmallestDistanceBetweenCameraAndBoundingSphere (Inherited from IMyEntity.)
Public methodGetSubpart (Inherited from IMyEntity.)
Public methodGetTopMostParent (Inherited from IMyEntity.)
Public methodGetTrianglesIntersectingSphere (Inherited from IMyEntity.)
Public methodGetUserRelationToOwner
(Inherited from IMyCubeBlock.)
Public methodGetViewMatrix (Inherited from IMyEntity.)
Public methodGetWorldMatrixNormalizedInv (Inherited from IMyEntity.)
Public methodInit
Reloads block model and interactive objects (doors, terminals, etc...)
(Inherited from IMyCubeBlock.)
Public methodInit(MyObjectBuilder_CubeBlock, IMyCubeGrid)
Initializes block state from object builder
(Inherited from IMyCubeBlock.)
Public methodIsVisible (Inherited from IMyEntity.)
Public methodOnAddedToScene (Inherited from IMyEntity.)
Public methodOnBuildSuccess
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.
(Inherited from IMyCubeBlock.)
Public methodOnDestroy
Called when block is destroyed before being removed from grid
(Inherited from IMyCubeBlock.)
Public methodOnModelChange
Called when the model referred by the block is changed
(Inherited from IMyCubeBlock.)
Public methodOnRegisteredToGridSystems
Called at the end of registration from grid systems (after block has been registered).
(Inherited from IMyCubeBlock.)
Public methodOnRemovedByCubeBuilder
Method called when user removes a cube block from grid. Useful when block has to remove some other attached block (like motors).
(Inherited from IMyCubeBlock.)
Public methodOnRemovedFromScene (Inherited from IMyEntity.)
Public methodOnUnregisteredFromGridSystems
Called at the end of unregistration from grid systems (after block has been unregistered).
(Inherited from IMyCubeBlock.)
Public methodRaycastDetectors
Gets the name of interactive object intersected by defined line
(Inherited from IMyCubeBlock.)
Public methodReloadDetectors
Reloads detectors (interactive objects) in model
(Inherited from IMyCubeBlock.)
Public methodRemoveFromGamePruningStructure (Inherited from IMyEntity.)
Public methodSetColorMaskForSubparts (Inherited from IMyEntity.)
Public methodSetDamageEffect
Start or stop dammage effect on cube block
(Inherited from IMyCubeBlock.)
Public methodSetEmissiveParts
Sets the emissive value of a specific emissive material on entity.
(Inherited from IMyEntity.)
Public methodSetEmissivePartsForSubparts
Sets the emissive value of a specific emissive material on all entity subparts.
(Inherited from IMyEntity.)
Public methodSetLocalMatrix (Inherited from IMyEntity.)
Public methodSetPosition (Inherited from IMyEntity.)
Public methodSetWorldMatrix (Inherited from IMyEntity.)
Public methodTryGetSubpart (Inherited from IMyEntity.)
Public methodUpdateGamePruningStructure (Inherited from IMyEntity.)
Public methodUpdateIsWorking
Force refresh working state. Call if you change block state that could affect its working status.
(Inherited from IMyCubeBlock.)
Public methodUpdateVisual
Updates block visuals (ie. block emissivity)
(Inherited from IMyCubeBlock.)
Top
Events
  NameDescription
Public eventIsWorkingChanged (Inherited from IMyCubeBlock.)
Public eventOnClose (Inherited from IMyEntity.)
Public eventOnClosing (Inherited from IMyEntity.)
Public eventOnMarkForClose (Inherited from IMyEntity.)
Public eventOnPhysicsChanged (Inherited from IMyEntity.)
Public eventOnUpgradeValuesChanged
Event called when upgrade values are changed Either upgrades were built or destroyed, or they become damaged or unpowered
(Inherited from IMyCubeBlock.)
Top
See Also