Sandbox.Game.Components.MyEntityStatComponent Class Reference

Inheritance diagram for Sandbox.Game.Components.MyEntityStatComponent:

Public Member Functions
void	RequestStatChange (MyEntityStat stat)
	MyEntityStatComponent ()
override MyObjectBuilder_ComponentBase	Serialize (bool copy=false)
override void	Deserialize (MyObjectBuilder_ComponentBase objectBuilder)
override bool	IsSerialized ()
	Tells the component container serializer whether this component should be saved More...
override void	Init (MyComponentDefinitionBase definition)
virtual void	Update ()
bool	TryGetStat (MyStringHash statId, out MyEntityStat outStat)
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...
bool	CanDoAction (string actionId, out MyTuple< ushort, MyStringHash > message, bool continuous=false)
bool	DoAction (string actionId)
void	ApplyModifier (string modifierId)
float	GetEfficiencyModifier (string modifierId)
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...

Protected Attributes
List< MyStatLogic >	m_scripts

Properties
DictionaryValuesReader< MyStringHash, MyEntityStat >	Stats [get]
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

Detailed Description

Definition at line 30 of file MyEntityStatComponent.cs.

Constructor & Destructor Documentation

Sandbox.Game.Components.MyEntityStatComponent.MyEntityStatComponent ( )

inline

Definition at line 168 of file MyEntityStatComponent.cs.

Member Function Documentation

void Sandbox.Game.Components.MyEntityStatComponent.ApplyModifier ( string  modifierId )

inline

Definition at line 404 of file MyEntityStatComponent.cs.

bool Sandbox.Game.Components.MyEntityStatComponent.CanDoAction ( string  actionId, out MyTuple< ushort, MyStringHash >  message, bool  continuous = false  )

inline

Definition at line 374 of file MyEntityStatComponent.cs.

override void Sandbox.Game.Components.MyEntityStatComponent.Deserialize ( MyObjectBuilder_ComponentBase  objectBuilder )

inlinevirtual

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 210 of file MyEntityStatComponent.cs.

bool Sandbox.Game.Components.MyEntityStatComponent.DoAction ( string  actionId )

inline

Definition at line 393 of file MyEntityStatComponent.cs.

float Sandbox.Game.Components.MyEntityStatComponent.GetEfficiencyModifier ( string  modifierId )

inline

Definition at line 412 of file MyEntityStatComponent.cs.

override void Sandbox.Game.Components.MyEntityStatComponent.Init ( MyComponentDefinitionBase  definition )

inlinevirtual

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 259 of file MyEntityStatComponent.cs.

override bool Sandbox.Game.Components.MyEntityStatComponent.IsSerialized ( )

inlinevirtual

Tells the component container serializer whether this component should be saved

Returns

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 252 of file MyEntityStatComponent.cs.

override void Sandbox.Game.Components.MyEntityStatComponent.OnAddedToContainer ( )

inlinevirtual

Gets called after the container of this component changes

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 354 of file MyEntityStatComponent.cs.

override void Sandbox.Game.Components.MyEntityStatComponent.OnBeforeRemovedFromContainer ( )

inlinevirtual

Gets called before the removal of this component from a container

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 364 of file MyEntityStatComponent.cs.

void Sandbox.Game.Components.MyEntityStatComponent.RequestStatChange ( MyEntityStat  stat )

inline

Definition at line 41 of file MyEntityStatComponent.cs.

override MyObjectBuilder_ComponentBase Sandbox.Game.Components.MyEntityStatComponent.Serialize ( bool  copy = false )

inlinevirtual

Reimplemented from VRage.Game.Components.MyComponentBase.

Definition at line 176 of file MyEntityStatComponent.cs.

bool Sandbox.Game.Components.MyEntityStatComponent.TryGetStat ( MyStringHash  statId, out MyEntityStat  outStat  )

inline

Definition at line 349 of file MyEntityStatComponent.cs.

virtual void Sandbox.Game.Components.MyEntityStatComponent.Update ( )

inlinevirtual

Reimplemented in Sandbox.Game.Components.MyCharacterStatComponent.

Definition at line 310 of file MyEntityStatComponent.cs.

Member Data Documentation

List<MyStatLogic> Sandbox.Game.Components.MyEntityStatComponent.m_scripts

protected

Definition at line 162 of file MyEntityStatComponent.cs.

Property Documentation

override string Sandbox.Game.Components.MyEntityStatComponent.ComponentTypeDebugString

get

Definition at line 463 of file MyEntityStatComponent.cs.

DictionaryValuesReader<MyStringHash, MyEntityStat> Sandbox.Game.Components.MyEntityStatComponent.Stats

get

Definition at line 160 of file MyEntityStatComponent.cs.

---

The documentation for this class was generated from the following file:

• Sources/Sandbox.Game/Game/EntityComponents/MyEntityStatComponent.cs