Skin Base item

Item defined in plugin/items/sh_skin_base.lua

Part of Extra Clothing

Defines skin_base, the base item for clothing that is worn by setting the skin of the player's model.

Derived items set playerSkin, and optionally protection (percent of damage absorbed) and isCombine (Combine players can only wear items marked with it). Wearing goes through Player:SetSkinClothes, the item stays in the inventory, and it is taken off, resetting the skin to 0, when dropped, sold, stored, unequipped or taken from the inventory in any other way.

Originally written for the Global Cooldown community.

Summary

Methods

CanGiveStorage(player, storageTable)shared
Takes the item off when it is put into storage while worn.
CanSell(player)shared
Takes the item off when it is sold while worn.
HasPlayerEquipped(player, bIsValidWeapon)shared
Returns whether the player wears this item instance as their skin.
OnChangeClothes(player, bIsWearing)shared
Sets or resets the player's skin and calls the item's OnChangedClothes if it has one.
OnDrop(player, position)shared
Takes the item off when it is dropped while worn.
OnPlayerUnequipped(player, extraData)shared
Takes the item off when the player unequips it.
OnTakeFromPlayer(player)shared
Takes the item off when it is taken from the player's inventory while worn.
OnUse(player, itemEntity)shared
Wears the item with Player:SetSkinClothes and keeps it in the inventory.
ResetSkin(player)shared
Resets the player's skin to 0.
SetSkin(player, skin)shared
Sets the player's skin, or tells them they cannot wear the item if the model lacks it.

Methods

ITEM:CanGiveStorage(player, storageTable)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:91

Takes the item off when it is put into storage while worn.

Parameters

  • player
  • storageTable

ITEM:CanSell(player)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:82

Takes the item off when it is sold while worn.

Parameters

  • player

ITEM:HasPlayerEquipped(player, bIsValidWeapon)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:122

Returns whether the player wears this item instance as their skin.

Uses the networked skinClothesData on the client.

Parameters

  • player Player The player to check
  • bIsValidWeapon Boolean Unused

Returns

  • Boolean Whether the item is worn

ITEM:OnChangeClothes(player, bIsWearing)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:103

Sets or resets the player's skin and calls the item's OnChangedClothes if it has one.

Parameters

  • player Player The wearer
  • bIsWearing Boolean Whether the item is being put on

ITEM:OnDrop(player, position)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:73

Takes the item off when it is dropped while worn.

Parameters

  • player
  • position

ITEM:OnPlayerUnequipped(player, extraData)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:140

Takes the item off when the player unequips it.

Parameters

  • player
  • extraData

ITEM:OnTakeFromPlayer(player)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:145

Takes the item off when it is taken from the player's inventory while worn.

Parameters

  • player

ITEM:OnUse(player, itemEntity)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:54

Wears the item with Player:SetSkinClothes and keeps it in the inventory.

Combine players can only wear items marked isCombine, and dead or ragdolled players cannot wear anything.

Parameters

  • player
  • itemEntity

Returns

  • Boolean true when worn, false otherwise; either way the item is kept

ITEM:ResetSkin(player)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:43

Resets the player's skin to 0.

Parameters

  • player Player The wearer

Returns

  • Boolean Always true

ITEM:SetSkin(player, skin)

shared gamemodes/cwhl2rp/plugins/clothes/plugin/items/sh_skin_base.lua:27

Sets the player's skin, or tells them they cannot wear the item if the model lacks it.

Parameters

  • player Player The wearer
  • skin Number The skin index

Returns

  • Boolean Whether the skin was set

Defined in