Space Engineers
Public Member Functions | Properties | List of all members
SpaceEngineers.Game.ModAPI.Ingame.IMyGravityGeneratorBase Interface Reference
Inheritance diagram for SpaceEngineers.Game.ModAPI.Ingame.IMyGravityGeneratorBase:
Sandbox.ModAPI.Ingame.IMyFunctionalBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock SpaceEngineers.Game.ModAPI.IMyGravityGeneratorBase SpaceEngineers.Game.ModAPI.Ingame.IMyGravityGenerator SpaceEngineers.Game.ModAPI.Ingame.IMyGravityGeneratorSphere SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorBase SpaceEngineers.Game.ModAPI.IMyGravityGenerator SpaceEngineers.Game.ModAPI.IMyGravityGeneratorSphere SpaceEngineers.Game.ModAPI.IMyGravityGenerator SpaceEngineers.Game.ModAPI.IMyGravityGeneratorSphere SpaceEngineers.Game.Entities.Blocks.MyGravityGenerator SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorSphere SpaceEngineers.Game.Entities.Blocks.MyGravityGenerator SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorSphere SpaceEngineers.Game.Entities.Blocks.MyGravityGenerator SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorSphere

Public Member Functions

bool IsPositionInRange (Vector3D worldPoint)
 Tests if the specified point is within the gravity of this entity. More...
 
Vector3 GetWorldGravity (Vector3D worldPoint)
 Gets the gravity vector at the specified point. 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 Gravity [get, set]
 Gets or sets the gravity acceleration in Gs. More...
 
float GravityAcceleration [get, set]
 Gets or sets the gravity acceleration in m/s. 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]
 

Additional Inherited Members

- 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 6 of file IMyGravityGeneratorBase.cs.

Member Function Documentation

Vector3 SpaceEngineers.Game.ModAPI.Ingame.IMyGravityGeneratorBase.GetWorldGravity ( Vector3D  worldPoint)

Gets the gravity vector at the specified point.

Parameters
worldPointWorld position to retrieve gravity for.
Returns
Direction of gravity starting at specified point.

Implemented in SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorSphere, SpaceEngineers.Game.Entities.Blocks.MyGravityGenerator, and SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorBase.

bool SpaceEngineers.Game.ModAPI.Ingame.IMyGravityGeneratorBase.IsPositionInRange ( Vector3D  worldPoint)

Tests if the specified point is within the gravity of this entity.

Parameters
worldPointPoint to test
Returns
true if in range; false if not

Implemented in SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorSphere, SpaceEngineers.Game.Entities.Blocks.MyGravityGenerator, and SpaceEngineers.Game.Entities.Blocks.MyGravityGeneratorBase.

Property Documentation

float SpaceEngineers.Game.ModAPI.Ingame.IMyGravityGeneratorBase.Gravity
getset

Gets or sets the gravity acceleration in Gs.

Definition at line 11 of file IMyGravityGeneratorBase.cs.

float SpaceEngineers.Game.ModAPI.Ingame.IMyGravityGeneratorBase.GravityAcceleration
getset

Gets or sets the gravity acceleration in m/s.

Definition at line 16 of file IMyGravityGeneratorBase.cs.


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