Sandbox.Game.EntityComponents

MyIngameScriptComponent

Assembly: Sandbox.Game.dll

public class MyIngameScriptComponent: MyGameLogicComponent, IMyComponentBase, IMyEntityComponentBase, IMyGameLogicComponent

A component to control the execution of a programmable block script based on its configured update frequency.

Events

Member Description
static OnAfterAddedToContainer Inherited from MyEntityComponentBase
BeforeRemovedFromContainer Inherited from IMyEntityComponentBase
BeforeRemovedFromContainer Inherited from MyEntityComponentBase

Properties

Member Description
UpdateFrequency The update frequency with which to run the script.
AttachSyncToEntity Inherited from MyEntityComponentBase
Closed Inherited from MyGameLogicComponent
ComponentTypeDebugString Inherited from IMyEntityComponentBase
ComponentTypeDebugString Inherited from MyGameLogicComponent
ComponentTypeDebugString Name of the base component type for debug purposes (e.g.: "Position")

Inherited from MyEntityComponentBase
Container Inherited from IMyEntityComponentBase
Container Inherited from MyEntityComponentBase
ContainerBase Inherited from IMyComponentBase
ContainerBase This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase.

Inherited from MyComponentBase
Entity Inherited from IMyEntityComponentBase
Entity Inherited from MyEntityComponentBase
EntityUpdate Inherited from MyGameLogicComponent
FailedOnSceneAdd Inherited from MyComponentBase
MarkedForClose Inherited from MyGameLogicComponent
ModContext Returns the mod context this gamelogic belongs to. This can be passed to methods to read content from the mod's directory.

Inherited from MyGameLogicComponent
NeedsUpdate Inherited from MyGameLogicComponent
RemoveExistingComponentOnNewInsert Inherited from IMyComponentBase
RemoveExistingComponentOnNewInsert Inherited from MyComponentBase

Constructors

Member Description
MyIngameScriptComponent()

Methods

Member Description
Init(MyObjectBuilder_EntityBase)
UpdateAfterSimulation()
UpdateBeforeSimulation()
UpdateBeforeSimulation10()
UpdateBeforeSimulation100()
Close() Inherited from MyGameLogicComponent
Deserialize(MyObjectBuilder_ComponentBase) Inherited from IMyComponentBase
Deserialize(MyObjectBuilder_ComponentBase) Inherited from MyComponentBase
GetAs() Inherited from IMyComponentBase
GetAs() Inherited from MyComponentBase
GetObjectBuilder(bool) Inherited from MyGameLogicComponent
Init(MyComponentDefinitionBase) Inherited from IMyComponentBase
Init(MyObjectBuilder_EntityBase) Inherited from MyGameLogicComponent
Init(MyComponentDefinitionBase) Inherited from MyComponentBase
IsSerialized() Inherited from IMyComponentBase
IsSerialized() Tells the component container serializer whether this component should be saved

Inherited from MyComponentBase
MarkForClose() Inherited from MyGameLogicComponent
OnAddedToContainer() Inherited from IMyComponentBase
OnAddedToContainer() Inherited from MyEntityComponentBase
OnAddedToContainer() Gets called after the container of this component changes

Inherited from MyComponentBase
OnAddedToScene() Inherited from IMyComponentBase
OnAddedToScene() CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already!

Inherited from MyComponentBase
OnBeforeRemovedFromContainer() Inherited from IMyComponentBase
OnBeforeRemovedFromContainer() Inherited from MyEntityComponentBase
OnBeforeRemovedFromContainer() Gets called before the removal of this component from a container

Inherited from MyComponentBase
OnRemovedFromScene() Inherited from IMyComponentBase
OnRemovedFromScene() CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene!

Inherited from MyComponentBase
Serialize(bool) Inherited from IMyComponentBase
Serialize(bool) Inherited from MyComponentBase
SetContainer(IMyComponentContainer) Inherited from IMyComponentBase
SetContainer(IMyComponentContainer) Sets the container of this component. Note that the component is not added to the container here! Therefore, use MyComponentContainer.Add(...) method and it will in turn call this method. Actually, you should seldom have the need to call this method yourself.

Inherited from MyComponentBase
UpdateAfterSimulation() Inherited from MyGameLogicComponent
UpdateAfterSimulation10() Inherited from MyGameLogicComponent
UpdateAfterSimulation100() Inherited from MyGameLogicComponent
UpdateBeforeSimulation() Inherited from MyGameLogicComponent
UpdateBeforeSimulation10() Inherited from MyGameLogicComponent
UpdateBeforeSimulation100() Inherited from MyGameLogicComponent
UpdateOnceBeforeFrame() Inherited from MyGameLogicComponent
UpdatingStopped() Inherited from MyGameLogicComponent

Inheritance: MyComponentBase ˃ MyEntityComponentBase ˃ MyGameLogicComponent

Implements: