Package VRage.Game.ModAPI

Namespaces
package	Ingame
package	Interfaces

Classes
interface	IHitInfo
interface	IMyCharacter
interface	IMyConfig
interface	IMyConfigDedicated
interface	IMyControllerInfo
interface	IMyCubeBlock
	base block interface, block can be affected by upgrade modules, and you can retrieve upgrade list from IMyUpgradableBlock More...
interface	IMyCubeBuilder
interface	IMyCubeGrid
interface	IMyDamageSystem
interface	IMyEntityController
interface	IMyFaction
interface	IMyFactionCollection
interface	IMyFloatingObject
interface	IMyGamePaths
interface	IMyGps
interface	IMyGpsCollection
interface	IMyGui
interface	IMyHudNotification
interface	IMyHudObjectiveLine
interface	IMyIdentity
interface	IMyInventory
interface	IMyInventoryItem
interface	IMyMultiplayer
interface	IMyNetworkClient
interface	IMyParallelTask
interface	IMyPhysics
interface	IMyPlayer
interface	IMyPlayerCollection
interface	IMyPrefabManager
interface	IMySession
interface	IMySlimBlock
interface	IMyUtilities
interface	IMyVoxelMap
interface	IMyVoxelMaps
interface	IMyVoxelShape
interface	IMyVoxelShapeBox
interface	IMyVoxelShapeCapsule
interface	IMyVoxelShapeRamp
interface	IMyVoxelShapeSphere
struct	MyDamageInformation
	This structure contains all information about damage being done. More...
struct	MyHitInfo

Enumerations
enum	MyIntegrityChangeEnum {   MyIntegrityChangeEnum.Damage, MyIntegrityChangeEnum.ConstructionBegin, MyIntegrityChangeEnum.ConstructionEnd, MyIntegrityChangeEnum.ConstructionProcess,   MyIntegrityChangeEnum.Repair }
	Types of block integrity change that can occur More...
enum	MyDamageSystemPriority { MyDamageSystemPriority.Critical =100, MyDamageSystemPriority.Normal =500, MyDamageSystemPriority.Low =1000 }
	Standard priority values More...
enum	MyTerminalPageEnum {   MyTerminalPageEnum.None = -2, MyTerminalPageEnum.Properties = -1, MyTerminalPageEnum.Inventory = 0, MyTerminalPageEnum.ControlPanel = 1,   MyTerminalPageEnum.Production = 2, MyTerminalPageEnum.Info = 3, MyTerminalPageEnum.Factions = 4, MyTerminalPageEnum.Gps = 6 }
enum	SpawningOptions {   SpawningOptions.None = 0, SpawningOptions.RotateFirstCockpitTowardsDirection = 1 << 1, SpawningOptions.SpawnRandomCargo = 1 << 2, SpawningOptions.DisableDampeners = 1 << 3,   SpawningOptions.SetNeutralOwner = 1 << 4, SpawningOptions.TurnOffReactors = 1 << 5, SpawningOptions.DisableSave = 1 << 6, SpawningOptions.UseGridOrigin = 1 << 7 }
enum	MyPromoteLevel {   MyPromoteLevel.None = 0, MyPromoteLevel.Scripter, MyPromoteLevel.Moderator, MyPromoteLevel.SpaceMaster,   MyPromoteLevel.Admin, MyPromoteLevel.Owner }
	Describes what permissions a user has More...
enum	ResultEnum { ResultEnum.OK, ResultEnum.CANCEL }

Functions
delegate void	CharacterMovementStateDelegate (MyCharacterMovementEnum oldState, MyCharacterMovementEnum newState)
delegate void	BeforeDamageApplied (object target, ref MyDamageInformation info)
	This delegate is used to handle damage before it's applied to an object. This returns a modified damage that is used in DoDamage. Return damage if no change. More...
delegate void	MessageEnteredDel (string messageText, ref bool sendToOthers)

Enumeration Type Documentation

enum VRage.Game.ModAPI.MyDamageSystemPriority

Standard priority values

Enumerator
Critical
Normal
Low

Definition at line 18 of file IMyDamageSystem.cs.

enum VRage.Game.ModAPI.MyIntegrityChangeEnum

Types of block integrity change that can occur

Enumerator
Damage
ConstructionBegin
ConstructionEnd
ConstructionProcess
Repair

Definition at line 296 of file IMyCubeGrid.cs.

enum VRage.Game.ModAPI.MyPromoteLevel

Describes what permissions a user has

Enumerator
None	Normal players
Scripter	Can edit scripts when the scripter role is enabled
Moderator	Can kick and ban players, has access to 'Show All Players' option in Admin Tools menu
SpaceMaster	Has access to Space Master tools
Admin	Has access to Admin tools
Owner	Admins listed in server config, cannot be demoted

Definition at line 15 of file IMySession.cs.

enum VRage.Game.ModAPI.MyTerminalPageEnum

Enumerator
None
Properties
Inventory
ControlPanel
Production
Info
Factions
Gps

Definition at line 10 of file IMyGui.cs.

enum VRage.Game.ModAPI.ResultEnum

Enumerator
OK
CANCEL

Definition at line 6 of file IMyUtilities.cs.

enum VRage.Game.ModAPI.SpawningOptions

Enumerator
None
RotateFirstCockpitTowardsDirection
SpawnRandomCargo
DisableDampeners
SetNeutralOwner
TurnOffReactors
DisableSave
UseGridOrigin

Definition at line 10 of file IMyPrefabManager.cs.

Function Documentation

delegate void VRage.Game.ModAPI.BeforeDamageApplied	(	object	target,
		ref MyDamageInformation	info
	)

This delegate is used to handle damage before it's applied to an object. This returns a modified damage that is used in DoDamage. Return damage if no change.

Parameters

target	The object that is damaged
damage	Amount of damage being applied
damageType	Type of damage being applied
attackerId	The entity ID of the attacker

Returns

Modified damage. Return damage parameter if damage is not modified.

delegate void VRage.Game.ModAPI.CharacterMovementStateDelegate	(	MyCharacterMovementEnum	oldState,
		MyCharacterMovementEnum	newState
	)

delegate void VRage.Game.ModAPI.MessageEnteredDel	(	string	messageText,
		ref bool	sendToOthers
	)