Sandbox.ModAPI.Ingame.IMyPistonBase

IMyPistonBase Interface

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Implements:

Properties

_`float Velocity`_	Gets or sets the velocity of the piston as it extends or retracts. This value can be between negative and positive [float MaxVelocity](Sandbox.ModAPI.Ingame.MaxVelocity) .
_`float MaxVelocity`_	Gets the maximum velocity this piston is capable of moving at.
_`float MinLimit`_	Gets or sets the minimum position the piston can retract to. See [float LowestPosition](Sandbox.ModAPI.Ingame.LowestPosition) and [float HighestPosition](Sandbox.ModAPI.Ingame.HighestPosition) for the limits of this value.
_`float MaxLimit`_	Gets or sets the maximum position the piston can extend to. See [float LowestPosition](Sandbox.ModAPI.Ingame.LowestPosition) and [float HighestPosition](Sandbox.ModAPI.Ingame.HighestPosition) for the limits of this value.
_`float LowestPosition`_	Gets the lowest position the piston is capable of moving to.
_`float HighestPosition`_	Gets the highest position the piston is capable of moving to.
_`float CurrentPosition`_	Gets the current position of the piston head relative to the base.
_`PistonStatus Status`_	Gets the current status.
_`MyEntityComponentContainer Components`_	_Inherited from `IMyEntity`_
_`long EntityId`_	_Inherited from `IMyEntity`_
_`string Name`_	_Inherited from `IMyEntity`_
_`string DisplayName`_	_Inherited from `IMyEntity`_
_`bool HasInventory`_	Returns true if this entity has got at least one inventory. Note that one aggregate inventory can contain zero simple inventories => zero will be returned even if GetInventory() != null. _Inherited from `IMyEntity`_
_`int InventoryCount`_	Returns the count of the number of inventories this entity has. _Inherited from `IMyEntity`_
_`BoundingBoxD WorldAABB`_	_Inherited from `IMyEntity`_
_`BoundingBoxD WorldAABBHr`_	_Inherited from `IMyEntity`_
_`MatrixD WorldMatrix`_	_Inherited from `IMyEntity`_
_`BoundingSphereD WorldVolume`_	_Inherited from `IMyEntity`_
_`BoundingSphereD WorldVolumeHr`_	_Inherited from `IMyEntity`_
_`SerializableDefinitionId BlockDefinition`_	_Inherited from `IMyCubeBlock`_
_`bool CheckConnectionAllowed`_	_Inherited from `IMyCubeBlock`_
_`IMyCubeGrid CubeGrid`_	Grid in which the block is placed _Inherited from `IMyCubeBlock`_
_`string DefinitionDisplayNameText`_	Definition name _Inherited from `IMyCubeBlock`_
_`float DisassembleRatio`_	Is set in definition Ratio at which is the block disassembled (grinding) _Inherited from `IMyCubeBlock`_
_`string DisplayNameText`_	Translated block name _Inherited from `IMyCubeBlock`_
_`bool IsBeingHacked`_	Hacking of the block is in progress _Inherited from `IMyCubeBlock`_
_`bool IsFunctional`_	True if integrity is above breaking threshold _Inherited from `IMyCubeBlock`_
_`bool IsWorking`_	True if block is able to do its work depening on block type (is functional, powered, enabled, etc...) _Inherited from `IMyCubeBlock`_
_`Vector3I Max`_	Maximum coordinates of grid cells occupied by this block _Inherited from `IMyCubeBlock`_
_`float Mass`_	Block mass _Inherited from `IMyCubeBlock`_
_`Vector3I Min`_	Minimum coordinates of grid cells occupied by this block _Inherited from `IMyCubeBlock`_
_`int NumberInGrid`_	Order in which were the blocks of same type added to grid Used in default display name _Inherited from `IMyCubeBlock`_
_`MyBlockOrientation Orientation`_	Returns block orientation in base 6 directions _Inherited from `IMyCubeBlock`_
_`long OwnerId`_	Id of player owning block (not steam Id) _Inherited from `IMyCubeBlock`_
_`Vector3I Position`_	Position in grid coordinates _Inherited from `IMyCubeBlock`_
_`string CustomName`_	_Inherited from `IMyTerminalBlock`_
_`string CustomNameWithFaction`_	_Inherited from `IMyTerminalBlock`_
_`string DetailedInfo`_	_Inherited from `IMyTerminalBlock`_
_`string CustomInfo`_	_Inherited from `IMyTerminalBlock`_
_`string 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`_
_`bool ShowOnHUD`_	_Inherited from `IMyTerminalBlock`_
_`bool ShowInTerminal`_	_Inherited from `IMyTerminalBlock`_
_`bool ShowInToolbarConfig`_	_Inherited from `IMyTerminalBlock`_
_`bool ShowInInventory`_	_Inherited from `IMyTerminalBlock`_
_`bool Enabled`_	_Inherited from `IMyFunctionalBlock`_
_`IMyCubeGrid TopGrid`_	Gets the grid of the attached top part _Inherited from `IMyMechanicalConnectionBlock`_
_`IMyAttachableTopBlock Top`_	Gets the attached top part entity _Inherited from `IMyMechanicalConnectionBlock`_
_`float SafetyLockSpeed`_	Gets or sets the speed at which this device will engage it's safety lock ( [bool IsLocked](Sandbox.ModAPI.Ingame.IsLocked) ). _Inherited from `IMyMechanicalConnectionBlock`_
_`bool SafetyLock`_	Gets if the block is safety locked (welded) _Inherited from `IMyMechanicalConnectionBlock`_
_`bool IsAttached`_	Gets if the block base is attached to something _Inherited from `IMyMechanicalConnectionBlock`_
_`bool IsLocked`_	Gets if the block is safety locked (welded) _Inherited from `IMyMechanicalConnectionBlock`_
_`bool PendingAttachment`_	Gets if the block is looking for a top part _Inherited from `IMyMechanicalConnectionBlock`_

### Methods

_`void Extend()`_	Extends the piston.
_`void Retract()`_	Retracts the piston.
_`void Reverse()`_	Reverses the direction of the piston.
_`IMyInventory GetInventory()`_	Simply get the MyInventoryBase component stored in this entity. _Inherited from `IMyEntity`_
_`IMyInventory GetInventory(int index)`_	Search for inventory component with maching index. _Inherited from `IMyEntity`_
_`Vector3D GetPosition()`_	_Inherited from `IMyEntity`_
_`string GetOwnerFactionTag()`_	Tag of faction owning block _Inherited from `IMyCubeBlock`_
_`MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner()`_	_Inherited from `IMyCubeBlock`_
_`MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long playerId)`_	_Inherited from `IMyCubeBlock`_
_`void UpdateIsWorking()`_	_Inherited from `IMyCubeBlock`_
_`void UpdateVisual()`_	_Inherited from `IMyCubeBlock`_
_`bool HasLocalPlayerAccess()`_	_Inherited from `IMyTerminalBlock`_
_`bool HasPlayerAccess(long playerId)`_	_Inherited from `IMyTerminalBlock`_
_`void SetCustomName(string text)`_	_Inherited from `IMyTerminalBlock`_
_`void SetCustomName(StringBuilder text)`_	_Inherited from `IMyTerminalBlock`_
_`void GetActions(List resultList, Func collect)`_	_Inherited from `IMyTerminalBlock`_
_`void SearchActionsOfName(string name, List resultList, Func collect)`_	_Inherited from `IMyTerminalBlock`_
_`ITerminalAction GetActionWithName(string name)`_	_Inherited from `IMyTerminalBlock`_
_`ITerminalProperty GetProperty(string id)`_	_Inherited from `IMyTerminalBlock`_
_`void GetProperties(List resultList, Func collect)`_	_Inherited from `IMyTerminalBlock`_
_`bool IsSameConstructAs(IMyTerminalBlock other)`_	Determines whether this block is mechanically connected to the other. This is any block connected with rotors or pistons or other mechanical devices, but not things like connectors. This will in most cases constitute your complete construct. Be aware that using merge blocks combines grids into one, so this function will not filter out grids connected that way. Also be aware that detaching the heads of pistons and rotors will cause this connection to change. _Inherited from `IMyTerminalBlock`_
_`void RequestEnable(bool enable)`_	_Inherited from `IMyFunctionalBlock`_
_`void Attach()`_	Attaches a nearby top part to the block _Inherited from `IMyMechanicalConnectionBlock`_
_`void Detach()`_	Detaches the top from the base _Inherited from `IMyMechanicalConnectionBlock`_

Do you have questions, comments, suggestions for improvements? Is there something I can do better? Did I make a mistake? Please add an issue here, and prefix your issue title with Wiki. Thank you, your help will be very appreciated!

Sandbox.ModAPI.Ingame.IMyPistonBase

IMyPistonBase Interface

Properties

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!