Space Engineers
|
Reference counting component for entities. More...
Public Member Functions | |
void | Ref () |
Increase the reference count of this entity. More... | |
bool | Unref () |
Decrease the entitie's reference count. More... | |
Public Member Functions inherited from VRage.Game.Components.MyEntityComponentBase | |
override void | OnAddedToContainer () |
Gets called after the container of this component changes More... | |
override void | OnBeforeRemovedFromContainer () |
Gets called before the removal of this component from a container More... | |
Public Member Functions inherited from VRage.Game.Components.MyComponentBase | |
virtual void | SetContainer (MyComponentContainer container) |
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. More... | |
virtual T | GetAs< T > () |
virtual void | OnAddedToScene () |
CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already! More... | |
virtual void | OnRemovedFromScene () |
CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene! More... | |
virtual MyObjectBuilder_ComponentBase | Serialize (bool copy=false) |
virtual void | Deserialize (MyObjectBuilder_ComponentBase builder) |
virtual void | Init (MyComponentDefinitionBase definition) |
virtual bool | IsSerialized () |
Tells the component container serializer whether this component should be saved More... | |
Properties | |
override string | ComponentTypeDebugString [get] |
Properties inherited from VRage.Game.Components.MyEntityComponentBase | |
MyEntityComponentContainer | Container [get] |
IMyEntity | Entity [get] |
abstract string | ComponentTypeDebugString [get] |
Name of the base component type for debug purposes (e.g.: "Position") More... | |
Properties inherited from VRage.Game.Components.MyComponentBase | |
MyComponentContainer | ContainerBase [get] |
This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase. More... | |
Additional Inherited Members | |
Events inherited from VRage.Game.Components.MyEntityComponentBase | |
static Action< MyEntityComponentBase > | OnAfterAddedToContainer |
Action< MyEntityComponentBase > | BeforeRemovedFromContainer |
Reference counting component for entities.
Allows simplified management of short lived entities that may be shared amongst systems.
The count is initially 0 so the first referencee becomes the owner of the entity (this is sometimes called a floating reference).
Definition at line 20 of file MyEntityReferenceComponent.cs.
|
inline |
Increase the reference count of this entity.
Definition at line 32 of file MyEntityReferenceComponent.cs.
|
inline |
Decrease the entitie's reference count.
Definition at line 41 of file MyEntityReferenceComponent.cs.
|
get |
Definition at line 25 of file MyEntityReferenceComponent.cs.