Struct EquippablePath
- Namespace
- S1API.Entities.Equippables
- Assembly
- S1API.dll
Type-safe wrapper for AvatarEquippable Resources paths. Use predefined static values (e.g. Phone_Lowered, Beer, Flashlight) or Custom(string) for mod-specific items.
public readonly struct EquippablePath- Inherited Members
- Extension Methods
Remarks
Pass to schedule action builders:
- WithItem(EquippablePath) — item to hold on arrival
- WithDrink(EquippablePath) — drink to use on arrival
Pass to prefab builder methods:
- EnsureItemHolding(EquippablePath) — prefab-level default held item
- EnsureDrinking(EquippablePath) — prefab-level default drink
- EnsureGraffiti(EquippablePath) — spray paint equippable
Strings are implicitly converted to EquippablePath, so raw string paths continue to work.
Fields
Baton
Baton (police).
public static readonly EquippablePath BatonField Value
Beer
Beer bottle (drink).
public static readonly EquippablePath BeerField Value
BrokenBottle
Broken bottle melee weapon.
public static readonly EquippablePath BrokenBottleField Value
Coffee
Coffee cup (drink).
public static readonly EquippablePath CoffeeField Value
Cuke
Cuke energy drink.
public static readonly EquippablePath CukeField Value
EnergyDrink
Energy drink (ingredients).
public static readonly EquippablePath EnergyDrinkField Value
Flashlight
Flashlight tool.
public static readonly EquippablePath FlashlightField Value
Hammer
Hammer tool.
public static readonly EquippablePath HammerField Value
Joint
Marijuana joint.
public static readonly EquippablePath JointField Value
Knife
Knife melee weapon.
public static readonly EquippablePath KnifeField Value
M1911
M1911 pistol.
public static readonly EquippablePath M1911Field Value
Phone_Lowered
Phone (lowered).
public static readonly EquippablePath Phone_LoweredField Value
Phone_Raised
Phone (raised).
public static readonly EquippablePath Phone_RaisedField Value
Pipe
Smoking pipe.
public static readonly EquippablePath PipeField Value
PumpShotgun
Pump shotgun.
public static readonly EquippablePath PumpShotgunField Value
Revolver
Revolver pistol.
public static readonly EquippablePath RevolverField Value
SprayPaint
Spray paint (for EnsureGraffiti).
public static readonly EquippablePath SprayPaintField Value
Taser
Taser weapon.
public static readonly EquippablePath TaserField Value
TrashBag
Trash bag.
public static readonly EquippablePath TrashBagField Value
TrashGrabber
Trash grabber tool.
public static readonly EquippablePath TrashGrabberField Value
Trimmers
Trimmers tool.
public static readonly EquippablePath TrimmersField Value
WateringCan
Watering can tool.
public static readonly EquippablePath WateringCanField Value
Properties
ResourcePath
The Resources path (relative to Resources folder, no extension).
public string ResourcePath { get; }Property Value
Methods
Custom(string)
Creates a path for a custom mod equippable.
public static EquippablePath Custom(string resourcePath)Parameters
resourcePathstringResources path (e.g. "MyMod/Items/MyItem").
Returns
ToString()
Returns the Resources path.
public override string ToString()Returns
Operators
implicit operator EquippablePath(string)
Implicit conversion from string for custom paths and existing constants (e.g. Beer).
public static implicit operator EquippablePath(string path)Parameters
pathstring