VRage.Game.ModAPI.IMyUtilities Interface Reference

Inheritance diagram for VRage.Game.ModAPI.IMyUtilities:

Public Member Functions
string	GetTypeName (Type type)
void	ShowNotification (string message, int disappearTimeMs=2000, string font=MyFontEnum.White)
IMyHudNotification	CreateNotification (string message, int disappearTimeMs=2000, string font=MyFontEnum.White)
	Create a notification object. The object needs to have Show() called on it to be shown. On top of that you can dynamically change the text, font and adjust the time to live. More...
void	ShowMessage (string sender, string messageText)
void	SendMessage (string messageText)
bool	FileExistsInGlobalStorage (string file)
bool	FileExistsInLocalStorage (string file, Type callingType)
bool	FileExistsInWorldStorage (string file, Type callingType)
void	DeleteFileInGlobalStorage (string file)
void	DeleteFileInLocalStorage (string file, Type callingType)
void	DeleteFileInWorldStorage (string file, Type callingType)
System.IO.TextReader	ReadFileInGlobalStorage (string file)
System.IO.TextReader	ReadFileInLocalStorage (string file, Type callingType)
System.IO.TextReader	ReadFileInWorldStorage (string file, Type callingType)
	Read text file from the current world's Storage directory. More...
System.IO.TextWriter	WriteFileInGlobalStorage (string file)
System.IO.TextWriter	WriteFileInLocalStorage (string file, Type callingType)
System.IO.TextWriter	WriteFileInWorldStorage (string file, Type callingType)
	Write text file to the current world's Storage directory. More...
string	SerializeToXML< T > (T objToSerialize)
T	SerializeFromXML< T > (string buffer)
void	InvokeOnGameThread (Action action)
void	ShowMissionScreen (string screenTitle=null, string currentObjectivePrefix=null, string currentObjective=null, string screenDescription=null, Action< ResultEnum > callback=null, string okButtonCaption=null)
IMyHudObjectiveLine	GetObjectiveLine ()
System.IO.BinaryReader	ReadBinaryFileInGlobalStorage (string file)
System.IO.BinaryReader	ReadBinaryFileInLocalStorage (string file, Type callingType)
System.IO.BinaryReader	ReadBinaryFileInWorldStorage (string file, Type callingType)
	Read file from the current world's Storage directory. More...
System.IO.BinaryWriter	WriteBinaryFileInGlobalStorage (string file)
System.IO.BinaryWriter	WriteBinaryFileInLocalStorage (string file, Type callingType)
System.IO.BinaryWriter	WriteBinaryFileInWorldStorage (string file, Type callingType)
	Write file to the current world's Storage directory. More...
void	SetVariable< T > (string name, T value)
bool	GetVariable< T > (string name, out T value)
bool	RemoveVariable (string name)

Properties
IMyConfigDedicated	ConfigDedicated [get]
IMyGamePaths	GamePaths [get]
bool	IsDedicated [get]

Events
MessageEnteredDel	MessageEntered

Detailed Description

Definition at line 12 of file IMyUtilities.cs.

Member Function Documentation

IMyHudNotification VRage.Game.ModAPI.IMyUtilities.CreateNotification	(	string	message,
		int	disappearTimeMs = 2000,
		string	font = MyFontEnum.White
	)

Create a notification object. The object needs to have Show() called on it to be shown. On top of that you can dynamically change the text, font and adjust the time to live.

Parameters

message
disappearTimeMs
font

Returns

The notification object.

void VRage.Game.ModAPI.IMyUtilities.DeleteFileInGlobalStorage

(

string

file

)

void VRage.Game.ModAPI.IMyUtilities.DeleteFileInLocalStorage	(	string	file,
		Type	callingType
	)

void VRage.Game.ModAPI.IMyUtilities.DeleteFileInWorldStorage	(	string	file,
		Type	callingType
	)

bool VRage.Game.ModAPI.IMyUtilities.FileExistsInGlobalStorage

(

string

file

)

bool VRage.Game.ModAPI.IMyUtilities.FileExistsInLocalStorage	(	string	file,
		Type	callingType
	)

bool VRage.Game.ModAPI.IMyUtilities.FileExistsInWorldStorage	(	string	file,
		Type	callingType
	)

IMyHudObjectiveLine VRage.Game.ModAPI.IMyUtilities.GetObjectiveLine

(

)

string VRage.Game.ModAPI.IMyUtilities.GetTypeName

(

Type

type

)

bool VRage.Game.ModAPI.IMyUtilities.GetVariable< T >	(	string	name,
		out T	value
	)

void VRage.Game.ModAPI.IMyUtilities.InvokeOnGameThread

(

Action

action

)

System.IO.BinaryReader VRage.Game.ModAPI.IMyUtilities.ReadBinaryFileInGlobalStorage

(

string

file

)

System.IO.BinaryReader VRage.Game.ModAPI.IMyUtilities.ReadBinaryFileInLocalStorage	(	string	file,
		Type	callingType
	)

System.IO.BinaryReader VRage.Game.ModAPI.IMyUtilities.ReadBinaryFileInWorldStorage	(	string	file,
		Type	callingType
	)

Read file from the current world's Storage directory.

Parameters

file
callingType

Returns

System.IO.TextReader VRage.Game.ModAPI.IMyUtilities.ReadFileInGlobalStorage

(

string

file

)

System.IO.TextReader VRage.Game.ModAPI.IMyUtilities.ReadFileInLocalStorage	(	string	file,
		Type	callingType
	)

System.IO.TextReader VRage.Game.ModAPI.IMyUtilities.ReadFileInWorldStorage	(	string	file,
		Type	callingType
	)

Read text file from the current world's Storage directory.

Parameters

file
callingType

Returns

This directory is under Saves<SteamId><WorldName>

bool VRage.Game.ModAPI.IMyUtilities.RemoveVariable

(

string

name

)

void VRage.Game.ModAPI.IMyUtilities.SendMessage

(

string

messageText

)

T VRage.Game.ModAPI.IMyUtilities.SerializeFromXML< T >

(

string

buffer

)

string VRage.Game.ModAPI.IMyUtilities.SerializeToXML< T >

(

T

objToSerialize

)

void VRage.Game.ModAPI.IMyUtilities.SetVariable< T >	(	string	name,
		T	value
	)

void VRage.Game.ModAPI.IMyUtilities.ShowMessage	(	string	sender,
		string	messageText
	)

void VRage.Game.ModAPI.IMyUtilities.ShowMissionScreen	(	string	screenTitle = null,
		string	currentObjectivePrefix = null,
		string	currentObjective = null,
		string	screenDescription = null,
		Action< ResultEnum >	callback = null,
		string	okButtonCaption = null
	)

void VRage.Game.ModAPI.IMyUtilities.ShowNotification	(	string	message,
		int	disappearTimeMs = 2000,
		string	font = MyFontEnum.White
	)

System.IO.BinaryWriter VRage.Game.ModAPI.IMyUtilities.WriteBinaryFileInGlobalStorage

(

string

file

)

System.IO.BinaryWriter VRage.Game.ModAPI.IMyUtilities.WriteBinaryFileInLocalStorage	(	string	file,
		Type	callingType
	)

System.IO.BinaryWriter VRage.Game.ModAPI.IMyUtilities.WriteBinaryFileInWorldStorage	(	string	file,
		Type	callingType
	)

Write file to the current world's Storage directory.

Parameters

file
callingType

Returns

System.IO.TextWriter VRage.Game.ModAPI.IMyUtilities.WriteFileInGlobalStorage

(

string

file

)

System.IO.TextWriter VRage.Game.ModAPI.IMyUtilities.WriteFileInLocalStorage	(	string	file,
		Type	callingType
	)

System.IO.TextWriter VRage.Game.ModAPI.IMyUtilities.WriteFileInWorldStorage	(	string	file,
		Type	callingType
	)

Write text file to the current world's Storage directory.

Parameters

file
callingType

Returns

Property Documentation

IMyConfigDedicated VRage.Game.ModAPI.IMyUtilities.ConfigDedicated

get

Definition at line 14 of file IMyUtilities.cs.

IMyGamePaths VRage.Game.ModAPI.IMyUtilities.GamePaths

get

Definition at line 69 of file IMyUtilities.cs.

bool VRage.Game.ModAPI.IMyUtilities.IsDedicated

get

Definition at line 70 of file IMyUtilities.cs.

Event Documentation

MessageEnteredDel VRage.Game.ModAPI.IMyUtilities.MessageEntered

Definition at line 31 of file IMyUtilities.cs.

---

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

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