Space Engineers
Public Member Functions | Public Attributes | Properties | List of all members
Sandbox.Game.Screens.Helpers.MyGps Class Reference
Inheritance diagram for Sandbox.Game.Screens.Helpers.MyGps:
VRage.Game.ModAPI.IMyGps

Public Member Functions

void UpdateHash ()
 Updates the hash id if you've changed the name or the coordinates. NOTE: Do not use this if you plan on using this object to update existing GPS entries. More...
 
override int GetHashCode ()
 
override string ToString ()
 
void ToClipboard ()
 
 MyGps (MyObjectBuilder_Gps.Entry builder)
 
 MyGps ()
 
void SetDiscardAt ()
 
void SetEntity (IMyEntity entity)
 
void Close ()
 

Public Attributes

string Name
 
string Description
 
Vector3D Coords
 
Color GPSColor
 
bool ShowOnHud
 
bool AlwaysVisible
 
TimeSpan DiscardAt
 
bool IsLocal = false
 

Properties

int Hash [get]
 
- Properties inherited from VRage.Game.ModAPI.IMyGps
int Hash [get]
 The GPS entry id hash which is generated using the GPS name and coordinates. More...
 
string Name [get, set]
 
string Description [get, set]
 
Vector3D Coords [get, set]
 
bool ShowOnHud [get, set]
 
TimeSpan DiscardAt [get, set]
 If it's null then the GPS is confirmed (does not expire automatically). Otherwise, time at which we should drop it from the list, relative to ElapsedPlayTime More...
 

Detailed Description

Definition at line 13 of file MyGps.cs.

Constructor & Destructor Documentation

Sandbox.Game.Screens.Helpers.MyGps.MyGps ( MyObjectBuilder_Gps.Entry  builder)
inline

Definition at line 66 of file MyGps.cs.

Sandbox.Game.Screens.Helpers.MyGps.MyGps ( )
inline

Definition at line 81 of file MyGps.cs.

Member Function Documentation

void Sandbox.Game.Screens.Helpers.MyGps.Close ( )
inline

Definition at line 114 of file MyGps.cs.

override int Sandbox.Game.Screens.Helpers.MyGps.GetHashCode ( )
inline

Definition at line 40 of file MyGps.cs.

void Sandbox.Game.Screens.Helpers.MyGps.SetDiscardAt ( )
inline

Definition at line 87 of file MyGps.cs.

void Sandbox.Game.Screens.Helpers.MyGps.SetEntity ( IMyEntity  entity)
inline

Definition at line 92 of file MyGps.cs.

void Sandbox.Game.Screens.Helpers.MyGps.ToClipboard ( )
inline

Definition at line 54 of file MyGps.cs.

override string Sandbox.Game.Screens.Helpers.MyGps.ToString ( )
inline

Implements VRage.Game.ModAPI.IMyGps.

Definition at line 44 of file MyGps.cs.

void Sandbox.Game.Screens.Helpers.MyGps.UpdateHash ( )
inline

Updates the hash id if you've changed the name or the coordinates. NOTE: Do not use this if you plan on using this object to update existing GPS entries.

Implements VRage.Game.ModAPI.IMyGps.

Definition at line 32 of file MyGps.cs.

Member Data Documentation

bool Sandbox.Game.Screens.Helpers.MyGps.AlwaysVisible

Definition at line 23 of file MyGps.cs.

Vector3D Sandbox.Game.Screens.Helpers.MyGps.Coords

Definition at line 20 of file MyGps.cs.

string Sandbox.Game.Screens.Helpers.MyGps.Description

Definition at line 19 of file MyGps.cs.

TimeSpan Sandbox.Game.Screens.Helpers.MyGps.DiscardAt

Definition at line 24 of file MyGps.cs.

Color Sandbox.Game.Screens.Helpers.MyGps.GPSColor

Definition at line 21 of file MyGps.cs.

bool Sandbox.Game.Screens.Helpers.MyGps.IsLocal = false

Definition at line 25 of file MyGps.cs.

string Sandbox.Game.Screens.Helpers.MyGps.Name

Definition at line 18 of file MyGps.cs.

bool Sandbox.Game.Screens.Helpers.MyGps.ShowOnHud

Definition at line 22 of file MyGps.cs.

Property Documentation

int Sandbox.Game.Screens.Helpers.MyGps.Hash
get

Definition at line 28 of file MyGps.cs.


The documentation for this class was generated from the following files: