VRage.Game.ModAPI.IMyGpsCollection Interface Reference

Inheritance diagram for VRage.Game.ModAPI.IMyGpsCollection:

Public Member Functions
List< IMyGps >	GetGpsList (long identityId)
	Gets the GPS entries from the specified identity (does not use network traffic). More...
void	GetGpsList (long identityId, List< IMyGps > list)
	Gets the GPS entries from the specified identity (does not use network traffic). More...
IMyGps	Create (string name, string description, Vector3D coords, bool showOnHud, bool temporary=false)
	Creates a GPS entry object. Does not automatically add it, you need to use AddGps() or AddLocalGps(). More...
void	AddGps (long identityId, IMyGps gps)
	Sends a network request to add the GPS entry for the said player, which will also save it to the server. More...
void	ModifyGps (long identityId, IMyGps gps)
	Sends a network request to modify the contents of an existing GPS entry. More...
void	RemoveGps (long identityId, IMyGps gps)
	Sends a network request to remove the specified GPS entry. More...
void	RemoveGps (long identityId, int gpsHash)
	Sends a network request to remove the specified GPS entry. More...
void	SetShowOnHud (long identityId, IMyGps gps, bool show)
	Sends a network request to set the GPS entry if it's shown on HUD or not. More...
void	SetShowOnHud (long identityId, int gpsHash, bool show)
	Sends a network request to set the GPS entry if it's shown on HUD or not. More...
void	AddLocalGps (IMyGps gps)
	Adds a GPS entry only for this client which won't be synchronized or saved. More...
void	RemoveLocalGps (IMyGps gps)
	Remove a local GPS entry, no network updates sent. More...
void	RemoveLocalGps (int gpsHash)
	Remove a local GPS entry, no network updates sent. More...

Detailed Description

Definition at line 6 of file IMyGpsCollection.cs.

Member Function Documentation

void VRage.Game.ModAPI.IMyGpsCollection.AddGps	(	long	identityId,
		IMyGps	gps
	)

Sends a network request to add the GPS entry for the said player, which will also save it to the server.

Parameters

playerId
gps	Use the Create() method to get this object

void VRage.Game.ModAPI.IMyGpsCollection.AddLocalGps

(

IMyGps

gps

)

Adds a GPS entry only for this client which won't be synchronized or saved.

Parameters

gps

IMyGps VRage.Game.ModAPI.IMyGpsCollection.Create	(	string	name,
		string	description,
		Vector3D	coords,
		bool	showOnHud,
		bool	temporary = false
	)

Creates a GPS entry object. Does not automatically add it, you need to use AddGps() or AddLocalGps().

Parameters

name
description
coords
showOnHud
temporary	wether it automatically expires or not (DiscardAt field)

Returns

List<IMyGps> VRage.Game.ModAPI.IMyGpsCollection.GetGpsList

(

long

identityId

)

Gets the GPS entries from the specified identity (does not use network traffic).

Parameters

identityId

Returns

The GPS entry list.

void VRage.Game.ModAPI.IMyGpsCollection.GetGpsList	(	long	identityId,
		List< IMyGps >	list
	)

Gets the GPS entries from the specified identity (does not use network traffic).

Parameters

identityId
list	GPS entries will be added to this list. The list is not cleared internally.

Implemented in Sandbox.Game.Multiplayer.MyGpsCollection.

void VRage.Game.ModAPI.IMyGpsCollection.ModifyGps	(	long	identityId,
		IMyGps	gps
	)

Sends a network request to modify the contents of an existing GPS entry.

Parameters

identityId
gps	NOTE: it must contain the original hash id

void VRage.Game.ModAPI.IMyGpsCollection.RemoveGps	(	long	identityId,
		IMyGps	gps
	)

Sends a network request to remove the specified GPS entry.

Parameters

identityId
gps

void VRage.Game.ModAPI.IMyGpsCollection.RemoveGps	(	long	identityId,
		int	gpsHash
	)

Sends a network request to remove the specified GPS entry.

Parameters

identityId
gpsHash

void VRage.Game.ModAPI.IMyGpsCollection.RemoveLocalGps

(

IMyGps

gps

)

Remove a local GPS entry, no network updates sent.

NOTE: This can remove synchronized ones too.

Parameters

gps

void VRage.Game.ModAPI.IMyGpsCollection.RemoveLocalGps

(

int

gpsHash

)

Remove a local GPS entry, no network updates sent.

NOTE: This can remove synchronized ones too.

Parameters

gpsHash

void VRage.Game.ModAPI.IMyGpsCollection.SetShowOnHud	(	long	identityId,
		IMyGps	gps,
		bool	show
	)

Sends a network request to set the GPS entry if it's shown on HUD or not.

Parameters

identityId
gps
show

void VRage.Game.ModAPI.IMyGpsCollection.SetShowOnHud	(	long	identityId,
		int	gpsHash,
		bool	show
	)

Sends a network request to set the GPS entry if it's shown on HUD or not.

Parameters

identityId
gpsHash
show

---

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

• Sources/VRage.Game/ModAPI/IMyGpsCollection.cs