Class MyAPIUtilities

Inheritance

System.Object

MyAPIUtilities

Implements

IMyUtilities

IMyGamePaths

Namespace: Sandbox.ModAPI

Assembly: Sandbox.Game.dll

Syntax

public class MyAPIUtilities : Object, IMyUtilities, IMyGamePaths

Constructors

MyAPIUtilities()

Declaration

public MyAPIUtilities()

Fields

Static

Declaration

public static readonly MyAPIUtilities Static

Field Value

Type	Description
MyAPIUtilities

Variables

Declaration

public Dictionary<string, object> Variables

Field Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

Methods

add_MessageEntered(MessageEnteredDel)

Declaration

public void add_MessageEntered(MessageEnteredDel value)

Parameters

Type	Name	Description
MessageEnteredDel	value

add_MessageEnteredSender(MessageEnteredSenderDel)

Declaration

public void add_MessageEnteredSender(MessageEnteredSenderDel value)

Parameters

Type	Name	Description
MessageEnteredSenderDel	value

EnterMessage(UInt64, String, ref Boolean)

Declaration

public void EnterMessage(ulong sender, string messageText, ref bool sendToOthers)

Parameters

Type	Name	Description
System.UInt64	sender
System.String	messageText
System.Boolean	sendToOthers

EnterMessageSender(UInt64, String, ref Boolean)

Declaration

public void EnterMessageSender(ulong sender, string messageText, ref bool sendToOthers)

Parameters

Type	Name	Description
System.UInt64	sender
System.String	messageText
System.Boolean	sendToOthers

RecieveMessage(UInt64, String)

Declaration

public void RecieveMessage(ulong senderSteamId, string message)

Parameters

Type	Name	Description
System.UInt64	senderSteamId
System.String	message

RegisterMessageHandler(Int64, Action<Object>)

Declaration

public void RegisterMessageHandler(long id, Action<object> messageHandler)

Parameters

Type	Name	Description
System.Int64	id
System.Action<System.Object>	messageHandler

remove_MessageEntered(MessageEnteredDel)

Declaration

public void remove_MessageEntered(MessageEnteredDel value)

Parameters

Type	Name	Description
MessageEnteredDel	value

remove_MessageEnteredSender(MessageEnteredSenderDel)

Declaration

public void remove_MessageEnteredSender(MessageEnteredSenderDel value)

Parameters

Type	Name	Description
MessageEnteredSenderDel	value

SendModMessage(Int64, Object)

Declaration

public void SendModMessage(long id, object payload)

Parameters

Type	Name	Description
System.Int64	id
System.Object	payload

UnregisterMessageHandler(Int64, Action<Object>)

Declaration

public void UnregisterMessageHandler(long id, Action<object> messageHandler)

Parameters

Type	Name	Description
System.Int64	id
System.Action<System.Object>	messageHandler

Events

MessageEntered

Declaration

public event MessageEnteredDel MessageEntered

Event Type

Type	Description
MessageEnteredDel

MessageEnteredSender

Declaration

public event MessageEnteredSenderDel MessageEnteredSender

Event Type

Type	Description
MessageEnteredSenderDel

MessageRecieved

Declaration

public event Action<ulong, string> MessageRecieved

Event Type

Type	Description
System.Action<System.UInt64, System.String>

Explicit Interface Implementations

IMyGamePaths.ContentPath

Declaration

string IMyGamePaths.ContentPath { get; }

Returns

Type	Description
System.String

IMyGamePaths.ModScopeName

Declaration

string IMyGamePaths.ModScopeName { get; }

Returns

Type	Description
System.String

IMyGamePaths.ModsPath

Declaration

string IMyGamePaths.ModsPath { get; }

Returns

Type	Description
System.String

IMyGamePaths.SavesPath

Declaration

string IMyGamePaths.SavesPath { get; }

Returns

Type	Description
System.String

IMyGamePaths.UserDataPath

Declaration

string IMyGamePaths.UserDataPath { get; }

Returns

Type	Description
System.String

IMyUtilities.add_MessageEntered(MessageEnteredDel)

Declaration

void IMyUtilities.add_MessageEntered(MessageEnteredDel value)

Parameters

Type	Name	Description
MessageEnteredDel	value

IMyUtilities.ConfigDedicated

Declaration

IMyConfigDedicated IMyUtilities.ConfigDedicated { get; }

Returns

Type	Description
IMyConfigDedicated

IMyUtilities.CreateNotification(String, Int32, String)

Declaration

IMyHudNotification IMyUtilities.CreateNotification(string message, int disappearTimeMs, string font)

Parameters

Type	Name	Description
System.String	message
System.Int32	disappearTimeMs
System.String	font

Returns

Type	Description
IMyHudNotification

IMyUtilities.DeleteFileInGlobalStorage(String)

Declaration

void IMyUtilities.DeleteFileInGlobalStorage(string file)

Parameters

Type	Name	Description
System.String	file

IMyUtilities.DeleteFileInLocalStorage(String, Type)

Declaration

void IMyUtilities.DeleteFileInLocalStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

IMyUtilities.DeleteFileInWorldStorage(String, Type)

Declaration

void IMyUtilities.DeleteFileInWorldStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

IMyUtilities.FileExistsInGameContent(String)

Declaration

bool IMyUtilities.FileExistsInGameContent(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
System.Boolean

IMyUtilities.FileExistsInGlobalStorage(String)

Declaration

bool IMyUtilities.FileExistsInGlobalStorage(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
System.Boolean

IMyUtilities.FileExistsInLocalStorage(String, Type)

Declaration

bool IMyUtilities.FileExistsInLocalStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.Boolean

IMyUtilities.FileExistsInModLocation(String, MyObjectBuilder_Checkpoint.ModItem)

Declaration

bool IMyUtilities.FileExistsInModLocation(string file, MyObjectBuilder_Checkpoint.ModItem modItem)

Parameters

Type	Name	Description
System.String	file
MyObjectBuilder_Checkpoint.ModItem	modItem

Returns

Type	Description
System.Boolean

IMyUtilities.FileExistsInWorldStorage(String, Type)

Declaration

bool IMyUtilities.FileExistsInWorldStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.Boolean

IMyUtilities.GamePaths

Declaration

IMyGamePaths IMyUtilities.GamePaths { get; }

Returns

Type	Description
IMyGamePaths

IMyUtilities.GetObjectiveLine()

Declaration

IMyHudObjectiveLine IMyUtilities.GetObjectiveLine()

Returns

Type	Description
IMyHudObjectiveLine

IMyUtilities.GetTypeName(Type)

Declaration

string IMyUtilities.GetTypeName(Type type)

Parameters

Type	Name	Description
System.Type	type

Returns

Type	Description
System.String

IMyUtilities.GetVariable<T>(String, out T)

Declaration

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

Parameters

Type	Name	Description
System.String	name
T	value

Returns

Type	Description
System.Boolean

Type Parameters

Name	Description
T

IMyUtilities.InvokeOnGameThread(Action, String, Int32, Int32)

Declaration

void IMyUtilities.InvokeOnGameThread(Action action, string invokerName, int StartAt, int RepeatTimes)

Parameters

Type	Name	Description
System.Action	action
System.String	invokerName
System.Int32	StartAt
System.Int32	RepeatTimes

IMyUtilities.IsDedicated

Declaration

bool IMyUtilities.IsDedicated { get; }

Returns

Type	Description
System.Boolean

IMyUtilities.MessageRecieved

Declaration

event Action<ulong, string> IMyUtilities.MessageRecieved

Returns

Type	Description
System.Action<System.UInt64, System.String>

IMyUtilities.ReadBinaryFileInGameContent(String)

Declaration

BinaryReader IMyUtilities.ReadBinaryFileInGameContent(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
System.IO.BinaryReader

IMyUtilities.ReadBinaryFileInGlobalStorage(String)

Declaration

BinaryReader IMyUtilities.ReadBinaryFileInGlobalStorage(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
System.IO.BinaryReader

IMyUtilities.ReadBinaryFileInLocalStorage(String, Type)

Declaration

BinaryReader IMyUtilities.ReadBinaryFileInLocalStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.IO.BinaryReader

IMyUtilities.ReadBinaryFileInModLocation(String, MyObjectBuilder_Checkpoint.ModItem)

Declaration

BinaryReader IMyUtilities.ReadBinaryFileInModLocation(string file, MyObjectBuilder_Checkpoint.ModItem modItem)

Parameters

Type	Name	Description
System.String	file
MyObjectBuilder_Checkpoint.ModItem	modItem

Returns

Type	Description
System.IO.BinaryReader

IMyUtilities.ReadBinaryFileInWorldStorage(String, Type)

Declaration

BinaryReader IMyUtilities.ReadBinaryFileInWorldStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.IO.BinaryReader

IMyUtilities.ReadFileInGameContent(String)

Declaration

TextReader IMyUtilities.ReadFileInGameContent(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
System.IO.TextReader

IMyUtilities.ReadFileInGlobalStorage(String)

Declaration

TextReader IMyUtilities.ReadFileInGlobalStorage(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
System.IO.TextReader

IMyUtilities.ReadFileInLocalStorage(String, Type)

Declaration

TextReader IMyUtilities.ReadFileInLocalStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.IO.TextReader

IMyUtilities.ReadFileInModLocation(String, MyObjectBuilder_Checkpoint.ModItem)

Declaration

TextReader IMyUtilities.ReadFileInModLocation(string file, MyObjectBuilder_Checkpoint.ModItem modItem)

Parameters

Type	Name	Description
System.String	file
MyObjectBuilder_Checkpoint.ModItem	modItem

Returns

Type	Description
System.IO.TextReader

IMyUtilities.ReadFileInWorldStorage(String, Type)

Declaration

TextReader IMyUtilities.ReadFileInWorldStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.IO.TextReader

IMyUtilities.remove_MessageEntered(MessageEnteredDel)

Declaration

void IMyUtilities.remove_MessageEntered(MessageEnteredDel value)

Parameters

Type	Name	Description
MessageEnteredDel	value

IMyUtilities.RemoveVariable(String)

Declaration

bool IMyUtilities.RemoveVariable(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

IMyUtilities.SendMessage(String)

Declaration

void IMyUtilities.SendMessage(string messageText)

Parameters

Type	Name	Description
System.String	messageText

IMyUtilities.SerializeFromBinary<T>(Byte[])

Declaration

T IMyUtilities.SerializeFromBinary<T>(byte[] data)

Parameters

Type	Name	Description
System.Byte[]	data

Returns

Type	Description
T

Type Parameters

Name	Description
T

IMyUtilities.SerializeFromXML<T>(String)

Declaration

T IMyUtilities.SerializeFromXML<T>(string xml)

Parameters

Type	Name	Description
System.String	xml

Returns

Type	Description
T

Type Parameters

Name	Description
T

IMyUtilities.SerializeToBinary<T>(T)

Declaration

byte[] IMyUtilities.SerializeToBinary<T>(T obj)

Parameters

Type	Name	Description
T	obj

Returns

Type	Description
System.Byte[]

Type Parameters

Name	Description
T

IMyUtilities.SerializeToXML<T>(T)

Declaration

string IMyUtilities.SerializeToXML<T>(T objToSerialize)

Parameters

Type	Name	Description
T	objToSerialize

Returns

Type	Description
System.String

Type Parameters

Name	Description
T

IMyUtilities.SetVariable<T>(String, T)

Declaration

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

Parameters

Type	Name	Description
System.String	name
T	value

Type Parameters

Name	Description
T

IMyUtilities.ShowMessage(String, String)

Declaration

void IMyUtilities.ShowMessage(string sender, string messageText)

Parameters

Type	Name	Description
System.String	sender
System.String	messageText

IMyUtilities.ShowMissionScreen(String, String, String, String, Action<ResultEnum>, String)

Declaration

void IMyUtilities.ShowMissionScreen(string screenTitle, string currentObjectivePrefix, string currentObjective, string screenDescription, Action<ResultEnum> callback, string okButtonCaption)

Parameters

Type	Name	Description
System.String	screenTitle
System.String	currentObjectivePrefix
System.String	currentObjective
System.String	screenDescription
System.Action<ResultEnum>	callback
System.String	okButtonCaption

IMyUtilities.ShowNotification(String, Int32, String)

Declaration

void IMyUtilities.ShowNotification(string message, int disappearTimeMs, string font)

Parameters

Type	Name	Description
System.String	message
System.Int32	disappearTimeMs
System.String	font

IMyUtilities.WriteBinaryFileInGlobalStorage(String)

Declaration

BinaryWriter IMyUtilities.WriteBinaryFileInGlobalStorage(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
System.IO.BinaryWriter

IMyUtilities.WriteBinaryFileInLocalStorage(String, Type)

Declaration

BinaryWriter IMyUtilities.WriteBinaryFileInLocalStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.IO.BinaryWriter

IMyUtilities.WriteBinaryFileInWorldStorage(String, Type)

Declaration

BinaryWriter IMyUtilities.WriteBinaryFileInWorldStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.IO.BinaryWriter

IMyUtilities.WriteFileInGlobalStorage(String)

Declaration

TextWriter IMyUtilities.WriteFileInGlobalStorage(string file)

Parameters

Type	Name	Description
System.String	file

Returns

Type	Description
System.IO.TextWriter

IMyUtilities.WriteFileInLocalStorage(String, Type)

Declaration

TextWriter IMyUtilities.WriteFileInLocalStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.IO.TextWriter

IMyUtilities.WriteFileInWorldStorage(String, Type)

Declaration

TextWriter IMyUtilities.WriteFileInWorldStorage(string file, Type callingType)

Parameters

Type	Name	Description
System.String	file
System.Type	callingType

Returns

Type	Description
System.IO.TextWriter

Implements

IMyUtilities

IMyGamePaths