Inheritance diagram for VRage.Game.ModAPI.IMySession:

Public Member Functions
void	BeforeStartComponents ()

void	Draw ()

void	GameOver ()

void	GameOver (MyStringId?customMessage)

MyObjectBuilder_Checkpoint	GetCheckpoint (string saveName)

MyObjectBuilder_Sector	GetSector ()

System.Collections.Generic.Dictionary< string, byte[]>	GetVoxelMapsArray ()

MyObjectBuilder_World	GetWorld ()

bool	IsPausable ()

void	RegisterComponent (VRage.Game.Components.MySessionComponentBase component, VRage.Game.Components.MyUpdateOrder updateOrder, int priority)

bool	Save (string customSaveName=null)

void	SetAsNotReady ()

void	Unload ()

void	UnloadDataComponents ()

void	UnloadMultiplayer ()

void	UnregisterComponent (VRage.Game.Components.MySessionComponentBase component)

void	Update (MyTimeSpan time)

void	UpdateComponents ()

MyPromoteLevel	GetUserPromoteLevel (ulong steamId)
	Gets a remote player's promote level. More...

bool	IsUserAdmin (ulong steamId)
	Checks if a given player is an admin (or higher). More...

bool	IsUserPromoted (ulong steamId)

void	SetComponentUpdateOrder (MySessionComponentBase component, MyUpdateOrder order)
	Change the update order of a session component. More...

Properties
float	AssemblerEfficiencyMultiplier `[get]`

float	AssemblerSpeedMultiplier `[get]`

bool	AutoHealing `[get]`

uint	AutoSaveInMinutes `[get]`

IMyCameraController	CameraController `[get]`

bool	CargoShipsEnabled `[get]`

bool	ClientCanSave `[get]`

bool	CreativeMode `[get]`

string	CurrentPath `[get]`

string	Description `[get, set]`

IMyCamera	Camera `[get]`

IMyPlayer	LocalHumanPlayer `[get]`

IMyConfig	Config `[get]`
	Obtaining values from config is slow and can allocate memory! Do it only when necessary. More...

TimeSpan	ElapsedPlayTime `[get]`

bool	EnableCopyPaste `[get]`

MyEnvironmentHostilityEnum	EnvironmentHostility `[get]`

DateTime	GameDateTime `[get, set]`

float	GrinderSpeedMultiplier `[get]`

float	HackSpeedMultiplier `[get]`

float	InventoryMultiplier `[get]`

bool	IsCameraAwaitingEntity `[get, set]`

List< MyObjectBuilder_Checkpoint.ModItem >	Mods `[get, set]`

bool	IsServer `[get]`

short	MaxFloatingObjects `[get]`

short	MaxBackupSaves `[get]`

short	MaxPlayers `[get]`

bool	MultiplayerAlive `[get, set]`

bool	MultiplayerDirect `[get, set]`

double	MultiplayerLastMsg `[get, set]`

string	Name `[get, set]`

float	NegativeIntegrityTotal `[get, set]`

MyOnlineModeEnum	OnlineMode `[get]`

string	Password `[get, set]`

float	PositiveIntegrityTotal `[get, set]`

float	RefinerySpeedMultiplier `[get]`

bool	ShowPlayerNamesOnHud `[get]`

bool	SurvivalMode `[get]`

bool	ThrusterDamage `[get]`

string	ThumbPath `[get]`

TimeSpan	TimeOnBigShip `[get]`

TimeSpan	TimeOnFoot `[get]`

TimeSpan	TimeOnJetpack `[get]`

TimeSpan	TimeOnSmallShip `[get]`

bool	WeaponsEnabled `[get]`

float	WelderSpeedMultiplier `[get]`

ulong	WorkshopId `[get]`

IMyVoxelMaps	VoxelMaps `[get]`

IMyPlayer	Player `[get]`

IMyControllableEntity	ControlledObject `[get]`

MyObjectBuilder_SessionSettings	SessionSettings `[get]`

IMyFactionCollection	Factions `[get]`

IMyDamageSystem	DamageSystem `[get]`

IMyGpsCollection	GPS `[get]`

BoundingBoxD	WorldBoundaries `[get]`

MyPromoteLevel	PromoteLevel `[get]`
	Gets the local player's promote level. More...

bool	HasCreativeRights `[get]`
	Checks if the local player is an admin or is promoted to space master (or higher). More...

bool	HasAdminPrivileges `[get]`

Events
Action	OnSessionReady

Action	OnSessionLoading

Detailed Description

Definition at line 44 of file IMySession.cs.

Member Function Documentation

void VRage.Game.ModAPI.IMySession.BeforeStartComponents ( )

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.Draw ( )

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.GameOver ( )

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.GameOver ( MyStringId? customMessage )

Implemented in Sandbox.Game.World.MySession.

MyObjectBuilder_Checkpoint VRage.Game.ModAPI.IMySession.GetCheckpoint ( string saveName )

Implemented in Sandbox.Game.World.MySession.

MyObjectBuilder_Sector VRage.Game.ModAPI.IMySession.GetSector ( )

MyPromoteLevel VRage.Game.ModAPI.IMySession.GetUserPromoteLevel ( ulong steamId )

Gets a remote player's promote level.

Parameters

steamId

Returns

Implemented in Sandbox.Game.World.MySession.

System.Collections.Generic.Dictionary<string, byte[]> VRage.Game.ModAPI.IMySession.GetVoxelMapsArray ( )

MyObjectBuilder_World VRage.Game.ModAPI.IMySession.GetWorld ( )

bool VRage.Game.ModAPI.IMySession.IsPausable ( )

Implemented in Sandbox.Game.World.MySession.

bool VRage.Game.ModAPI.IMySession.IsUserAdmin ( ulong steamId )

Checks if a given player is an admin (or higher).

Parameters

steamId

Returns

Implemented in Sandbox.Game.World.MySession.

bool VRage.Game.ModAPI.IMySession.IsUserPromoted ( ulong steamId )

void VRage.Game.ModAPI.IMySession.RegisterComponent	(	VRage.Game.Components.MySessionComponentBase	component,
		VRage.Game.Components.MyUpdateOrder	updateOrder,
		int	priority
	)

bool VRage.Game.ModAPI.IMySession.Save ( string customSaveName = null )

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.SetAsNotReady ( )

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.SetComponentUpdateOrder	(	MySessionComponentBase	component,
		MyUpdateOrder	order
	)

Change the update order of a session component.

There is a proxy for this method in the session component itself.

Parameters

component	The component to set the update order for
order	The update order

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.Unload ( )

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.UnloadDataComponents ( )

void VRage.Game.ModAPI.IMySession.UnloadMultiplayer ( )

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.UnregisterComponent ( VRage.Game.Components.MySessionComponentBase component )

void VRage.Game.ModAPI.IMySession.Update ( MyTimeSpan time )

Implemented in Sandbox.Game.World.MySession.

void VRage.Game.ModAPI.IMySession.UpdateComponents ( )

Implemented in Sandbox.Game.World.MySession.

Property Documentation

float VRage.Game.ModAPI.IMySession.AssemblerEfficiencyMultiplier

get

Definition at line 46 of file IMySession.cs.

float VRage.Game.ModAPI.IMySession.AssemblerSpeedMultiplier

get

Definition at line 47 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.AutoHealing

get

Definition at line 48 of file IMySession.cs.

uint VRage.Game.ModAPI.IMySession.AutoSaveInMinutes

get

Definition at line 49 of file IMySession.cs.

IMyCamera VRage.Game.ModAPI.IMySession.Camera

get

Definition at line 59 of file IMySession.cs.

IMyCameraController VRage.Game.ModAPI.IMySession.CameraController

get

Definition at line 52 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.CargoShipsEnabled

get

Definition at line 53 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.ClientCanSave

get

Definition at line 55 of file IMySession.cs.

IMyConfig VRage.Game.ModAPI.IMySession.Config

get

Obtaining values from config is slow and can allocate memory! Do it only when necessary.

Definition at line 66 of file IMySession.cs.

IMyControllableEntity VRage.Game.ModAPI.IMySession.ControlledObject

get

Definition at line 124 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.CreativeMode

get

Definition at line 56 of file IMySession.cs.

string VRage.Game.ModAPI.IMySession.CurrentPath

get

Definition at line 57 of file IMySession.cs.

IMyDamageSystem VRage.Game.ModAPI.IMySession.DamageSystem

get

Definition at line 127 of file IMySession.cs.

string VRage.Game.ModAPI.IMySession.Description

getset

Definition at line 58 of file IMySession.cs.

TimeSpan VRage.Game.ModAPI.IMySession.ElapsedPlayTime

get

Definition at line 68 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.EnableCopyPaste

get

Definition at line 69 of file IMySession.cs.

MyEnvironmentHostilityEnum VRage.Game.ModAPI.IMySession.EnvironmentHostility

get

Definition at line 70 of file IMySession.cs.

IMyFactionCollection VRage.Game.ModAPI.IMySession.Factions

get

Definition at line 126 of file IMySession.cs.

DateTime VRage.Game.ModAPI.IMySession.GameDateTime

getset

Definition at line 71 of file IMySession.cs.

IMyGpsCollection VRage.Game.ModAPI.IMySession.GPS

get

Definition at line 128 of file IMySession.cs.

float VRage.Game.ModAPI.IMySession.GrinderSpeedMultiplier

get

Definition at line 78 of file IMySession.cs.

float VRage.Game.ModAPI.IMySession.HackSpeedMultiplier

get

Definition at line 79 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.HasAdminPrivileges

get

Definition at line 161 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.HasCreativeRights

get

Checks if the local player is an admin or is promoted to space master (or higher).

Definition at line 148 of file IMySession.cs.

float VRage.Game.ModAPI.IMySession.InventoryMultiplier

get

Definition at line 80 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.IsCameraAwaitingEntity

getset

Definition at line 81 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.IsServer

get

Definition at line 84 of file IMySession.cs.

IMyPlayer VRage.Game.ModAPI.IMySession.LocalHumanPlayer

get

Definition at line 60 of file IMySession.cs.

short VRage.Game.ModAPI.IMySession.MaxBackupSaves

get

Definition at line 87 of file IMySession.cs.

short VRage.Game.ModAPI.IMySession.MaxFloatingObjects

get

Definition at line 86 of file IMySession.cs.

short VRage.Game.ModAPI.IMySession.MaxPlayers

get

Definition at line 88 of file IMySession.cs.

List<MyObjectBuilder_Checkpoint.ModItem> VRage.Game.ModAPI.IMySession.Mods

getset

Definition at line 82 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.MultiplayerAlive

getset

Definition at line 89 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.MultiplayerDirect

getset

Definition at line 90 of file IMySession.cs.

double VRage.Game.ModAPI.IMySession.MultiplayerLastMsg

getset

Definition at line 91 of file IMySession.cs.

string VRage.Game.ModAPI.IMySession.Name

getset

Definition at line 92 of file IMySession.cs.

float VRage.Game.ModAPI.IMySession.NegativeIntegrityTotal

getset

Definition at line 93 of file IMySession.cs.

MyOnlineModeEnum VRage.Game.ModAPI.IMySession.OnlineMode

get

Definition at line 94 of file IMySession.cs.

string VRage.Game.ModAPI.IMySession.Password

getset

Definition at line 95 of file IMySession.cs.

IMyPlayer VRage.Game.ModAPI.IMySession.Player

get

Definition at line 123 of file IMySession.cs.

float VRage.Game.ModAPI.IMySession.PositiveIntegrityTotal

getset

Definition at line 96 of file IMySession.cs.

MyPromoteLevel VRage.Game.ModAPI.IMySession.PromoteLevel

get

Gets the local player's promote level.

Definition at line 136 of file IMySession.cs.

float VRage.Game.ModAPI.IMySession.RefinerySpeedMultiplier

get

Definition at line 97 of file IMySession.cs.

MyObjectBuilder_SessionSettings VRage.Game.ModAPI.IMySession.SessionSettings

get

Definition at line 125 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.ShowPlayerNamesOnHud

get

Definition at line 103 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.SurvivalMode

get

Definition at line 105 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.ThrusterDamage

get

Definition at line 107 of file IMySession.cs.

string VRage.Game.ModAPI.IMySession.ThumbPath

get

Definition at line 108 of file IMySession.cs.

TimeSpan VRage.Game.ModAPI.IMySession.TimeOnBigShip

get

Definition at line 109 of file IMySession.cs.

TimeSpan VRage.Game.ModAPI.IMySession.TimeOnFoot

get

Definition at line 110 of file IMySession.cs.

TimeSpan VRage.Game.ModAPI.IMySession.TimeOnJetpack

get

Definition at line 111 of file IMySession.cs.

TimeSpan VRage.Game.ModAPI.IMySession.TimeOnSmallShip

get

Definition at line 112 of file IMySession.cs.

IMyVoxelMaps VRage.Game.ModAPI.IMySession.VoxelMaps

get

Definition at line 122 of file IMySession.cs.

bool VRage.Game.ModAPI.IMySession.WeaponsEnabled

get

Definition at line 119 of file IMySession.cs.

float VRage.Game.ModAPI.IMySession.WelderSpeedMultiplier

get

Definition at line 120 of file IMySession.cs.

ulong VRage.Game.ModAPI.IMySession.WorkshopId

get

Definition at line 121 of file IMySession.cs.

BoundingBoxD VRage.Game.ModAPI.IMySession.WorldBoundaries

get

Definition at line 131 of file IMySession.cs.

Event Documentation

Action VRage.Game.ModAPI.IMySession.OnSessionLoading

Definition at line 130 of file IMySession.cs.

Action VRage.Game.ModAPI.IMySession.OnSessionReady

Definition at line 129 of file IMySession.cs.

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

Sources/VRage.Game/ModAPI/IMySession.cs

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation