| IMyPistonBase Interface |
[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)
SyntaxThe IMyPistonBase type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Attach |
Attaches a nearby top part to the block
(Inherited from IMyMechanicalConnectionBlock.) |
| Detach |
Detaches the top from the base
(Inherited from IMyMechanicalConnectionBlock.) |
| Extend |
Extends the piston.
|
| GetActions | (Inherited from IMyTerminalBlock.) |
| GetActionWithName | (Inherited from IMyTerminalBlock.) |
| GetInventory | (Inherited from IMyEntity.) |
| GetInventory(Int32) | (Inherited from IMyEntity.) |
| GetOwnerFactionTag | (Inherited from IMyCubeBlock.) |
| GetPlayerRelationToOwner | Obsolete. (Inherited from IMyCubeBlock.) |
| GetPosition | (Inherited from IMyEntity.) |
| GetProperties | (Inherited from IMyTerminalBlock.) |
| GetProperty | (Inherited from IMyTerminalBlock.) |
| GetUserRelationToOwner | (Inherited from IMyCubeBlock.) |
| HasLocalPlayerAccess | (Inherited from IMyTerminalBlock.) |
| HasPlayerAccess | (Inherited from IMyTerminalBlock.) |
| RequestEnable | Obsolete. (Inherited from IMyFunctionalBlock.) |
| Retract |
Retracts the piston.
|
| Reverse |
Reverses the direction of the piston.
|
| SearchActionsOfName | (Inherited from IMyTerminalBlock.) |
| SetCustomName(String) | Obsolete. (Inherited from IMyTerminalBlock.) |
| SetCustomName(StringBuilder) | Obsolete. (Inherited from IMyTerminalBlock.) |
| UpdateIsWorking | Obsolete. (Inherited from IMyCubeBlock.) |
| UpdateVisual | Obsolete. (Inherited from IMyCubeBlock.) |
Extension MethodsTop
Properties| Name | Description | |
|---|---|---|
 | BlockDefinition | (Inherited from IMyCubeBlock.) |
| CheckConnectionAllowed | (Inherited from IMyCubeBlock.) |
| Components | (Inherited from IMyEntity.) |
| CubeGrid | (Inherited from IMyCubeBlock.) |
| CurrentPosition |
Gets the current position of the piston head relative to the base.
|
| CustomData |
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.) |
| CustomInfo | (Inherited from IMyTerminalBlock.) |
| CustomName | (Inherited from IMyTerminalBlock.) |
| CustomNameWithFaction | (Inherited from IMyTerminalBlock.) |
| DefinitionDisplayNameText | (Inherited from IMyCubeBlock.) |
| DetailedInfo | (Inherited from IMyTerminalBlock.) |
| DisassembleRatio | (Inherited from IMyCubeBlock.) |
| DisplayName | (Inherited from IMyEntity.) |
| DisplayNameText | (Inherited from IMyCubeBlock.) |
| Enabled | (Inherited from IMyFunctionalBlock.) |
| EntityId | (Inherited from IMyEntity.) |
| HasInventory | (Inherited from IMyEntity.) |
| HighestPosition |
Gets the highest position the piston is capable of moving to.
|
| InventoryCount | (Inherited from IMyEntity.) |
| IsAttached |
Gets if the block base is attached to something
(Inherited from IMyMechanicalConnectionBlock.) |
| IsBeingHacked | (Inherited from IMyCubeBlock.) |
| IsFunctional | (Inherited from IMyCubeBlock.) |
| IsLocked | Obsolete.
Gets if the block is safety locked (welded)
(Inherited from IMyMechanicalConnectionBlock.) |
| IsWorking | (Inherited from IMyCubeBlock.) |
| LowestPosition |
Gets the lowest position the piston is capable of moving to.
|
| Mass | (Inherited from IMyCubeBlock.) |
| Max | (Inherited from IMyCubeBlock.) |
| MaxLimit |
Gets or sets the maximum position the piston can extend to. See LowestPosition and HighestPosition for the limits of this value.
|
| MaxVelocity |
Gets the maximum velocity this piston is capable of moving at.
|
| Min | (Inherited from IMyCubeBlock.) |
| MinLimit |
Gets or sets the minimum position the piston can retract to. See LowestPosition and HighestPosition for the limits of this value.
|
| Name | (Inherited from IMyEntity.) |
| NumberInGrid | (Inherited from IMyCubeBlock.) |
| Orientation | (Inherited from IMyCubeBlock.) |
| OwnerId | (Inherited from IMyCubeBlock.) |
| PendingAttachment |
Gets if the block is looking for a top part
(Inherited from IMyMechanicalConnectionBlock.) |
| Position | (Inherited from IMyCubeBlock.) |
| SafetyLock |
Gets if the block is safety locked (welded)
(Inherited from IMyMechanicalConnectionBlock.) |
| SafetyLockSpeed |
Gets or sets the speed at which this device will engage it's safety lock (IsLocked).
(Inherited from IMyMechanicalConnectionBlock.) |
| ShowInTerminal | (Inherited from IMyTerminalBlock.) |
| ShowInToolbarConfig | (Inherited from IMyTerminalBlock.) |
| ShowOnHUD | (Inherited from IMyTerminalBlock.) |
| Status |
Gets the current status.
|
| Top |
Gets the attached top part entity
(Inherited from IMyMechanicalConnectionBlock.) |
| TopGrid |
Gets the grid of the attached top part
(Inherited from IMyMechanicalConnectionBlock.) |
| Velocity |
Gets or sets the velocity of the piston as it extends or retracts. This value can be between negative and positive MaxVelocity.
|
| WorldAABB | (Inherited from IMyEntity.) |
| WorldAABBHr | (Inherited from IMyEntity.) |
| WorldMatrix | (Inherited from IMyEntity.) |
| WorldVolume | (Inherited from IMyEntity.) |
| WorldVolumeHr | (Inherited from IMyEntity.) |
See Also