PlayerObject Class |
Represents a player-object.
Inheritance HierarchySystemObject
SampSharp.GameMode.ToolsDisposable
SampSharp.GameMode.PoolsIdentifiedOwnedPoolPlayerObject, BasePlayer
SampSharp.GameMode.WorldPlayerObject
SampSharp.GameMode.ToolsDisposable
SampSharp.GameMode.PoolsIdentifiedOwnedPoolPlayerObject, BasePlayer
SampSharp.GameMode.WorldPlayerObject
Namespace: SampSharp.GameMode.World
Assembly: SampSharp.GameMode (in SampSharp.GameMode.dll) Version: 0.0.0-localbuild+05637d43e9f34d872e453289d4e240c843e43b09
SyntaxC#
public class PlayerObject : IdentifiedOwnedPool<PlayerObject, BasePlayer>, IGameObject, IWorldObject
The PlayerObject type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PlayerObject |
Initializes a new instance of the PlayerObject class.
|
| PlayerObject(BasePlayer, Int32, Vector3, Vector3) |
Initializes a new instance of the PlayerObject class.
|
| PlayerObject(BasePlayer, Int32, Vector3, Vector3, Single) |
Initializes a new instance of the PlayerObject class.
|
Properties| Name | Description | |
|---|---|---|
 | DrawDistance |
Gets the draw distance of this IGameObject.
|
| Id |
Gets the identifier of this instance.
(Inherited from IdentifiedOwnedPoolTInstance, TOwner.) |
| IsDisposed |
Gets whether this resource has been disposed.
(Inherited from Disposable.) |
| IsMoving |
Gets whether this IGameObject is moving.
|
| IsValid |
Gets whether this IGameObject is valid.
|
| ModelId |
Gets the model of this IGameObject.
|
| Owner |
Gets the owner of this instance.
(Inherited from IdentifiedOwnedPoolTInstance, TOwner.) |
| Position |
Gets the position of this IWorldObject.
|
| Rotation |
Gets the rotation of this IGameObject.
|
Methods| Name | Description | |
|---|---|---|
 | AssertNotDisposed |
Checks whether this instance has been disposed. If it has, it throws an exception.
(Inherited from Disposable.) |
| AttachCameraToObject |
Attaches the player's camera to this PlayerObject.
|
| AttachTo(BasePlayer, Vector3, Vector3) |
Attaches this PlayerObject to the specified player.
|
| AttachTo(BaseVehicle, Vector3, Vector3) |
Attaches this PlayerObject to the specified vehicle.
|
| DisableCameraCollisions |
Disable collisions between players' cameras and this PlayerObject.
|
| Dispose |
Performs tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from Disposable.) |
| Dispose(Boolean) |
Performs tasks associated with freeing, releasing, or resetting unmanaged resources.
(Overrides IdentifiedOwnedPoolTInstance, TOwnerDispose(Boolean).) |
| Edit |
Lets the Owner of this PlayerObject edit this
object.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Finalizes an instance of the Disposable class.
(Inherited from Disposable.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize | (Inherited from IdentifiedOwnedPoolTInstance, TOwner.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Move(Vector3, Single) |
Moves this IGameObject to the given position with the given speed.
|
| Move(Vector3, Single, Vector3) |
Moves this IGameObject to the given position and rotation with the given speed.
|
| OnEdited |
Raises the Edited event.
|
| OnMoved |
Raises the Moved event.
|
| OnSelected |
Raises the Selected event.
|
 | Select |
Lets the specified player select an object.
|
| SetMaterial |
Sets the material of this IGameObject.
|
| SetMaterialText |
Sets the material text of this IGameObject.
|
| Stop |
Stop this IGameObject from moving any further.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events| Name | Description | |
|---|---|---|
 | Disposed |
Occurs when this isntance has been disposed.
(Inherited from Disposable.) |
| Edited |
Occurs when the OnEdited(EditPlayerObjectEventArgs) callback is being called.
This callback is called when a player ends object edition mode.
|
| Moved |
Occurs when the OnMoved(EventArgs) callback is being called.
This callback is called when an object is moved after Move(Vector3, Single) (when it stops moving).
|
| Selected |
Occurs when the OnSelected(SelectPlayerObjectEventArgs) callback is being called.
This callback is called when a player selects an object after Select(BasePlayer) has been used.
|
Fields| Name | Description | |
|---|---|---|
 | InvalidId |
Identifier indicating the handle is invalid.
|
| Max |
Maximum number of objects which can exist.
|
See Also