Show / Hide Table of Contents

Namespace VRage.Game.ModAPI

Classes

BeforeDamageApplied

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.

CharacterMovementStateChangedDelegate

CharacterMovementStateDelegate

GridLinkTypeEnum

Defines different link types for grid groups.

MessageEnteredDel

MessageEnteredSenderDel

ModCrashedException

MyActivationCustomResults

Describes contract activation states (mods enum)

MyAddContractResultWrapper

Describes information about accepting contract result (mods struct)

MyAdminSettingsEnum

Describes administrator settings

MyAiBlockType

Defines block type for the AI blocks

MyCameraMode

Represents camera work mode

MyComponentStackInfo

MyContractActivateDelegate

Delegate used for contract activation.

MyContractChangeDelegate

Delegate used for various events related with contract state change.

MyContractConditionDelegate

Delegate used for contract condition finished.

MyContractFailedDelegate

Delegate used for event of contract failure.

MyContractFinishedDelegate

Delegate used for event triggered when contract is finished.

MyContractUpdateDelegate

Delegate used for custom update event.

MyCustomContractStateEnum

Describes contract state (mods enum)

MyDamageInformation

This structure contains all information about damage being done.

MyDamageSystemPriority

Standard priority values

MyDeviceBase

Implements base abstract class for device

MyFactionStateChange

MyGridGroupsDefaultEventHandler

Implements abstract base for grid group event handler

MyGunStatusEnum

When attempting to fire a gun, a status from this enum will be returned.

MyHitInfo

Implements Hit Info data

MyIntegrityChangeEnum

Types of block integrity change that can occur

MyLockEntityState

Represents camera locked entity

MyPromoteLevel

Describes what permissions a user has If you add items, always preserve order from lowest to highest permission

MyShootActionEnum

The type of fire action for a gun.

MyStoreItemData

Implements Store Item Data

MyTerminalPageEnum

MyUpdateTiersGridPresence

Describes tiers of grid presence (if any other grid is nearby)

MyUpdateTiersPlayerPresence

Describes tiers of player presence (if any player is nearby and grid is replicated to the client)

ReputationChangeReason

ResultEnum

ScriptingReflection

SpawningOptions

Interfaces

IHitInfo

IMyCharacter

Describes character (mods interface)

IMyComponentStack

Describes component stack of the block

IMyConfig

This interface provides access to game settings

IMyConfigDedicated

Describes dedicated server configuration (mods interface)

IMyContract

Describes contracts that player can take in contract block (mods interface)

IMyContractAcquisition

Describes acquisition contract that player can take in contract block (mods interface)

IMyContractBounty

Describes bounty contract that player can take in contract block (mods interface) Player should kill other player

IMyContractCustom

Describes custom contract (mods interface)

IMyContractEscort

Describes bounty contract that player can take in contract block (mods interface) Player should protect grid

IMyContractHauling

IMyContractRepair

Describes repair contract that player can take in contract block (mods interface) Player have to completely repair grid for getting reward

IMyContractSearch

Describes search contract that player can take in contract block (mods interface) Player have to completely repair grid for getting reward

IMyContractSystem

Describes contract system (mods interface)

IMyControllerInfo

Describes interface that provides information about current control state for controllable entities such as turret, cockpit, character ...

IMyCubeBlock

Describes base block interface (mod interface) Also known as fatblock

IMyCubeBuilder

Describes hand, than holding block (mods interface)

IMyCubeGrid

Declares grid interface. (mods interface) Grid - an entity that consist of IMySlimBlock. Blocks like rotor, piston, hinge, motor suspension, on their creation creates top part, that belongs to another grid. Player created ships, can consist of many grids.

IMyDamageSystem

Mod API interface allowing you handle damage events

IMyDLC

Contains information about a particular DLC package.

IMyDLCs

Describes API, that allows you get information about DLCs (mods interface)

IMyEntityController

Describes entity controller (mods interface) Allows to take controls

IMyFaction

Describes faction (mods interface)

IMyFactionCollection

IMyFloatingObject

Describes floating object (mods interface)

IMyGamePaths

ModAPI interface that, giving you information about most important game paths

IMyGps

Describes GPS (mods interface)

IMyGpsCollection

IMyGravityProviderSystem

Describes gravity ModAPI

IMyGridControlSystem

ModAPI interface giving access to grid-group control system

IMyGridGasSystem

ModAPI interface giving access to grid-group gas system

IMyGridGroupData

A class that presenting connection between grids WARNING: you must not keep link to instance or you have to remove link when event OnReleased is fired Use Get/SetVariable to store data in GridGroups. Variables are cleared after OnRelease is fired

IMyGridGroups

ModAPI interface giving access to grid-groups

IMyGridJumpDriveSystem

Interface for MyGridJumpDriveSystem in IMyCubeGrid

IMyGridWeaponSystem

ModAPI interface giving access to grid-group weapon system

IMyGui

ModAPI interface giving access to GUI

IMyGunObject<T>

This can be hand held weapon (including welders and drills) as well as weapons on ship (including ship drills).

IMyHudNotification

Describes interface of notification (mods interface)

IMyHudObjectiveLine

Describes interface of notification (mods interface)

IMyIdentity

Describes player or bot (mods interface)

IMyInventory

Describes inventory interface (PB scripting interface) You can cast if MyInventory for getting more functionality

IMyInventoryItem

Describes item stack in inventory (mod interface)

IMyModAPINaturalGravityComponent

Describes ModAPI any form natural gravity provider (any form, not only sphere)

IMyModAPINaturalGravityImplementation

Describes ModAPI implementation for natural gravity provider (any form, not only sphere)

IMyModContext

IMyModel

Describes 3D model (mods interface)

IMyModelDummy

IMyMultiplayer

ModAPI interface giving access to interaction between server and client

IMyNaturalGravityComponent

Describes natural gravity provider It may be IMySphericalNaturalGravityComponent or IMyModAPINaturalGravityImplementation

IMyNetworkClient

Represents network client (basically a computer) on the network.

IMyOxygenBlock

ModAPI describing block that can work with gas in airtight rooms (AirVent)

IMyOxygenProvider

ModAPI interface representing provider of oxygen

IMyOxygenProviderSystem

ModAPI interface allowing to get information about oxygen level and giving ability to register IMyOxygenProvider

IMyOxygenRoom

Represents space containing air vent. May be not airtight

IMyParallelTask

Mod API interface allowing you to run async tasks

IMyPhysics

Mod API interface giving you access to physics

IMyPlayer

IMyPlayerCollection

ModAPI interface giving control on players

IMyPrefabManager

ModAPI interface giving ability for modders to spawn prefabs

IMyReflection

ModAPI interface giving some reflection tools

IMyResourceDistributorComponent

ModAPI interface giving access to resource distributor

IMySession

ModAPI giving access to MySession functions and properties for modders

IMySlimBlock

Basic block interface (Mod api interface)

IMySpectatorTools

ModAPI interface giving access to spector control

IMySphericalNaturalGravityComponent

Describes spherical natural gravity provider

IMyStoreItem

IMyTriangleVertexIndices

Interface used to read the mesh

IMyUtilities

ModAPI interface giving access to utility functions

IMyVoxelMap

IMyVoxelMaps

IMyVoxelShape

Describes voxel shape for filling or excavating

IMyVoxelShapeBox

Describes box voxel shape for filling or excavating

IMyVoxelShapeCapsule

Describes capsule voxel shape for filling or excavating

IMyVoxelShapeRamp

Describes ramp voxel shape for filling or excavating

IMyVoxelShapeSphere

Describes sphere voxel shape for filling or excavating

IMyWeatherEffects

☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾