BlueBeard.Items 0.1.0-ci.24

This is a prerelease version of BlueBeard.Items.

dotnet add package BlueBeard.Items --version 0.1.0-ci.24

NuGet\Install-Package BlueBeard.Items -Version 0.1.0-ci.24

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="BlueBeard.Items" Version="0.1.0-ci.24" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="BlueBeard.Items" Version="0.1.0-ci.24" />
                    

                            Directory.Packages.props

<PackageReference Include="BlueBeard.Items" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add BlueBeard.Items --version 0.1.0-ci.24

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: BlueBeard.Items, 0.1.0-ci.24"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package BlueBeard.Items@0.1.0-ci.24

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=BlueBeard.Items&version=0.1.0-ci.24&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=BlueBeard.Items&version=0.1.0-ci.24&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

BlueBeard.Items

Two complementary subsystems for item customisation in Unturned plugins: a low-level state encoder for writing custom data into item state byte arrays, and a high-level behaviour registry for attaching server-side logic to specific item asset IDs.

Features

ItemStateEncoder — little-endian read/write helpers for ushort, uint, ulong, Guid, bool, and length-prefixed UTF-8 strings
ItemStateValidator — gatekeeper that rejects asset types where custom encoding would corrupt weapon / attachment state
IItemBehaviour + ItemBehaviourBase — per-asset-id server hooks for equip, dequip, use, drop, pickup
ItemBehaviourManager — dispatches equip/dequip automatically via PlayerEquipment.OnUseableChanged_Global; exposes NotifyUsed, NotifyDropped, and NotifyPickedUp for plugin-specific manual dispatch of the other events

Quick example

// 1. State encoding
if (ItemStateValidator.IsSafeForCustomState(myAssetId))
{
    var state = new byte[18];
    ItemStateEncoder.WriteUInt64(state, 0, ownerSteamId);
    ItemStateEncoder.WriteBool(state, 8, isLocked);
    ItemStateEncoder.WriteUInt16(state, 9, chargesRemaining);
}

// 2. Behaviour
public class MedkitBehaviour : ItemBehaviourBase
{
    public override void OnUsed(Player player, ItemJar jar)
    {
        // Custom heal logic
    }
}

itemBehaviours.Register(1200, new MedkitBehaviour());
itemBehaviours.Load();

See docs/Items/ in the Infrastructure repo for full reference.

Product	Compatible and additional computed target framework versions.
.NET Framework	net481 is compatible.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETFramework 4.8.1
- BlueBeard.Core (>= 0.1.0-ci.24)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.