Click or drag to resize

Component Class

Represents a component which can be attached to an entity.
Inheritance Hierarchy
SystemObject
  SampSharp.EntitiesComponent
    More...

Namespace:  SampSharp.Entities
Assembly:  SampSharp.Entities (in SampSharp.Entities.dll) Version: 0.0.0-localbuild+05637d43e9f34d872e453289d4e240c843e43b09
Syntax
C#
public abstract class Component

The Component type exposes the following members.

Constructors
  NameDescription
Protected methodComponent
Initializes a new instance of the Component class
Top
Properties
  NameDescription
Public propertyEntity
Gets the entity to which this component has been attached.
Public propertyIsComponentAlive
Gets a value indicating whether this component is alive (has not been destroyed).
Protected propertyManager
Gets the manager of the entity of this component.
Public propertyParent
Gets the parent entity of the entity to which this component has been attached.
Top
Methods
  NameDescription
Public methodAddComponentT
Adds a component of the specified type T to the entity.
Public methodAddComponentT(Object)
Adds a component of the specified type T to the entity with the specified constructor args.
Public methodDestroy
Destroys this component.
Public methodDestroyComponentsT
Destroys the components of the specified type T attached to the entity.
Public methodDestroyEntity
Destroys the entity.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetComponentT
Gets a component of the specified type T attached to the entity.
Public methodGetComponentInChildrenT
Gets a component of the specified type T attached to a child entity of the entity using a depth first search.
Public methodGetComponentInParentT
Gets a component of the specified type T attached to a parent entity of the entity.
Public methodGetComponentsT
Gets all components of the specified type T attached to the entity.
Public methodGetComponentsInChildrenT
Gets all components of the specified type T attached to a child entity of the entity.
Public methodGetComponentsInParentT
Gets all components of the specified type T attached to a parent entity of the entity.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDestroyComponent
This method is invoked before this component is destroyed and removed from its entity.
Protected methodOnInitializeComponent
This method is invoked after this component has been attached the an entity.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Operators
  NameDescription
Public operatorStatic memberFalse
Implements the operator false. Returns true if the specified component is not alive.
Public operatorStatic memberLogicalNot
Implements the operator !. Returns true if the specified component is not alive.
Public operatorStatic memberTrue
Implements the operator true. Returns true if the specified component is alive.
Top
See Also
Inheritance Hierarchy
SystemObject
  SampSharp.EntitiesComponent
    SampSharp.EntitiesNativeComponent
    SampSharp.Entities.SAMPActor
    SampSharp.Entities.SAMPGangZone
    SampSharp.Entities.SAMPGlobalObject
    SampSharp.Entities.SAMPMenu
    SampSharp.Entities.SAMPPickup
    SampSharp.Entities.SAMPPlayer
    SampSharp.Entities.SAMPPlayerObject
    SampSharp.Entities.SAMPPlayerTextDraw
    SampSharp.Entities.SAMPPlayerTextLabel
    SampSharp.Entities.SAMPTextDraw
    SampSharp.Entities.SAMPTextLabel
    SampSharp.Entities.SAMPVehicle
    SampSharp.Entities.SAMPVisibleDialog