VRage.Game.ModAPI
IMyGps
Assembly: VRage.Game.dll
public interface IMyGps
Describes GPS (mods interface)
Properties
| Member | Description |
|---|---|
| ContainerRemainingTime | Gets or sets gps text that would be displayed on HUD |
| Coords | Gets or sets GPS coordinates |
| Description | Gets or sets GPS description |
| DiscardAt | 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 |
| GPSColor | Gets or sets GPS color |
| Hash | The GPS entry id hash which is generated using the GPS name and coordinates. |
| Name | Gets or sets GPS name |
| ShowOnHud | Gets or sets whether GPS should be visible on HUD |
Methods
| Member | Description |
|---|---|
| ToString() | Gets information about GPS |
| 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. |