Class NumberEffector

Performs an arithmetical operation with one or two operands. The expected parameters follow. operand1 expects the first operand. operand2 expects the second operand (only for binary operators). operator expects an arithmetical operator such as NEGATION, INCREMENT, DECREMENT, ADDITION, SUBSTRACTION, MULTIPLICATION, DIVISION or SET. result expects either ScenarioContext.<key> to impact the scenario context or SequenceContext.<place id>.<key> to impact the sequence context.

Inheritance

object

AFunction

AEffector

NumberEffector

Inherited Members

AEffector.Finished

AEffector.Event

AEffector.externalContext

AEffector.scenarioContext

AEffector.sequenceContext

AEffector.eventContext

AFunction.Parameters

AFunction.Contexts

AFunction.Reset()

AFunction.UpdateContexts(ContextHolder)

AFunction.SetParameters(Dictionary<string, Parameter>)

AFunction.FillParameters()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Xareus.Scenarios.Arithmetics

Assembly: Xareus.Scenarios.Extra.dll

Syntax

[Renamed("NumberEffector", "SEVEN.Extra")]
[Renamed("SEVEN.Arithmetics.NumberEffector", "SEVEN.Extra")]
public class NumberEffector : AEffector

Constructors

NumberEffector(Event, Dictionary<string, Parameter>, ContextHolder)

Declaration

protected NumberEffector(Event @event, Dictionary<string, Parameter> parameters, ContextHolder contexts)

Parameters

Type	Name	Description
Event	event
Dictionary<string, Parameter>	parameters
ContextHolder	contexts

Fields

operand1

The first operand

Declaration

[ConfigurationParameter("operand1", Necessity.Required)]
protected float operand1

Field Value

Type	Description
float

operand2

The second operand

Declaration

[ConfigurationParameter("operand2", Necessity.Optional)]
protected float operand2

Field Value

Type	Description
float

operator

The arithmetical operator

Declaration

[ConfigurationParameter("operator", Necessity.Required)]
protected NumberEffector.ArithmeticalOperator @operator

Field Value

Type	Description
NumberEffector.ArithmeticalOperator

result

The result of the operation

Declaration

[ContextVariable("result", "The result of the operation")]
protected ContextVariable<float> result

Field Value

Type	Description
ContextVariable<float>

Methods

Compute(float, float, ArithmeticalOperator)

Declaration

public static float Compute(float operand1, float operand2, NumberEffector.ArithmeticalOperator @operator)

Parameters

Type	Name	Description
float	operand1
float	operand2
NumberEffector.ArithmeticalOperator	operator

Returns

Type	Description
float

EffectorUpdate()

Declaration

public override void EffectorUpdate()

Overrides

AEffector.EffectorUpdate()