Interface ITradeService

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public interface ITradeService : IService

Methods

GetRandomValidTradeFromTrades(ITrade[])

Returns a random valid ITrade from an array of ITrades.

Declaration

ITrade GetRandomValidTradeFromTrades(ITrade[] tradePool)

Parameters

Type	Name	Description
ITrade[]	tradePool	An array of ITrades in the pool of potential trades.

Returns

Type	Description
ITrade

GetRandomValidTradeFromTrades(String[])

Returns a random valid ITrade from an array of ITradeData ids.

Declaration

ITrade GetRandomValidTradeFromTrades(string[] tradePool)

Parameters

Type	Name	Description
String[]	tradePool	An array of string IDs of ITrades in the pool of potential trades.

Returns

Type	Description
ITrade

GetTrade(String)

Returns a trade with the specified id.

Declaration

ITrade GetTrade(string id)

Parameters

Type	Name	Description
String	id

Returns

Type	Description
ITrade

GetTrades(String[])

Returns an array of ITrade entities with Ids specified in ids array.

Declaration

ITrade[] GetTrades(string[] ids)

Parameters

Type	Name	Description
String[]	ids

Returns

Type	Description
ITrade[]

GetTradesWithInputTag(String)

Returns all ITrade entities with the specified targetTagId.

Declaration

ITrade[] GetTradesWithInputTag(string targetTagId)

Parameters

Type	Name	Description
String	targetTagId

Returns

Type	Description
ITrade[]

GetTradesWithInputTags(String[])

Returns all ITrade entities which contain all the input tags specified by targetTagIds.

Declaration

ITrade[] GetTradesWithInputTags(string[] targetTagIds)

Parameters

Type	Name	Description
String[]	targetTagIds

Returns

Type	Description
ITrade[]

Remarks

All Tag Ids specified must be present on the ITrade for it to be returned. Searching for a sub-set of the Tag Ids on a ITrade is supported.

Examples

If a ITrade has the ITagData for "Business" and "Rare" then it will be returned when searching for the Tag Ids "Business", "Rare" or "Business" + "Rare". If a ITrade has only one ITagData for "Rare" then it will only be returned by a search for the Tag Id "Business". The ITrade will not be returned by a search for the Tag Ids "Business" + "Rare".

GetTradesWithOutputTag(String)

Returns all ITrade objects with the specified targetTagId.

Declaration

ITrade[] GetTradesWithOutputTag(string targetTagId)

Parameters

Type	Name	Description
String	targetTagId

Returns

Type	Description
ITrade[]

GetTradesWithOutputTags(String[])

Returns all ITrade objects which contain all the output tags specified via by targetTagIds.

Declaration

ITrade[] GetTradesWithOutputTags(string[] targetTagIds)

Parameters

Type	Name	Description
String[]	targetTagIds

Returns

Type	Description
ITrade[]

Remarks

All Tag Ids specified must be present on the ITrade for it to be returned. Searching for a sub-set of the Tag Ids on a ITrade is supported.

Examples

If a ITrade has the ITagData for "Business" and "Rare" then it will be returned when searching for the Tag Ids "Business", "Rare" or "Business" + "Rare". If a ITrade has only one ITagData for "Rare" then it will only be returned by a search for the Tag Id "Business". The ITrade will not be returned by a search for the Tag Ids "Business" + "Rare".

GetTradesWithTags(String[], String[])

Returns all ITrade objects with the specified inputTargetTagIds and outputTargetTagIds.

Declaration

ITrade[] GetTradesWithTags(string[] inputTargetTagIds, string[] outputTargetTagIds)

Parameters

Type	Name	Description
String[]	inputTargetTagIds
String[]	outputTargetTagIds

Returns

Type	Description
ITrade[]

Remarks

All Tag Ids specified must be present on the ITrade for it to be returned. Searching for a sub-set of the Tag Ids on a ITrade is supported.

Examples

If a ITrade has the ITagData for "Business" and "Rare" then it will be returned when searching for the Tag Ids "Business", "Rare" or "Business" + "Rare". If a ITrade has only one ITagData for "Rare" then it will only be returned by a search for the Tag Id "Business". The ITrade will not be returned by a search for the Tag Ids "Business" + "Rare".