Clothingclass

Describes an item of clothing and implicitly which other items it can be worn with

object→GameResource→Clothing
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public sealed class Sandbox.Clothing : Sandbox.GameResource

Constructors1

Showing 1 constructors

Methods5

Showing 5 methods

public bool CanBeWornWith(Sandbox.Clothing target)PUBLIC

Return true if this item of clothing can be worn with the target item, at the same time.

ParameterTypeDescription
targetClothing—
Returns:bool—

public static System.Collections.Generic.List`1<Sandbox.SceneModel> DressSceneObject(Sandbox.SceneModel citizen, System.Collections.Generic.IEnumerable`1<Sandbox.Clothing> Clothing)PUBLICSTATICOBSOLETE

Obsolete: We should be using Scene/Components now

ParameterTypeDescription
citizenSceneModel—
ClothingIEnumerable<Clothing>—
Returns:List<SceneModel>—

public bool HasPermissions()PUBLIC

Can we wear this item?

Returns:bool—

Properties30

Showing 30 properties

public bool Sandbox.Clothing.AllowTintSelect { get; set; }PUBLICGETSET

Returns:bool—

public System.Collections.Generic.Dictionary`2<string,string> Sandbox.Clothing.ConditionalModels { get; set; }PUBLICGETSET

A list of conditional models. (key) = tag(s), (value) = model

Returns:Dictionary<string,string>—

public string Sandbox.Clothing.EyesMaterial { get; set; }PUBLICGETSET

Replace the eyes with this material

Returns:string—

public bool Sandbox.Clothing.HasHumanSkin { get; set; }PUBLICGETSET

Returns:bool—

public float Sandbox.Clothing.HeelHeight { get; set; }PUBLICGETSET

Do we need to lift the heel up?

Returns:float—

public Sandbox.Clothing.BodyGroups Sandbox.Clothing.HideBody { get; set; }PUBLICGETSET

Which body parts of the player model should not show when this clothing is equipped.

Returns:BodyGroups—

public string Sandbox.Clothing.HumanAltFemaleModel { get; set; }PUBLICGETSET

The model to bonemerge to the human player when this clothing is equipped.

Returns:string—

public string Sandbox.Clothing.HumanAltModel { get; set; }PUBLICGETSET

The model to bonemerge to the human player when this clothing is equipped.

Returns:string—

public string Sandbox.Clothing.HumanEyesMaterial { get; set; }PUBLICGETSET

Replace skin with this

Returns:string—

public ulong Sandbox.Clothing.HumanSkinBodyGroups { get; set; }PUBLICGETSET

Bodygroup on the model to choose

Returns:ulong—

public string Sandbox.Clothing.HumanSkinMaterial { get; set; }PUBLICGETSET

Replace skin with this

Returns:string—

public string Sandbox.Clothing.HumanSkinMaterialGroup { get; set; }PUBLICGETSET

Bodygroup on the model to choose

Returns:string—

public string Sandbox.Clothing.HumanSkinModel { get; set; }PUBLICGETSET

Model to replace the human skin with

Returns:string—

public Sandbox.TagSet Sandbox.Clothing.HumanSkinTags { get; set; }PUBLICGETSET

Allows adding tags for this skin, ie "female". This affects which alternative clothing models are used with it.

Returns:TagSet—

public string Sandbox.Clothing.MaterialGroup { get; set; }PUBLICGETSET

Which material group of the model to use.

Returns:string—

public string Sandbox.Clothing.Model { get; set; }PUBLICGETSET

The model to bonemerge to the player when this clothing is equipped.

Returns:string—

public Sandbox.Clothing Sandbox.Clothing.Parent { get; set; }PUBLICGETSETOBSOLETE

The clothing to parent this too. It will be displayed as a variation of its parent

Obsolete: This API member is obsolete.

Returns:Clothing—

public string Sandbox.Clothing.SkinMaterial { get; set; }PUBLICGETSET

Replace the skin with this material

Returns:string—

public Sandbox.Clothing.Slots Sandbox.Clothing.SlotsOver { get; set; }PUBLICGETSET

Which slots this clothing takes on "outer" layer.

Returns:Slots—

public Sandbox.Clothing.Slots Sandbox.Clothing.SlotsUnder { get; set; }PUBLICGETSET

Which slots this clothing takes on "inner" layer.

Returns:Slots—

public System.Nullable`1<int> Sandbox.Clothing.SteamItemDefinitionId { get; set; }PUBLICGETSET

The Steam Item Definition ID for this clothing item, if it's an inventory item

Returns:Nullable<int>—

public string Sandbox.Clothing.SubCategory { get; set; }PUBLICGETSETOBSOLETE

This should be a single word to describe the subcategory, and should match any other items you want to categorize in the same bunch. The work will be tokenized so it can become localized.

Obsolete: This API member is obsolete.

Returns:string—

public string Sandbox.Clothing.Subtitle { get; set; }PUBLICGETSET

A subtitle for this clothing piece.

Returns:string—

public string Sandbox.Clothing.Tags { get; set; }PUBLICGETSET

Returns:string—

public float Sandbox.Clothing.TintDefault { get; set; }PUBLICGETSET

Returns:float—

public string Sandbox.Clothing.Title { get; set; }PUBLICGETSET

Name of the clothing to show in UI.

Returns:string—

On this page

Constructorspublic Clothing()Methodspublic System.Boolean CanBeWornWith(Sandbox.Clothing target)public static System.Collections.Generic.List`1<Sandbox.SceneModel> DressSceneObject(Sandbox.SceneModel citizen, System.Collections.Generic.IEnumerable`1<Sandbox.Clothing> Clothing)public System.String GetModel(System.Collections.Generic.IEnumerable`1<Sandbox.Clothing> clothingList, Sandbox.TagSet tagset)public System.String GetModel(System.Collections.Generic.IEnumerable`1<Sandbox.Clothing> clothingList)public System.Boolean HasPermissions()Propertiespublic System.Boolean Sandbox.Clothing.AllowTintSelect { get; set; }public Sandbox.Clothing.ClothingCategory Sandbox.Clothing.Category { get; set; }public System.Collections.Generic.Dictionary`2<System.String,System.String> Sandbox.Clothing.ConditionalModels { get; set; }public Sandbox.SkinnedModelRenderer.DeformationModeType Sandbox.Clothing.DeformationMode { get; set; }public System.String Sandbox.Clothing.EyesMaterial { get; set; }public System.Boolean Sandbox.Clothing.HasHumanSkin { get; set; }public System.Single Sandbox.Clothing.HeelHeight { get; set; }public Sandbox.Clothing.BodyGroups Sandbox.Clothing.HideBody { get; set; }public System.String Sandbox.Clothing.HumanAltFemaleModel { get; set; }public System.String Sandbox.Clothing.HumanAltModel { get; set; }public System.String Sandbox.Clothing.HumanEyesMaterial { get; set; }public System.UInt64 Sandbox.Clothing.HumanSkinBodyGroups { get; set; }public System.String Sandbox.Clothing.HumanSkinMaterial { get; set; }public System.String Sandbox.Clothing.HumanSkinMaterialGroup { get; set; }public System.String Sandbox.Clothing.HumanSkinModel { get; set; }public Sandbox.TagSet Sandbox.Clothing.HumanSkinTags { get; set; }public Sandbox.Clothing.IconSetup Sandbox.Clothing.Icon { get; set; }public System.String Sandbox.Clothing.MaterialGroup { get; set; }public System.String Sandbox.Clothing.Model { get; set; }public Sandbox.Clothing Sandbox.Clothing.Parent { get; set; }public System.String Sandbox.Clothing.SkinMaterial { get; set; }public Sandbox.Clothing.Slots Sandbox.Clothing.SlotsOver { get; set; }public Sandbox.Clothing.Slots Sandbox.Clothing.SlotsUnder { get; set; }public System.Nullable`1<System.Int32> Sandbox.Clothing.SteamItemDefinitionId { get; set; }public System.String Sandbox.Clothing.SubCategory { get; set; }public System.String Sandbox.Clothing.Subtitle { get; set; }public System.String Sandbox.Clothing.Tags { get; set; }public System.Single Sandbox.Clothing.TintDefault { get; set; }public Sandbox.Gradient Sandbox.Clothing.TintSelection { get; set; }public System.String Sandbox.Clothing.Title { get; set; }Metadata