Class ExpeditionEvent

Class for handling Expedition Events

Inheritance

System.Object

ExpeditionEvent

Namespace: Mannequin.Bindings

Assembly: Collapse.dll

Syntax

public class ExpeditionEvent : object

Constructors

ExpeditionEvent(String, String)

Create a new Expedition event.

Declaration

public ExpeditionEvent(string name, string description)

Parameters

Type	Name	Description
System.String	name	The name of the event
System.String	description	The description of the event

Properties

Description

This event's description

Declaration

public string Description { get; }

Property Value

Type	Description
System.String

FailureStrength

Chance of failure. fail/(fail+success)%

Declaration

public float FailureStrength { get; set; }

Property Value

Type	Description
System.Single

Name

The name of this event

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

SuccessStrength

Chance of success. success/(fail+success)%

Declaration

public float SuccessStrength { get; set; }

Property Value

Type	Description
System.Single

Methods

AddFailureEffect(EExpeditionEventEffect)

Add a failure effect to this ExpeditionEvent

Declaration

public void AddFailureEffect(EExpeditionEventEffect effect)

Parameters

Type	Name	Description
EExpeditionEventEffect	effect	The failure effect to add

AddSuccessEffect(EExpeditionEventEffect)

Add a success effect to this ExpeditionEvent

Declaration

public void AddSuccessEffect(EExpeditionEventEffect effect)

Parameters

Type	Name	Description
EExpeditionEventEffect	effect	The success effect to add

GetFailureEffects()

Get the failure effects of this ExpeditionEvent

Declaration

public List<EExpeditionEventEffect> GetFailureEffects()

Returns

Type	Description
List<EExpeditionEventEffect>	The failure effects of this ExpeditionEvent

GetSuccessEffects()

Get the success effects of this ExpeditionEvent

Declaration

public List<EExpeditionEventEffect> GetSuccessEffects()

Returns

Type	Description
List<EExpeditionEventEffect>	The success effects of this ExpeditionEvent

RemoveFailureEffect(EExpeditionEventEffect)

Remove a failure effect from this ExpeditionEvent

Declaration

public void RemoveFailureEffect(EExpeditionEventEffect effect)

Parameters

Type	Name	Description
EExpeditionEventEffect	effect	The failure effect to remove

RemoveSuccessEffect(EExpeditionEventEffect)

Remove a success effect from this ExpeditionEvent

Declaration

public void RemoveSuccessEffect(EExpeditionEventEffect effect)

Parameters

Type	Name	Description
EExpeditionEventEffect	effect	The success effect to remove