Skip to content
This repository has been archived by the owner on Oct 22, 2024. It is now read-only.

Sandbox.ModAPI.Ingame.IMyMotorSuspension

Morten Aune Lyrstad edited this page Dec 19, 2019 · 60 revisions

IndexNamespace Index

IMyMotorSuspension Interface

public interface IMyMotorSuspension: IMyMotorBase, IMyMechanicalConnectionBlock, IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntity

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

Implements:

Type Definitions:

  • MyObjectBuilder_MotorSuspension/Suspension3x3
  • MyObjectBuilder_MotorSuspension/Suspension5x5
  • MyObjectBuilder_MotorSuspension/Suspension1x1
  • MyObjectBuilder_MotorSuspension/SmallSuspension3x3
  • MyObjectBuilder_MotorSuspension/SmallSuspension5x5
  • MyObjectBuilder_MotorSuspension/SmallSuspension1x1
  • MyObjectBuilder_MotorSuspension/Suspension3x3mirrored
  • MyObjectBuilder_MotorSuspension/Suspension5x5mirrored
  • MyObjectBuilder_MotorSuspension/Suspension1x1mirrored
  • MyObjectBuilder_MotorSuspension/SmallSuspension3x3mirrored
  • MyObjectBuilder_MotorSuspension/SmallSuspension5x5mirrored
  • MyObjectBuilder_MotorSuspension/SmallSuspension1x1mirrored

Properties

Member Description
Steering
Propulsion
InvertSteer
InvertPropulsion
Damping Obsolete
Strength
Friction
Power
Height
SteerAngle Wheel's current steering angle
MaxSteerAngle Max steering angle in radians.
SteerSpeed Obsolete

Speed at which wheel steers.
SteerReturnSpeed Obsolete

Speed at which wheel returns from steering.
SuspensionTravel Obsolete

Suspension travel, value from 0 to 1.
Brake Gets or sets brake applied to the wheel.
AirShockEnabled Enables or disalbes AirShock function.
Components Inherited from IMyEntity
EntityId Inherited from IMyEntity
Name Inherited from IMyEntity
DisplayName 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
InventoryCount Returns the count of the number of inventories this entity has.

Inherited from IMyEntity
WorldAABB Inherited from IMyEntity
WorldAABBHr Inherited from IMyEntity
WorldMatrix Inherited from IMyEntity
WorldVolume Inherited from IMyEntity
WorldVolumeHr Inherited from IMyEntity
BlockDefinition Inherited from IMyCubeBlock
CheckConnectionAllowed Inherited from IMyCubeBlock
CubeGrid Grid in which the block is placed

Inherited from IMyCubeBlock
DefinitionDisplayNameText Definition name

Inherited from IMyCubeBlock
DisassembleRatio Is set in definition Ratio at which is the block disassembled (grinding)

Inherited from IMyCubeBlock
DisplayNameText Translated block name

Inherited from IMyCubeBlock
IsBeingHacked Hacking of the block is in progress

Inherited from IMyCubeBlock
IsFunctional True 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
Max Maximum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock
Mass Block mass

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

Inherited from IMyCubeBlock
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 Id of player owning block (not steam Id)

Inherited from IMyCubeBlock
Position Position in grid coordinates

Inherited from IMyCubeBlock
CustomName Inherited from IMyTerminalBlock
CustomNameWithFaction Inherited from IMyTerminalBlock
DetailedInfo Inherited from IMyTerminalBlock
CustomInfo Inherited from IMyTerminalBlock
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
ShowOnHUD Inherited from IMyTerminalBlock
ShowInTerminal Inherited from IMyTerminalBlock
ShowInToolbarConfig Inherited from IMyTerminalBlock
ShowInInventory Inherited from IMyTerminalBlock
Enabled Inherited from IMyFunctionalBlock
TopGrid Gets the grid of the attached top part

Inherited from IMyMechanicalConnectionBlock
Top Gets the attached top part entity

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
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
IsAttached Gets if the block base is attached to something

Inherited from IMyMechanicalConnectionBlock
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
PendingAttachment Gets if the block is looking for a top part

Inherited from IMyMechanicalConnectionBlock

Methods

Member Description
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
GetPosition() Inherited from IMyEntity
GetOwnerFactionTag() Tag of faction owning block

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

Inherited from IMyCubeBlock
GetUserRelationToOwner(long) Inherited from IMyCubeBlock
UpdateIsWorking() Obsolete

Inherited from IMyCubeBlock
UpdateVisual() Obsolete

Inherited from IMyCubeBlock
HasLocalPlayerAccess() Inherited from IMyTerminalBlock
HasPlayerAccess(long) Inherited from IMyTerminalBlock
SetCustomName(string) Obsolete: Use the setter of Customname

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

Inherited from IMyTerminalBlock
GetActions(List, Func) Inherited from IMyTerminalBlock
SearchActionsOfName(string, List, Func) Inherited from IMyTerminalBlock
GetActionWithName(string) Inherited from IMyTerminalBlock
GetProperty(string) Inherited from IMyTerminalBlock
GetProperties(List, Func) Inherited from IMyTerminalBlock
IsSameConstructAs(IMyTerminalBlock) 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
RequestEnable(bool) Obsolete: Use the setter of Enabled

Inherited from IMyFunctionalBlock
Attach() Attaches a nearby top part to the block

Inherited from IMyMechanicalConnectionBlock
Detach() Detaches the top from the base

Inherited from IMyMechanicalConnectionBlock
Clone this wiki locally