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

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...
 
string ToString ()
 

Properties

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

Member Function Documentation

string VRage.Game.ModAPI.IMyGps.ToString ( )
void VRage.Game.ModAPI.IMyGps.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.

Implemented in Sandbox.Game.Screens.Helpers.MyGps.

Property Documentation

Vector3D VRage.Game.ModAPI.IMyGps.Coords
getset

Definition at line 23 of file IMyGps.cs.

string VRage.Game.ModAPI.IMyGps.Description
getset

Definition at line 21 of file IMyGps.cs.

TimeSpan VRage.Game.ModAPI.IMyGps.DiscardAt
getset

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

Definition at line 31 of file IMyGps.cs.

int VRage.Game.ModAPI.IMyGps.Hash
get

The GPS entry id hash which is generated using the GPS name and coordinates.

Definition at line 11 of file IMyGps.cs.

string VRage.Game.ModAPI.IMyGps.Name
getset

Definition at line 19 of file IMyGps.cs.

bool VRage.Game.ModAPI.IMyGps.ShowOnHud
getset

Definition at line 25 of file IMyGps.cs.


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