Class MyEntityStatRegenEffect

Inheritance

System.Object

MyEntityStatRegenEffect

Namespace: Sandbox.Game.Entities

Assembly: Sandbox.Game.dll

Syntax

[MyEntityStatEffectType]
public class MyEntityStatRegenEffect : Object

Constructors

MyEntityStatRegenEffect()

Declaration

public MyEntityStatRegenEffect()

Fields

m_amount

Declaration

protected float m_amount

Field Value

Type	Description
System.Single

m_duration

Declaration

protected float m_duration

Field Value

Type	Description
System.Single

m_interval

Declaration

protected float m_interval

Field Value

Type	Description
System.Single

m_lastRegenTime

Declaration

protected int m_lastRegenTime

Field Value

Type	Description
System.Int32

m_maxRegenRatio

Declaration

protected float m_maxRegenRatio

Field Value

Type	Description
System.Single

m_minRegenRatio

Declaration

protected float m_minRegenRatio

Field Value

Type	Description
System.Single

RemoveWhenReachedMaxRegenRatio

Declaration

public bool RemoveWhenReachedMaxRegenRatio

Field Value

Type	Description
System.Boolean

Properties

AliveTime

Declaration

public int AliveTime { get; }

Property Value

Type	Description
System.Int32

Amount

Declaration

public float Amount { get; set; }

Property Value

Type	Description
System.Single

AmountLeftOverDuration

Declaration

public float AmountLeftOverDuration { get; }

Property Value

Type	Description
System.Single

BirthTime

Declaration

public int BirthTime { get; }

Property Value

Type	Description
System.Int32

DeathTime

Declaration

public int DeathTime { get; }

Property Value

Type	Description
System.Int32

Duration

Declaration

public float Duration { get; }

Property Value

Type	Description
System.Single

Enabled

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
System.Boolean

Interval

Declaration

public float Interval { get; set; }

Property Value

Type	Description
System.Single

LastRegenTime

Declaration

public int LastRegenTime { get; }

Property Value

Type	Description
System.Int32

TicksLeft

Declaration

public int TicksLeft { get; }

Property Value

Type	Description
System.Int32

Methods

CalculateTicksBetweenTimes(Int32, Int32)

Declaration

public int CalculateTicksBetweenTimes(int startTime, int endTime)

Parameters

Type	Name	Description
System.Int32	startTime
System.Int32	endTime

Returns

Type	Description
System.Int32

Closing()

Declaration

public virtual void Closing()

GetMaxRegenRatio()

Declaration

public float GetMaxRegenRatio()

Returns

Type	Description
System.Single

GetObjectBuilder()

Declaration

public virtual MyObjectBuilder_EntityStatRegenEffect GetObjectBuilder()

Returns

Type	Description
MyObjectBuilder_EntityStatRegenEffect

Init(MyObjectBuilder_Base, MyEntityStat)

Declaration

public virtual void Init(MyObjectBuilder_Base objectBuilder, MyEntityStat parentStat)

Parameters

Type	Name	Description
MyObjectBuilder_Base	objectBuilder
MyEntityStat	parentStat

ResetRegenTime()

Declaration

public void ResetRegenTime()

SetAmountAndInterval(Single, Single, Boolean)

Declaration

public void SetAmountAndInterval(float amount, float interval, bool increaseByRemaining)

Parameters

Type	Name	Description
System.Single	amount
System.Single	interval
System.Boolean	increaseByRemaining

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Update(Single)

Declaration

public virtual void Update(float regenAmountMultiplier = 1F)

Parameters

Type	Name	Description
System.Single	regenAmountMultiplier