Barotrauma Client Doc
Barotrauma.SetPriceMultiplierAction Class Reference
Inheritance diagram for Barotrauma.SetPriceMultiplierAction:
Barotrauma.EventAction

Public Types

enum class  OperationType { Set , Multiply , Min , Max }
 
enum class  PriceMultiplierType { Store , Mechanical }
 

Public Member Functions

 SetPriceMultiplierAction (ScriptedEvent parentEvent, ContentXElement element)
 
override bool IsFinished (ref string goTo)
 Has the action finished. More...
 
override void Reset ()
 
override void Update (float deltaTime)
 
override string ToDebugString ()
 Rich test to display in debugdraw More...
 
- Public Member Functions inherited from Barotrauma.EventAction
 EventAction (ScriptedEvent parentEvent, ContentXElement element)
 
virtual bool SetGoToTarget (string goTo)
 
virtual bool CanBeFinished ()
 
virtual IEnumerable< EventActionGetSubActions ()
 

Properties

float Multiplier [get, set]
 
OperationType Operation [get, set]
 
PriceMultiplierType TargetMultiplier [get, set]
 

Additional Inherited Members

- Static Public Member Functions inherited from Barotrauma.EventAction
static EventAction Instantiate (ScriptedEvent scriptedEvent, ContentXElement element)
 
- Public Attributes inherited from Barotrauma.EventAction
readonly ScriptedEvent ParentEvent
 
- Protected Member Functions inherited from Barotrauma.EventAction
void ApplyTagsToHulls (Entity entity, Identifier hullTag, Identifier linkedHullTag)
 

Detailed Description

Definition at line 6 of file SetPriceMultiplierAction.cs.

Member Enumeration Documentation

◆ OperationType

Enumerator
Set 
Multiply 
Min 
Max 

Definition at line 8 of file SetPriceMultiplierAction.cs.

◆ PriceMultiplierType

Enumerator
Store 
Mechanical 

Definition at line 16 of file SetPriceMultiplierAction.cs.

Constructor & Destructor Documentation

◆ SetPriceMultiplierAction()

Barotrauma.SetPriceMultiplierAction.SetPriceMultiplierAction ( ScriptedEvent  parentEvent,
ContentXElement  element 
)

Definition at line 31 of file SetPriceMultiplierAction.cs.

Member Function Documentation

◆ IsFinished()

override bool Barotrauma.SetPriceMultiplierAction.IsFinished ( ref string  goToLabel)
virtual

Has the action finished.

Parameters
goToLabelIf null or empty, the event moves to the next action. Otherwise it moves to the specified label.
Returns

Implements Barotrauma.EventAction.

Definition at line 35 of file SetPriceMultiplierAction.cs.

◆ Reset()

override void Barotrauma.SetPriceMultiplierAction.Reset ( )
virtual

Implements Barotrauma.EventAction.

Definition at line 39 of file SetPriceMultiplierAction.cs.

◆ ToDebugString()

override string Barotrauma.SetPriceMultiplierAction.ToDebugString ( )
virtual

Rich test to display in debugdraw

public override string ToDebugString()
{
return $"{ToolBox.GetDebugSymbol(isFinished)} SomeAction -> "(someInfo: {info.ColorizeObject()})";
}
override string ToDebugString()
Rich test to display in debugdraw
Returns

Reimplemented from Barotrauma.EventAction.

Definition at line 99 of file SetPriceMultiplierAction.cs.

◆ Update()

override void Barotrauma.SetPriceMultiplierAction.Update ( float  deltaTime)
virtual

Reimplemented from Barotrauma.EventAction.

Definition at line 44 of file SetPriceMultiplierAction.cs.

Property Documentation

◆ Multiplier

float Barotrauma.SetPriceMultiplierAction.Multiplier
getset

Definition at line 23 of file SetPriceMultiplierAction.cs.

◆ Operation

OperationType Barotrauma.SetPriceMultiplierAction.Operation
getset

Definition at line 26 of file SetPriceMultiplierAction.cs.

◆ TargetMultiplier

PriceMultiplierType Barotrauma.SetPriceMultiplierAction.TargetMultiplier
getset

Definition at line 29 of file SetPriceMultiplierAction.cs.