Class MyEntityContainerEventExtensions
TODO: This should change in future. Cestmir should already know how to change this to some kind of dispatcher that will inform components Until then, this is now used to inform MyEntityDurabilityComponent if present in the container about changes
Inheritance
Namespace: VRage.Game.Components
Assembly: Sandbox.Game.dll
Syntax
public static class MyEntityContainerEventExtensions : ObjectMethods
InitEntityEvents()
Declaration
public static void InitEntityEvents()RaiseEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)
Call this to raise event on entity, that will be processed by registered components
Declaration
public static void RaiseEntityEvent(this MyEntityComponentBase component, MyStringHash eventType, MyEntityContainerEventExtensions.EntityEventParams eventParams)Parameters
| Type | Name | Description |
|---|---|---|
| MyEntityComponentBase | component | component upon which container this is going to be invoke |
| MyStringHash | eventType | type of event |
| MyEntityContainerEventExtensions.EntityEventParams | eventParams | event params or derived type |
RaiseEntityEvent(MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)
Call this to raise event on entity, that will be processed by registered components
Declaration
public static void RaiseEntityEvent(this MyEntity entity, MyStringHash eventType, MyEntityContainerEventExtensions.EntityEventParams eventParams)Parameters
| Type | Name | Description |
|---|---|---|
| MyEntity | entity | this is entity on which is this being invoked |
| MyStringHash | eventType | type of event |
| MyEntityContainerEventExtensions.EntityEventParams | eventParams | event params or derived type |
RaiseEntityEventOn(MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)
Call this to raise event on entity, that will be processed by registered components
Declaration
public static void RaiseEntityEventOn(MyEntity entity, MyStringHash eventType, MyEntityContainerEventExtensions.EntityEventParams eventParams)Parameters
| Type | Name | Description |
|---|---|---|
| MyEntity | entity | this is entity on which is this being invoked |
| MyStringHash | eventType | type of event |
| MyEntityContainerEventExtensions.EntityEventParams | eventParams | event params or derived type |
RegisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
This will register the component to listen to some events on entity that is other than entity containing this component
Declaration
public static void RegisterForEntityEvent(this MyEntityComponentBase component, MyEntity entity, MyStringHash eventType, MyEntityContainerEventExtensions.EntityEventHandler handler)Parameters
| Type | Name | Description |
|---|---|---|
| MyEntityComponentBase | component | Component that is being registered |
| MyEntity | entity | Entity on which we listen to events |
| MyStringHash | eventType | type of event |
| MyEntityContainerEventExtensions.EntityEventHandler | handler | handler to be called |
RegisterForEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)
This will register the component to listen to some events..
Declaration
public static void RegisterForEntityEvent(this MyEntityComponentBase component, MyStringHash eventType, MyEntityContainerEventExtensions.EntityEventHandler handler)Parameters
| Type | Name | Description |
|---|---|---|
| MyEntityComponentBase | component | Component that is being registered |
| MyStringHash | eventType | type of event |
| MyEntityContainerEventExtensions.EntityEventHandler | handler | handler to be called |
SkipProcessingEvents(Boolean)
Declaration
public static void SkipProcessingEvents(bool state)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | state |
UnregisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash)
This will unregister the component to listen to some events on entity that is other than entity containing this component
Declaration
public static void UnregisterForEntityEvent(this MyEntityComponentBase component, MyEntity entity, MyStringHash eventType)Parameters
| Type | Name | Description |
|---|---|---|
| MyEntityComponentBase | component | Component that is being registered |
| MyEntity | entity | Entity on which we listen to events |
| MyStringHash | eventType | type of event |