Class ItemEnhancement

Namespace

Nekoyume.Action

Assembly

Lib9c.dll

Updated at https://github.com/planetarium/lib9c/pull/2195

[Serializable]
[ActionType("item_enhancement14")]
public class ItemEnhancement : GameAction, IAction, IItemEnhancementV5

Inheritance

object

ActionBase

GameAction

ItemEnhancement

Implements

IAction

IItemEnhancementV5

Inherited Members

GameAction.Id

GameAction.PlainValue

GameAction.LoadPlainValue(IValue)

ActionBase.GetSignerAndOtherAddressesHex(IActionContext, params Address[])

ActionBase.TryGetAdminState(IActionContext, out AdminState)

ActionBase.CheckPermission(IActionContext)

ActionBase.CheckObsolete(long, IActionContext)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

HammerBannedTypes

public static readonly IReadOnlyCollection<ItemSubType> HammerBannedTypes

Field Value

IReadOnlyCollection<ItemSubType>

HammerIds

public static readonly IReadOnlyCollection<int> HammerIds

Field Value

IReadOnlyCollection<int>

MaterialCountLimit

public const int MaterialCountLimit = 50

Field Value

int

avatarAddress

public Address avatarAddress

Field Value

Address

hammers

public Dictionary<int, int> hammers

Field Value

Dictionary<int, int>

itemId

public Guid itemId

Field Value

Guid

materialIds

public List<Guid> materialIds

Field Value

List<Guid>

slotIndex

public int slotIndex

Field Value

int

Properties

PlainValueInternal

protected override IImmutableDictionary<string, IValue> PlainValueInternal { get; }

Property Value

IImmutableDictionary<string, IValue>

Methods

Execute(IActionContext)

Executes the main game logic of an action. This should be deterministic.

Through the context object, it receives information such as a transaction signer, its states immediately before the execution, and a deterministic random seed.

Other “bound” information resides in the action object in itself, as its properties (or fields).

A returned Libplanet.Action.State.IWorld object functions as a delta which shifts from previous states to next states.

public override IWorld Execute(IActionContext context)

Parameters

context IActionContext

A context object containing addresses that signed the transaction, states immediately before the execution, and a PRNG object which produces deterministic random numbers. See Libplanet.Action.IActionContext for details.

Returns

IWorld

A map of changed states (so-called "dirty").

Remarks

This method should be deterministic: for structurally (member-wise) equal actions and Libplanet.Action.IActionContexts, the same result should be returned. Side effects should be avoided, because an action's Libplanet.Action.IAction.Execute(Libplanet.Action.IActionContext) method can be called more than once, the time it's called is difficult to predict.

For changing in-memory game states or drawing graphics, implement the Blockchain.Renderers.IRenderer interface separately and attach it to a Blockchain.BlockChain instance.

For randomness, never use Random nor any other PRNGs provided by other than Libplanet. Use IActionContext.Random instead. IActionContext.Random guarantees the same action has the consistent result for every node in the network.

Also do not perform I/O operations such as file system access or networking. These bring an action indeterministic. You maybe fine to log messages for debugging purpose, but equivalent messages could be logged multiple times.

Although it might be surprising, floating-point arithmetics are underspecified so that it can make different results on different machines, platforms, runtimes, compilers, and builds.

Lastly, you need to be aware and keep in mind that there is a global state named CurrentCulture on .NET; if you format numbers, dates and times, currencies, or other such things into strings and parse these strings back these can rely on CurrentCulture, so that the same action make different results on two differently configured systems like Thai language and French language. In order to make these types of conversions deterministic, you have to explicitly pass InvariantCulture.

For more on determinism in general, please read also Tendermint ABCI's docs on determinism.

Lastly, you can conduct static analysis on your code using Libplanet.Analyzers. The analyzer can be enabled by adding its NuGet package into your project as a dependency.

See Also

IActionContext

GetEquipmentMaxLevel(Equipment, EnhancementCostSheetV3)

public static int GetEquipmentMaxLevel(Equipment equipment, EnhancementCostSheetV3 sheet)

Parameters

equipment Equipment

sheet EnhancementCostSheetV3

Returns

int

GetRequiredBlockCount(Equipment, Equipment, EnhancementCostSheetV3)

public static int GetRequiredBlockCount(Equipment preEquipment, Equipment targetEquipment, EnhancementCostSheetV3 sheet)

Parameters

preEquipment Equipment

targetEquipment Equipment

sheet EnhancementCostSheetV3

Returns

int

LoadPlainValueInternal(IImmutableDictionary<string, IValue>)

protected override void LoadPlainValueInternal(IImmutableDictionary<string, IValue> plainValue)

Parameters

plainValue IImmutableDictionary<string, IValue>

TryGetRow(Equipment, EnhancementCostSheetV3, out Row)

public static bool TryGetRow(Equipment equipment, EnhancementCostSheetV3 sheet, out EnhancementCostSheetV3.Row row)

Parameters

equipment Equipment

sheet EnhancementCostSheetV3

row EnhancementCostSheetV3.Row

Returns

bool