Space Engineers
Public Member Functions | Properties | Events | List of all members
Sandbox.ModAPI.Ingame.IMyPistonBase Interface Reference
Inheritance diagram for Sandbox.ModAPI.Ingame.IMyPistonBase:
Sandbox.ModAPI.Ingame.IMyFunctionalBlock Sandbox.ModAPI.Ingame.IMyFunctionalBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.IMyPistonBase Sandbox.ModAPI.Ingame.IMyExtendedPistonBase Sandbox.Game.Entities.Blocks.MyPistonBase Sandbox.ModAPI.IMyExtendedPistonBase Sandbox.ModAPI.IMyExtendedPistonBase Sandbox.Game.Entities.Blocks.MyExtendedPistonBase Sandbox.Game.Entities.Blocks.MyExtendedPistonBase Sandbox.Game.Entities.Blocks.MyExtendedPistonBase

Public Member Functions

void Attach ()
 Attaches a nearby top part to the piston block More...
 
void Detach ()
 Detaches the top from the piston More...
 
- Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
void RequestEnable (bool enable)
 
void RequestEnable (bool enable)
 
- Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
bool HasLocalPlayerAccess ()
 
bool HasPlayerAccess (long playerId)
 
void SetCustomName (string text)
 
void SetCustomName (StringBuilder text)
 
void GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
void SearchActionsOfName (string name, List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
Sandbox.ModAPI.Interfaces.ITerminalAction GetActionWithName (string name)
 
Sandbox.ModAPI.Interfaces.ITerminalProperty GetProperty (string id)
 
void GetProperties (List< Sandbox.ModAPI.Interfaces.ITerminalProperty > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalProperty, bool > collect=null)
 
bool HasLocalPlayerAccess ()
 
bool HasPlayerAccess (long playerId)
 
void RequestShowOnHUD (bool enable)
 
void SetCustomName (string text)
 
void SetCustomName (StringBuilder text)
 
void GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
- Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
string GetOwnerFactionTag ()
 
Sandbox.Common.MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner ()
 
Sandbox.Common.MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner (long playerId)
 
void UpdateIsWorking ()
 
void UpdateVisual ()
 

Properties

float Velocity [get]
 Param - limit is top More...
 
float MinLimit [get]
 
float MaxLimit [get]
 
float CurrentPosition [get]
 Gets the current position of the piston head relative to the base. More...
 
PistonStatus Status [get]
 Gets the current status. More...
 
bool IsAttached [get]
 Gets if the piston base is attached to the top piece More...
 
bool IsLocked [get]
 Gets if the piston is safety locked (welded) More...
 
bool PendingAttachment [get]
 Gets if the piston is looking for a top part More...
 
- Properties inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
bool Enabled [get]
 
- Properties inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
string CustomName [get]
 
string CustomNameWithFaction [get]
 
string DetailedInfo [get]
 
string CustomInfo [get]
 
string CustomData [get, set]
 Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent More...
 
bool ShowOnHUD [get]
 
- Properties inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Sandbox.Common.ObjectBuilders.Definitions.SerializableDefinitionId BlockDefinition [get]
 
bool CheckConnectionAllowed [get]
 
IMyCubeGrid CubeGrid [get]
 
String DefinitionDisplayNameText [get]
 
float DisassembleRatio [get]
 
String DisplayNameText [get]
 
bool IsBeingHacked [get]
 
bool IsFunctional [get]
 
bool IsWorking [get]
 
VRageMath.Vector3I Max [get]
 
VRageMath.Vector3I Min [get]
 
int NumberInGrid [get]
 
VRageMath.MyBlockOrientation Orientation [get]
 
long OwnerId [get]
 
VRageMath.Vector3I Position [get]
 

Events

Action< bool > LimitReached
 Param - limit is top More...
 
- Events inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
Action< IMyTerminalBlockEnabledChanged
 
- Events inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
Action< IMyTerminalBlockCustomNameChanged
 
Action< IMyTerminalBlockOwnershipChanged
 
Action< IMyTerminalBlockPropertiesChanged
 
Action< IMyTerminalBlockShowOnHUDChanged
 
Action< IMyTerminalBlockVisibilityChanged
 
- Events inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Action< IMyCubeBlockIsWorkingChanged
 

Detailed Description

Definition at line 8 of file IMyPistonBase.cs.

Member Function Documentation

void Sandbox.ModAPI.Ingame.IMyPistonBase.Attach ( )

Attaches a nearby top part to the piston block

void Sandbox.ModAPI.Ingame.IMyPistonBase.Detach ( )

Detaches the top from the piston

Property Documentation

float Sandbox.ModAPI.Ingame.IMyPistonBase.CurrentPosition
get

Gets the current position of the piston head relative to the base.

Definition at line 20 of file IMyPistonBase.cs.

bool Sandbox.ModAPI.Ingame.IMyPistonBase.IsAttached
get

Gets if the piston base is attached to the top piece

Definition at line 30 of file IMyPistonBase.cs.

bool Sandbox.ModAPI.Ingame.IMyPistonBase.IsLocked
get

Gets if the piston is safety locked (welded)

Definition at line 35 of file IMyPistonBase.cs.

float Sandbox.ModAPI.Ingame.IMyPistonBase.MaxLimit
get

Definition at line 15 of file IMyPistonBase.cs.

float Sandbox.ModAPI.Ingame.IMyPistonBase.MinLimit
get

Definition at line 14 of file IMyPistonBase.cs.

bool Sandbox.ModAPI.Ingame.IMyPistonBase.PendingAttachment
get

Gets if the piston is looking for a top part

Definition at line 40 of file IMyPistonBase.cs.

PistonStatus Sandbox.ModAPI.Ingame.IMyPistonBase.Status
get

Gets the current status.

Definition at line 25 of file IMyPistonBase.cs.

float Sandbox.ModAPI.Ingame.IMyPistonBase.Velocity
get

Param - limit is top

Definition at line 13 of file IMyPistonBase.cs.

Event Documentation

Action<bool> Sandbox.ModAPI.Ingame.IMyPistonBase.LimitReached

Param - limit is top

Definition at line 13 of file IMyPistonBase.cs.


The documentation for this interface was generated from the following file: