Interface IMyGps

Describes GPS (mods interface)

Namespace: VRage.Game.ModAPI
Assembly: VRage.Game.dll
Syntax
public interface IMyGps

Properties

ContainerRemainingTime

Gets or sets gps text that would be displayed on HUD

Declaration
string ContainerRemainingTime { get; set; }
Property Value
Type Description
System.String
Remarks

Set method doesn't synchronize data over network. Use ModifyGps(Int64, IMyGps), to update data

Coords

Gets or sets GPS coordinates

Declaration
Vector3D Coords { get; set; }
Property Value
Type Description
Vector3D
Remarks

Set method doesn't synchronize data over network. Use ModifyGps(Int64, IMyGps), to update data

Description

Gets or sets GPS description

Declaration
string Description { get; set; }
Property Value
Type Description
System.String
Remarks

Set method doesn't synchronize data over network. Use ModifyGps(Int64, IMyGps), to update data

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

Declaration
Nullable<TimeSpan> DiscardAt { get; set; }
Property Value
Type Description
System.Nullable<System.TimeSpan>
Remarks

Set method doesn't synchronize data over network. Use ModifyGps(Int64, IMyGps), to update data

GPSColor

Gets or sets GPS color

Declaration
Color GPSColor { get; set; }
Property Value
Type Description
Color
Remarks

Set method doesn't synchronize data over network. Use ModifyGps(Int64, IMyGps), to update data

Hash

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

Declaration
int Hash { get; }
Property Value
Type Description
System.Int32

Name

Gets or sets GPS name

Declaration
string Name { get; set; }
Property Value
Type Description
System.String
Remarks

Set method doesn't synchronize data over network. Use ModifyGps(Int64, IMyGps), to update data

ShowOnHud

Gets or sets whether GPS should be visible on HUD

Declaration
bool ShowOnHud { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Set method doesn't synchronize data over network. Use ModifyGps(Int64, IMyGps), to update data

Methods

ToString()

Gets information about GPS

Declaration
string ToString()
Returns
Type Description
System.String

String, same that user gets on Copy to clipboard
Remarks

Set method doesn't synchronize data over network. Use ModifyGps(Int64, IMyGps), to update data

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.

Declaration
void UpdateHash()