Interface IMySurvivalBuff
Describes single survival buff
Namespace: Sandbox.ModAPI
Assembly: Sandbox.Common.dll
Syntax
public interface IMySurvivalBuffProperties
Level
Curent buff level
Declaration
int Level { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
NameId
Buff name id
Declaration
MyStringId NameId { get; }Property Value
| Type | Description |
|---|---|
| MyStringId |
NotificationText
Buff progress notification text id
Declaration
MyStringId NotificationText { get; }Property Value
| Type | Description |
|---|---|
| MyStringId |
NotificationTitle
Buff progress notification title id
Declaration
MyStringId NotificationTitle { get; }Property Value
| Type | Description |
|---|---|
| MyStringId |
ProgressionTime
Time to progress to next buff level in seconds
Declaration
int ProgressionTime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
DoProgressStep()
Checks whether the buff should progress to next level
Declaration
bool DoProgressStep()Returns
| Type | Description |
|---|---|
| System.Boolean | true when buff progressed to next level |
GetCurrentBuffValue()
Gets current value of buff
Declaration
float GetCurrentBuffValue()Returns
| Type | Description |
|---|---|
| System.Single |
GetCurrentBuffValueString()
Gets current value of buff in a readable form with unit representation. Example: 120%
Declaration
string GetCurrentBuffValueString()Returns
| Type | Description |
|---|---|
| System.String |
Reset()
Resets buff progress
Declaration
void Reset()