Click or drag to resize
IMyPistonBase Interface
v01.180.0 (Beta)

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

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public interface IMyPistonBase : IMyMechanicalConnectionBlock, 
	IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntity

The IMyPistonBase type exposes the following members.

Methods
  NameDescription
Public methodAttach
Attaches a nearby top part to the block
(Inherited from IMyMechanicalConnectionBlock.)
Public methodDetach
Detaches the top from the base
(Inherited from IMyMechanicalConnectionBlock.)
Public methodExtend
Extends the piston.
Public methodGetActions (Inherited from IMyTerminalBlock.)
Public methodGetActionWithName (Inherited from IMyTerminalBlock.)
Public methodGetInventory (Inherited from IMyEntity.)
Public methodGetInventory(Int32) (Inherited from IMyEntity.)
Public methodGetOwnerFactionTag (Inherited from IMyCubeBlock.)
Public methodGetPlayerRelationToOwner Obsolete. (Inherited from IMyCubeBlock.)
Public methodGetPosition (Inherited from IMyEntity.)
Public methodGetProperties (Inherited from IMyTerminalBlock.)
Public methodGetProperty (Inherited from IMyTerminalBlock.)
Public methodGetUserRelationToOwner (Inherited from IMyCubeBlock.)
Public methodHasLocalPlayerAccess (Inherited from IMyTerminalBlock.)
Public methodHasPlayerAccess (Inherited from IMyTerminalBlock.)
Public methodRequestEnable Obsolete. (Inherited from IMyFunctionalBlock.)
Public methodRetract
Retracts the piston.
Public methodReverse
Reverses the direction of the piston.
Public methodSearchActionsOfName (Inherited from IMyTerminalBlock.)
Public methodSetCustomName(String) Obsolete. (Inherited from IMyTerminalBlock.)
Public methodSetCustomName(StringBuilder) Obsolete. (Inherited from IMyTerminalBlock.)
Public methodUpdateIsWorking Obsolete. (Inherited from IMyCubeBlock.)
Public methodUpdateVisual Obsolete. (Inherited from IMyCubeBlock.)
Top
Extension Methods
  NameDescription
Public Extension MethodApplyAction(String)Overloaded. (Defined by TerminalBlockExtentions.)
Public Extension MethodApplyAction(String, ListTerminalActionParameter)Overloaded. (Defined by TerminalBlockExtentions.)
Public Extension MethodGetDefaultValueT
Returns default value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetId (Defined by TerminalBlockExtentions.)
Public Extension MethodGetInventoryCount (Defined by TerminalBlockExtentions.)
Public Extension MethodGetMaximumT
Returns maximum value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetMinimumT
Returns minimum value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetMininumT (Defined by TerminalPropertyExtensions.)
Public Extension MethodGetUseConveyorSystem (Defined by TerminalBlockExtentions.)
Public Extension MethodGetValueT
Returns value of specified property as TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueBool
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueColor
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodGetValueFloat
Returns value of specified property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodHasAction (Defined by TerminalBlockExtentions.)
Public Extension MethodHasInventory (Defined by TerminalBlockExtentions.)
Public Extension MethodSetUseConveyorSystem (Defined by TerminalBlockExtentions.)
Public Extension MethodSetValueT
Set value of property with type of TypeName
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueBool
Set bool value of property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueColor
Set bool value of property
(Defined by TerminalPropertyExtensions.)
Public Extension MethodSetValueFloat
Set float value of property
(Defined by TerminalPropertyExtensions.)
Top
Properties
  NameDescription
Public propertyBlockDefinition (Inherited from IMyCubeBlock.)
Public propertyCheckConnectionAllowed (Inherited from IMyCubeBlock.)
Public propertyComponents (Inherited from IMyEntity.)
Public propertyCubeGrid (Inherited from IMyCubeBlock.)
Public propertyCurrentPosition
Gets the current position of the piston head relative to the base.
Public propertyCustomData
Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent
(Inherited from IMyTerminalBlock.)
Public propertyCustomInfo (Inherited from IMyTerminalBlock.)
Public propertyCustomName (Inherited from IMyTerminalBlock.)
Public propertyCustomNameWithFaction (Inherited from IMyTerminalBlock.)
Public propertyDefinitionDisplayNameText (Inherited from IMyCubeBlock.)
Public propertyDetailedInfo (Inherited from IMyTerminalBlock.)
Public propertyDisassembleRatio (Inherited from IMyCubeBlock.)
Public propertyDisplayName (Inherited from IMyEntity.)
Public propertyDisplayNameText (Inherited from IMyCubeBlock.)
Public propertyEnabled (Inherited from IMyFunctionalBlock.)
Public propertyEntityId (Inherited from IMyEntity.)
Public propertyHasInventory (Inherited from IMyEntity.)
Public propertyHighestPosition
Gets the highest position the piston is capable of moving to.
Public propertyInventoryCount (Inherited from IMyEntity.)
Public propertyIsAttached
Gets if the block base is attached to something
(Inherited from IMyMechanicalConnectionBlock.)
Public propertyIsBeingHacked (Inherited from IMyCubeBlock.)
Public propertyIsFunctional (Inherited from IMyCubeBlock.)
Public propertyIsLocked Obsolete.
Gets if the block is safety locked (welded)
(Inherited from IMyMechanicalConnectionBlock.)
Public propertyIsWorking (Inherited from IMyCubeBlock.)
Public propertyLowestPosition
Gets the lowest position the piston is capable of moving to.
Public propertyMass (Inherited from IMyCubeBlock.)
Public propertyMax (Inherited from IMyCubeBlock.)
Public propertyMaxLimit
Gets or sets the maximum position the piston can extend to. See LowestPosition and HighestPosition for the limits of this value.
Public propertyMaxVelocity
Gets the maximum velocity this piston is capable of moving at.
Public propertyMin (Inherited from IMyCubeBlock.)
Public propertyMinLimit
Gets or sets the minimum position the piston can retract to. See LowestPosition and HighestPosition for the limits of this value.
Public propertyName (Inherited from IMyEntity.)
Public propertyNumberInGrid (Inherited from IMyCubeBlock.)
Public propertyOrientation (Inherited from IMyCubeBlock.)
Public propertyOwnerId (Inherited from IMyCubeBlock.)
Public propertyPendingAttachment
Gets if the block is looking for a top part
(Inherited from IMyMechanicalConnectionBlock.)
Public propertyPosition (Inherited from IMyCubeBlock.)
Public propertySafetyLock
Gets if the block is safety locked (welded)
(Inherited from IMyMechanicalConnectionBlock.)
Public propertySafetyLockSpeed
Gets or sets the speed at which this device will engage it's safety lock (IsLocked).
(Inherited from IMyMechanicalConnectionBlock.)
Public propertyShowInTerminal (Inherited from IMyTerminalBlock.)
Public propertyShowInToolbarConfig (Inherited from IMyTerminalBlock.)
Public propertyShowOnHUD (Inherited from IMyTerminalBlock.)
Public propertyStatus
Gets the current status.
Public propertyTop
Gets the attached top part entity
(Inherited from IMyMechanicalConnectionBlock.)
Public propertyTopGrid
Gets the grid of the attached top part
(Inherited from IMyMechanicalConnectionBlock.)
Public propertyVelocity
Gets or sets the velocity of the piston as it extends or retracts. This value can be between negative and positive MaxVelocity.
Public propertyWorldAABB (Inherited from IMyEntity.)
Public propertyWorldAABBHr (Inherited from IMyEntity.)
Public propertyWorldMatrix (Inherited from IMyEntity.)
Public propertyWorldVolume (Inherited from IMyEntity.)
Public propertyWorldVolumeHr (Inherited from IMyEntity.)
Top
See Also