Class EntityLump.Entity

Namespace: ValveResourceFormat.ResourceTypes
Assembly: ValveResourceFormat.dll

Represents a single entity with its properties and connections.

public class EntityLump.Entity : KVObject, IReadOnlyDictionary<string, KVObject>, IReadOnlyCollection<KeyValuePair<string, KVObject>>, IEnumerable<KeyValuePair<string, KVObject>>, IEnumerable, IConvertible

Inheritance

object ← KVObject ← EntityLump.Entity

Implements

IReadOnlyDictionary<string, KVObject>, IReadOnlyCollection<KeyValuePair<string, KVObject>>, IEnumerable<KeyValuePair<string, KVObject>>, IEnumerable, IConvertible

Inherited Members

KVObject.TryGetValue(string, out KVObject), KVObject.ContainsKey(string), KVObject.Add(string, KVObject), KVObject.TryAdd(string, KVObject), KVObject.Add(KVObject), KVObject.Remove(string), KVObject.RemoveAt(int), KVObject.Clear(), KVObject.Collection(), KVObject.Collection(int), KVObject.Collection(IEnumerable<KeyValuePair<string, KVObject>>), KVObject.ListCollection(), KVObject.ListCollection(int), KVObject.ListCollection(IEnumerable<KeyValuePair<string, KVObject>>), KVObject.Array(), KVObject.Array(int), KVObject.Array(IEnumerable<KVObject>), KVObject.Blob(byte[]), KVObject.Null(), KVObject.AsBlob(), KVObject.AsArraySpan(), KVObject.ToBoolean(), KVObject.ToByte(), KVObject.ToSByte(), KVObject.ToChar(), KVObject.ToInt16(), KVObject.ToUInt16(), KVObject.ToInt32(), KVObject.ToUInt32(), KVObject.ToInt64(), KVObject.ToUInt64(), KVObject.ToSingle(), KVObject.ToDouble(), KVObject.ToDecimal(), KVObject.ToString(), KVObject.ToBoolean(IFormatProvider?), KVObject.ToByte(IFormatProvider?), KVObject.ToChar(IFormatProvider?), KVObject.ToDecimal(IFormatProvider?), KVObject.ToDouble(IFormatProvider?), KVObject.ToInt16(IFormatProvider?), KVObject.ToInt32(IFormatProvider?), KVObject.ToInt64(IFormatProvider?), KVObject.ToSByte(IFormatProvider?), KVObject.ToSingle(IFormatProvider?), KVObject.ToString(IFormatProvider?), KVObject.ToUInt16(IFormatProvider?), KVObject.ToUInt32(IFormatProvider?), KVObject.ToUInt64(IFormatProvider?), KVObject.ToType(Type, IFormatProvider?), KVObject.GetEnumerator(), KVObject.ValueType, KVObject.Flag, KVObject.IsNull, KVObject.IsArray, KVObject.IsCollection, KVObject.Count, KVObject.this[string], KVObject.this[int], KVObject.Children, KVObject.Keys, KVObject.Values

Extension Methods

KVObjectExtensions.GetArray(KVObject, string), KVObjectExtensions.GetArray<T>(KVObject, string), KVObjectExtensions.GetBooleanProperty(KVObject, string, bool), KVObjectExtensions.GetByteProperty(KVObject, string), KVObjectExtensions.GetDoubleProperty(KVObject, string, double), KVObjectExtensions.GetEnumValue<TEnum>(KVObject, string, bool, string), KVObjectExtensions.GetFloatArray(KVObject, string), KVObjectExtensions.GetFloatProperty(KVObject, string, float), KVObjectExtensions.GetInt32Property(KVObject, string, int), KVObjectExtensions.GetIntegerArray(KVObject, string), KVObjectExtensions.GetIntegerProperty(KVObject, string, long), KVObjectExtensions.GetStringProperty(KVObject, string, string?), KVObjectExtensions.GetSubCollection(KVObject, string), KVObjectExtensions.GetUInt32Property(KVObject, string, uint), KVObjectExtensions.GetUnsignedIntegerArray(KVObject, string), KVObjectExtensions.GetUnsignedIntegerProperty(KVObject, string, ulong), KVObjectExtensions.IsNotBlobType(KVObject, string), KVDocumentExtensions.ToKV3Document(KVObject, KV3ID?), KVDocumentExtensions.ToKV3String(KVObject, KV3ID?), KVObjectExtensions.ToMatrix4x4(KVObject), KVObjectExtensions.ToQuaternion(KVObject), KVObjectExtensions.ToTransform(KVObject), KVObjectExtensions.ToVector2(KVObject), KVObjectExtensions.ToVector3(KVObject), KVObjectExtensions.ToVector4(KVObject)

Properties

Connections

Gets or sets the entity connections (inputs/outputs).

public List<KVObject>? Connections { get; }

Property Value

List<KVObject>?

ParentLump

Gets or initializes the parent entity lump that contains this entity.

public required EntityLump ParentLump { get; init; }

Property Value

EntityLump

Methods

GetColor32Property(string)

Gets a Color32 property value as a normalized Vector3 (0-1 range).

public Vector3 GetColor32Property(string key)

Parameters

key string

The property name.

Returns

Vector3

The normalized color vector (0-1 range).

GetVector2Property(string, Vector2)

Gets a Vector2 property value by name.

public Vector2 GetVector2Property(string name, Vector2 defaultValue = default)

Parameters

name string

The property name.

defaultValue Vector2

The default value to return if the property is not found.

Returns

Vector2

The Vector2 property value or the default value.

GetVector3Property(string, Vector3)

Gets a Vector3 property value by name.

public Vector3 GetVector3Property(string name, Vector3 defaultValue = default)

Parameters

name string

The property name.

defaultValue Vector3

The default value to return if the property is not found.

Returns

Vector3

The Vector3 property value or the default value.