Show / Hide Table of Contents

Class MyIngameScriptComponent

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

Inheritance
System.Object
MyComponentBase
MyEntityComponentBase
MyGameLogicComponent
MyIngameScriptComponent
Inherited Members
MyGameLogicComponent.UpdateOnceBeforeFrame()
MyGameLogicComponent.UpdateAfterSimulation10()
MyGameLogicComponent.UpdateAfterSimulation100()
MyGameLogicComponent.UpdatingStopped()
MyGameLogicComponent.GetObjectBuilder(Boolean)
MyGameLogicComponent.MarkForClose()
MyGameLogicComponent.Close()
MyGameLogicComponent.EntityUpdate
MyGameLogicComponent.NeedsUpdate
MyGameLogicComponent.Closed
MyGameLogicComponent.MarkedForClose
MyGameLogicComponent.ComponentTypeDebugString
MyGameLogicComponent.ModContext
MyEntityComponentBase.OnAddedToContainer()
MyEntityComponentBase.OnBeforeRemovedFromContainer()
MyEntityComponentBase.Container
MyEntityComponentBase.Entity
MyEntityComponentBase.AttachSyncToEntity
MyEntityComponentBase.OnAfterAddedToContainer
MyEntityComponentBase.BeforeRemovedFromContainer
MyComponentBase.SetContainer(IMyComponentContainer)
MyComponentBase.GetAs<T>()
MyComponentBase.OnAddedToScene()
MyComponentBase.OnRemovedFromScene()
MyComponentBase.Serialize(Boolean)
MyComponentBase.Deserialize(MyObjectBuilder_ComponentBase)
MyComponentBase.Init(MyComponentDefinitionBase)
MyComponentBase.IsSerialized()
MyComponentBase.RemoveExistingComponentOnNewInsert
MyComponentBase.ContainerBase
Namespace: Sandbox.Game.EntityComponents
Assembly: Sandbox.Game.dll
Syntax
[MyEntityComponentDescriptor]
public class MyIngameScriptComponent : MyGameLogicComponent, IMyEntityComponentBase, IMyComponentBase, IMyGameLogicComponent

Constructors

MyIngameScriptComponent()

Declaration
public MyIngameScriptComponent()

Properties

UpdateFrequency

The update frequency with which to run the script.

Declaration
public UpdateFrequency UpdateFrequency { get; set; }
Property Value
Type Description
UpdateFrequency

Methods

Init(MyObjectBuilder_EntityBase)

Declaration
public override void Init(MyObjectBuilder_EntityBase objectBuilder)
Parameters
Type Name Description
MyObjectBuilder_EntityBase objectBuilder
Overrides
MyGameLogicComponent.Init(MyObjectBuilder_EntityBase)

UpdateAfterSimulation()

Declaration
public override void UpdateAfterSimulation()
Overrides
MyGameLogicComponent.UpdateAfterSimulation()

UpdateBeforeSimulation()

Declaration
public override void UpdateBeforeSimulation()
Overrides
MyGameLogicComponent.UpdateBeforeSimulation()

UpdateBeforeSimulation10()

Declaration
public override void UpdateBeforeSimulation10()
Overrides
MyGameLogicComponent.UpdateBeforeSimulation10()

UpdateBeforeSimulation100()

Declaration
public override void UpdateBeforeSimulation100()
Overrides
MyGameLogicComponent.UpdateBeforeSimulation100()

Extension Methods

MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
MyEntityContainerEventExtensions.UnregisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash)
MyEntityContainerEventExtensions.RaiseEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾