Click or drag to resize
MyEntityStatAddEffect Method (Single, Single, Single, Single, Single)

[This is preliminary documentation and is subject to change.]

[Missing <summary> documentation for "M:Sandbox.Game.Entities.MyEntityStat.AddEffect(System.Single,System.Single,System.Single,System.Single,System.Single)"]

Namespace: Sandbox.Game.Entities
Assembly: Sandbox.Game (in Sandbox.Game.dll) Version: 0.1.5991.32293
Syntax
C#
Copy
public int AddEffect(
	float amount,
	float interval,
	float duration = -1f,
	float minRegenRatio = 0f,
	float maxRegenRatio = 1f
)

Parameters

amount
Type: SystemSingle

[Missing <param name="amount"/> documentation for "M:Sandbox.Game.Entities.MyEntityStat.AddEffect(System.Single,System.Single,System.Single,System.Single,System.Single)"]

interval
Type: SystemSingle

[Missing <param name="interval"/> documentation for "M:Sandbox.Game.Entities.MyEntityStat.AddEffect(System.Single,System.Single,System.Single,System.Single,System.Single)"]

duration (Optional)
Type: SystemSingle

[Missing <param name="duration"/> documentation for "M:Sandbox.Game.Entities.MyEntityStat.AddEffect(System.Single,System.Single,System.Single,System.Single,System.Single)"]

minRegenRatio (Optional)
Type: SystemSingle

[Missing <param name="minRegenRatio"/> documentation for "M:Sandbox.Game.Entities.MyEntityStat.AddEffect(System.Single,System.Single,System.Single,System.Single,System.Single)"]

maxRegenRatio (Optional)
Type: SystemSingle

[Missing <param name="maxRegenRatio"/> documentation for "M:Sandbox.Game.Entities.MyEntityStat.AddEffect(System.Single,System.Single,System.Single,System.Single,System.Single)"]

Return Value

Type: Int32

[Missing <returns> documentation for "M:Sandbox.Game.Entities.MyEntityStat.AddEffect(System.Single,System.Single,System.Single,System.Single,System.Single)"]

See Also