Click or drag to resize

EntityId Structure

Represents an identifier of an entity.

Namespace:  SampSharp.Entities
Assembly:  SampSharp.Entities (in SampSharp.Entities.dll) Version: 0.0.0-local+709673996c0cc3c0733358a87691d1009326afa7
Syntax
C#
public struct EntityId

The EntityId type exposes the following members.

Constructors
  NameDescription
Public methodEntityId
Initializes a new instance of the EntityId struct.
Top
Properties
  NameDescription
Public propertyHandle
Gets the handle of the entity identifier.
Public propertyIsEmpty
Gets a value indicating whether this handle is empty.
Public propertyIsInvalidHandle
Gets a value indicating whether this handle is invalid.
Public propertyType
Gets the identifier which uniquely identifies the type of the entity identifier.
Top
Methods
Operators
  NameDescription
Public operatorStatic memberEquality
Implements the operator ==.
Public operatorStatic memberFalse
Implements the operator false. Returns true if the specified value is of the default empty type or has an invalid handle.
Public operatorStatic member(Component to EntityId)
Performs an implicit conversion from Component to EntityId. Returns the entity of the component.
Public operatorStatic member(EntityId to Boolean)
Performs an implicit conversion from EntityId to Boolean. Returns true if the specified value is not of the default empty type and does not have an invalid handle.
Public operatorStatic member(EntityId to Int32)
Performs an implicit conversion from EntityId to Int32. Returns the handle of this value.
Public operatorStatic memberInequality
Implements the operator !=.
Public operatorStatic memberLogicalNot
Implements the operator !. Returns true if the specified value is of the default empty type or has an invalid handle.
Public operatorStatic memberTrue
Implements the operator true. Returns true if the specified value is not of the default empty type and does not have an invalid handle.
Top
Fields
  NameDescription
Public fieldStatic memberEmpty
An empty entity identifier.
Top
Extension Methods
  NameDescription
Public Extension MethodHandleOrDefault
Returns the handle of the entity or the specified default value if the entity is empty.
(Defined by EntityExtensions.)
Public Extension MethodIsOfAnyType
Returns a value indicating whether the entity identifier of the specified entity is of any of the specified types.
(Defined by EntityExtensions.)
Public Extension MethodIsOfType
Returns a value indicating whether the entity identifier of the specified entity is of the specified type.
(Defined by EntityExtensions.)
Top
See Also