Empeld
Empeld plugin documentation.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events
essentials.action.ItemFramework.World.ItemDropEntity Class Reference
Inheritance diagram for essentials.action.ItemFramework.World.ItemDropEntity:
pluginbase.Objects.Syncable.Entity.EntityBase essentials.action.ItemFramework.World.IItemDrop pluginbase.Objects.Syncable.Entity.Controllers.IModelEntity pluginbase.Objects.Syncable.Entity.Controllers.IComponentizedEntity pluginbase.Objects.Syncable.Entity.Controllers.IHookedEntity pluginbase.Objects.Syncable.Entity.Controllers.ITaskedEntity pluginbase.Objects.Syncable.Entity.Controllers.IEntityController pluginbase.Objects.Syncable.Entity.IPositionableEntity pluginbase.Objects.Syncable.Entity.IPositionableEntity pluginbase.Objects.Syncable.Entity.Controllers.IRpcEntity pluginbase.Objects.Syncable.Entity.IMutableEntity pluginbase.Objects.Syncable.SyncableObject

Public Member Functions

 ItemDropEntity ()
 
 ItemDropEntity (IItem item, Vector3d pos)
 
IItem PickUp ()
 Destroys the in-world entity, and unboxes to the item More...
 
- Public Member Functions inherited from pluginbase.Objects.Syncable.Entity.EntityBase
void Destroy ()
 Marks the entity for destruction More...
 
override string ToString ()
 Gets a human-readable string representing an entity More...
 
- Public Member Functions inherited from pluginbase.Objects.Syncable.SyncableObject
 SyncableObject ()
 Initializes a new instance of the pluginbase.Objects.Syncable.SyncableObject class. More...
 

Static Public Member Functions

static ItemDropEntity Create< T > (Vector3d pos)
 

Protected Member Functions

sealed override bool ShouldSyncWith (IPositionableEntity user)
 Gets whether or not the entity shuold sync with another entity More...
 
- Protected Member Functions inherited from pluginbase.Objects.Syncable.Entity.EntityBase
void SetTransient (bool isTransient=true)
 Sets whether or not the entity will be persisted Transient entities will not be persisted More...
 
virtual void OnServerSpawn ()
 Raises the server spawn event. Will only be called once, even across reloads More...
 
virtual void OnServerDestroy ()
 Raises the server destroy event. More...
 
void InvokeRemotely (string methodName, RpcTarget target, params object[] args)
 Invoke a remote method on a target More...
 
void InvokeRemotely< T > (string methodName, RpcTarget target, Action< RpcNetworkContext, T > returnCallback, params object[] args)
 Invoke a remote method on a target More...
 
void InvokeRemotely< T > (string methodName, RpcTarget target, Action< T > returnCallback, params object[] args)
 Invoke a remote method on a target More...
 
void InvokeDirect (string methodName, params object[] args)
 Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server More...
 
void InvokeDirect< T > (string methodName, Action< RpcNetworkContext, T > returnCallback, params object[] args)
 Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server More...
 
void InvokeDirect< T > (string methodName, Action< T > returnCallback, params object[] args)
 Invoke a remote method on the opposite-owner eg. if this is the server, than on the client owner, otherwise on the server More...
 
void InvokeDirect (Expression< Action > thisExpression)
 Invokes a method on the opposite-owner. Action must act upon this More...
 
void InvokeDirect< TRet > (Expression< Func< TRet >> thisExpression, Action< TRet > returnCallback)
 Invokes a method on the opposite-owner. Action must act upon this More...
 
- Protected Member Functions inherited from pluginbase.Objects.Syncable.SyncableObject
sealed override void ResetWatch ()
 Reset variables watched status More...
 
sealed override void TouchRecurse ()
 Touch self, including all children of this syncable object More...
 
sealed override void EncodeTo (BinaryWriter writer, EncodeContext context)
 Encode changes to binary data More...
 
sealed override void DecodeFrom (BinaryReader reader, DecodeContext context)
 Decode changes from binary data More...
 
sealed override void Persist (IPersistObject obj)
 Build up a persistant object for this syncable, including all sync children and persist objects More...
 
sealed override void Load (IReadPersistObject obj)
 Load a given persistent object back into this instance More...
 
- Protected Member Functions inherited from pluginbase.Objects.Syncable.SyncableBase< T >
void Touch ()
 Touch the instance, notifying something has changed More...
 
virtual void OnChanged ()
 Raises the changed event. More...
 

Properties

IItem Item [get, set]
 
Vector3d Position [get, set]
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.EntityBase
bool Spawned [get]
 Gets a value indicating whether this entity has been spawned More...
 
uint ObjectId [get]
 Gets or sets the object identifier. More...
 
ushort OwnerId [get]
 The ident of the owner of the obejct More...
 
sealed override ushort NetOwnerId [get]
 Who owns me?! (Net ID) This is how we pass information down to SyncableObject More...
 
bool IsServer [get]
 Is the current object instantiated on the server More...
 
ushort ObjectTypeId [get]
 The type ID of the object, as defined by the entity attribute More...
 
- Properties inherited from pluginbase.Objects.Syncable.SyncableObject
virtual ushort NetOwnerId [get]
 Gets the network owner of this object (user id) More...
 
- Properties inherited from pluginbase.Objects.Syncable.INetSyncable
INetWatcher Watcher [get, set]
 Who is watching (who to inform of a change) More...
 
bool Modified [get]
 Gets a value indicating whether this pluginbase.Objects.Syncable.INetSyncable is modified. More...
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.IEntity
uint ObjectId [get]
 Gets the object identifier. More...
 
ushort OwnerId [get]
 Gets the owner identifier. (Net Ident) More...
 
ushort ObjectTypeId [get]
 Gets the object type identifier, as defined by the attribute More...
 
bool DestroyFlag [get]
 Gets a value indicating whether this pluginbase.Objects.Syncable.Entity.IEntity is destroyable. More...
 
bool Spawned [get]
 Gets a value indicating whether this entity has been spawned More...
 
bool Transient [get]
 Gets a value indicating whether this entity is transient (Won't be saved) More...
 
- Properties inherited from essentials.action.ItemFramework.World.IItemDrop
IItem Item [get]
 The item that has been dropped More...
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.IPositionableEntity
Vector3d Position [get]
 Gets the position. More...
 
Vector3d UpVector [get]
 Gets up vector. More...
 
Rotation2d Rotation [get]
 Gets the rotation. More...
 
- Properties inherited from pluginbase.Objects.Syncable.Entity.Controllers.IModelEntity
IModelInstance Model [get]
 The instance of the model used for the entity More...
 
string NamePlate [get]
 The name plate displayed for the entity, if any More...
 
double NamePlateViewDistance [get]
 The distance the name plate can be viewed from More...
 
Vector3d NamePlateOffset [get]
 The offset of the nameplate from the position of the entity More...
 
bool Visible [get]
 Gets a value indicating whether the entity is visible More...
 
bool CastShadow [get]
 Gets a value indiciating whether the entity casts a shadow More...
 

Additional Inherited Members

- Events inherited from pluginbase.Objects.Syncable.SyncableBase< T >
Action< T > Changed
 Event triggered when any change occurs on this object, either locally or over the network More...
 
Action< T > NetUpdate
 Event triggered when a change occurs resulting from a change over the network More...
 
Action< T > Touched
 Event occurs only when an object is first touched. Usually the first instance of a local-change More...
 

Detailed Description

Attribute: Entity("item_drop")

Constructor & Destructor Documentation

essentials.action.ItemFramework.World.ItemDropEntity.ItemDropEntity ( )
50  {
51  this.InjectDependencies();
52  }
essentials.action.ItemFramework.World.ItemDropEntity.ItemDropEntity ( IItem  item,
Vector3d  pos 
)
55  :this()
56  {
57  this.Item = item;
58  this.Position = pos;
59  }
Vector3d Position
Definition: ItemDropEntity.cs:84
IItem Item
Definition: ItemDropEntity.cs:38

Member Function Documentation

static ItemDropEntity essentials.action.ItemFramework.World.ItemDropEntity.Create< T > ( Vector3d  pos)
static
Type Constraints
T :class 
T :IItem 
62  : class, IItem
63  {
64  var inst = (T)Activator.CreateInstance(typeof(T));
65  return new ItemDropEntity(inst, pos);
66  }
ItemDropEntity()
Definition: ItemDropEntity.cs:49
IItem essentials.action.ItemFramework.World.ItemDropEntity.PickUp ( )

Destroys the in-world entity, and unboxes to the item

Returns
The up.

Implements essentials.action.ItemFramework.World.IItemDrop.

69  {
70  var item = this._itemSync.Value;
71  this._itemSync.Value = null;
72  this.Destroy();
73  return item;
74  }
void Destroy()
Marks the entity for destruction
Definition: EntityBase.cs:181
sealed override bool essentials.action.ItemFramework.World.ItemDropEntity.ShouldSyncWith ( IPositionableEntity  user)
protectedvirtual

Gets whether or not the entity shuold sync with another entity

Returns
true, if sync with was shoulded, false otherwise.
Parameters
userUser.

Reimplemented from pluginbase.Objects.Syncable.Entity.EntityBase.

159  {
160  if (user != null)
161  {
162  return VExt.InSquareDistance( this._positionSync.Value, user.Position, this.Item.ViewDistance );
163  }
164  return false;
165  }
Vector math extensions
Definition: VectorExtensions.cs:10
static bool InSquareDistance(Vector3 a, Vector3 b, float d)
Checks whether or not two vectors are within a square distance of each other
Definition: VectorExtensions.cs:156
Vector3d Position
Gets the position.
Definition: IPositionableEntity.cs:17

Property Documentation

IItem essentials.action.ItemFramework.World.ItemDropEntity.Item
getset
Vector3d essentials.action.ItemFramework.World.ItemDropEntity.Position
getset

The documentation for this class was generated from the following file: