Sandbox.ModAPI.Ingame

IMyExtendedPistonBase

Assembly: Sandbox.Common.dll

public interface IMyExtendedPistonBase: IMyPistonBase, IMyMechanicalConnectionBlock, IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntity

Describes piston block (PB scripting interface)

Properties

Member Description
BlockDefinition Gets definition.Id assigned to this block

Inherited from IMyCubeBlock
Closed True if the block has been removed from the world.

Inherited from IMyEntity
Components Gets blocks component logic container

Inherited from IMyEntity
CubeGrid Grid in which the block is placed

Inherited from IMyCubeBlock
CurrentPosition Gets the current position of the piston head relative to the base.

Inherited from IMyPistonBase
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 Gets information about block status (available from mods) IMyTerminalBlock.AppendingCustomInfoprohibited IMyTerminalBlock.RefreshCustomInfoprohibited .

Inherited from IMyTerminalBlock
CustomName Gets or sets how block is named in Terminal menu

Inherited from IMyTerminalBlock
CustomNameWithFaction Gets or sets how block is named in Terminal menu. Work only for Cockpit, LaserAntenna RadioAntenna, SpaceBall, Beacon

Inherited from IMyTerminalBlock
DefinitionDisplayNameText Definition name

Inherited from IMyCubeBlock
DetailedInfo Gets information about block status. In Control panel bottom right text

Inherited from IMyTerminalBlock
DisassembleRatio Is set in definition Ratio at which is the block disassembled (grinding) Bigger values - longer grinding

Inherited from IMyCubeBlock
DisplayName Gets user friendly name of entity. May be null For block terminal name use DisplayNameText

Inherited from IMyEntity
DisplayNameText Translated block name

Inherited from IMyCubeBlock
Enabled Represents terminal gui toggle. Gets or sets if block is Enabled

Inherited from IMyFunctionalBlock
EntityId Id of entity

Inherited from IMyEntity
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
HighestPosition Gets the highest position the piston is capable of moving to.

Inherited from IMyPistonBase
InventoryCount Returns the count of the number of inventories this entity has.

Inherited from IMyEntity
IsAttached Gets if the block base is attached to something

Inherited from IMyMechanicalConnectionBlock
IsBeingHacked Hacking of the block is in progress

Inherited from IMyCubeBlock
IsFunctional Gets if integrity is above breaking threshold

Inherited from IMyCubeBlock
IsWorking True if block is able to do its work depening on block type (is functional, powered, enabled, etc...)

Inherited from IMyCubeBlock
LowestPosition Gets the lowest position the piston is capable of moving to.

Inherited from IMyPistonBase
Mass Block mass

Inherited from IMyCubeBlock
Max Maximum coordinates of grid cells occupied by this block

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.

Inherited from IMyPistonBase
MaxVelocity Gets the maximum velocity this piston is capable of moving at.

Inherited from IMyPistonBase
Min Minimum coordinates of grid cells occupied by this block

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.

Inherited from IMyPistonBase
Name Some entities can have uniq name, and game can find them by name IMyEntities.TryGetEntityByNameprohibited

Inherited from IMyEntity
NormalizedPosition Gets the current position normalized between MinLimit and MaxLimit

Inherited from IMyPistonBase
NumberInGrid Order in which were the blocks of same type added to grid Used in default display name

Inherited from IMyCubeBlock
Orientation Returns block orientation in base 6 directions

Inherited from IMyCubeBlock
OwnerId IdentityId of player owning block (not steam Id)

Inherited from IMyCubeBlock
PendingAttachment Gets if the block is looking for a top part

Inherited from IMyMechanicalConnectionBlock
Position Position in grid coordinates

Inherited from IMyCubeBlock
ShowInInventory Represent terminal gui toggle Show block in Inventory Screen. Gets or sets its value

Inherited from IMyTerminalBlock
ShowInTerminal Represent terminal gui toggle Show block in terminal. Gets or sets its value

Inherited from IMyTerminalBlock
ShowInToolbarConfig Represent terminal gui toggle Show in toolbar config. Gets or sets its value

Inherited from IMyTerminalBlock
ShowOnHUD Represent terminal gui toggle Show On HUD. Gets or sets its value

Inherited from IMyTerminalBlock
Status Gets the current status.

Inherited from IMyPistonBase
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 .

Inherited from IMyPistonBase
WorldAABB Gets world axis-aligned bounding box

Inherited from IMyEntity
WorldAABBHr Gets world axis-aligned bounding box

Inherited from IMyEntity
WorldMatrix Gets world matrix of this entity

Inherited from IMyEntity
WorldVolume Gets bounding sphere of this entity

Inherited from IMyEntity
WorldVolumeHr Gets bounding sphere of this entity

Inherited from IMyEntity
IsLocked Obsolete: SafetyLock is no longer supported. This is property dummy property only, for backwards compatibility.

Gets if the block is safety locked (welded)

Inherited from IMyMechanicalConnectionBlock
SafetyLock Obsolete: SafetyLock is no longer supported. This is property dummy property only, for backwards compatibility.

Gets if the block is safety locked (welded)

Inherited from IMyMechanicalConnectionBlock
SafetyLockSpeed Obsolete: SafetyLock is no longer supported. This is property dummy property only, for backwards compatibility.

Gets or sets the speed at which this device will engage it's safety lock ( IsLocked ).

Inherited from IMyMechanicalConnectionBlock

Methods

Member 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.

Inherited from IMyPistonBase
GetActions(List, Func<ITerminalAction, bool>) Get all terminal actions available for block

Inherited from IMyTerminalBlock
GetActionWithName(string) Get first found terminal action with name

Inherited from IMyTerminalBlock
GetInventory() Simply get the MyInventoryBase component stored in this entity.

Inherited from IMyEntity
GetInventory(int) Search for inventory component with maching index.

Inherited from IMyEntity
GetOwnerFactionTag() Tag of faction owning block

Inherited from IMyCubeBlock
GetPosition() Gets position in world coordinates

Inherited from IMyEntity
GetProperties(List, Func<ITerminalProperty, bool>) Get all terminal actions available for block.

Inherited from IMyTerminalBlock
GetProperty(string) Finds terminal property with provided id

Inherited from IMyTerminalBlock
GetUserRelationToOwner(long, MyRelationsBetweenPlayerAndBlock) Gets relation to owner of block

Inherited from IMyCubeBlock
HasLocalPlayerAccess() Returns if local player can use block. Executes HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock) with local player identityId. On Dedicated Server as identityId it is using 0 as playerId

Inherited from IMyTerminalBlock
HasNobodyPlayerAccessToBlock() Returns if Nobody has access to block.

Inherited from IMyTerminalBlock
HasPlayerAccess(long, MyRelationsBetweenPlayerAndBlock) Returns if local player can use block. It is also checking for admin access.

Inherited from IMyTerminalBlock
HasPlayerAccessWithNobodyCheck(long, bool) Returns if player can use block. If playerId is 0 (Nobody), calls HasNobodyPlayerAccessToBlock instead It is also checking for admin access.

Inherited from IMyTerminalBlock
IsSameConstructAs(IMyTerminalBlock) Determines whether this block is Mechanicalprohibited 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
MoveToPosition(float, float) Sets velocity and limits to move the piston to the specified extent value

Inherited from IMyPistonBase
Retract() Retracts the piston.

Inherited from IMyPistonBase
Reverse() Reverses the direction of the piston.

Inherited from IMyPistonBase
SearchActionsOfName(string, List, Func<ITerminalAction, bool>) Get all terminal actions available for block. NOTE: First called <br /><br /> and then <br /><br /> check

Inherited from IMyTerminalBlock
GetPlayerRelationToOwner() Obsolete: GetPlayerRelationToOwner() is useless ingame. Mods should use the one in ModAPI.IMyCubeBlock

Relation of local player to the block Should not be called on Dedicated Server.

Inherited from IMyCubeBlock
RequestEnable(bool) Obsolete: Use the setter of Enabled

Obsolete

Inherited from IMyFunctionalBlock
SetCustomName(string) Obsolete: Use the setter of Customname

Obsolete

Inherited from IMyTerminalBlock
SetCustomName(StringBuilder) Obsolete: Use the setter of Customname

Obsolete

Inherited from IMyTerminalBlock
UpdateIsWorking() Obsolete

Force refresh working state. Call if you change block state that could affect its working status.

Inherited from IMyCubeBlock
UpdateVisual() Obsolete

Updates block visuals (ie. block emissivity)

Inherited from IMyCubeBlock

Implements:

Type Definitions: