Empeld
Empeld plugin documentation.
essentials.Systems.Structures.IStructure Interface Reference

Interface representing an in-world structure More...

Inheritance diagram for essentials.Systems.Structures.IStructure:
pluginbase.Objects.Syncable.Entity.IEntity essentials.Systems.Structures.Network.INetworkedStructure essentials.Systems.Structures.Structure essentials.Systems.Structures.Network.NetworkedStructure essentials.Systems.Structures.Network.NetworkedStructure essentials.Systems.Structures.Network.Resources.ConstructedStructure essentials.Systems.Structures.Network.Resources.ConstructedStructure essentials.Systems.Structures.Network.Resources.PoweredStructure essentials.Systems.Structures.Network.Resources.PoweredStructure essentials.Systems.Structures.Network.Resources.ContainerStructure< T > essentials.Systems.Structures.Network.Resources.ContainerStructure< T >

Public Member Functions

void Destroy ()
 Destroy the structure More...
 
void Build ()
 Build the structure More...
 

Properties

string Name [get]
 Name of the structure More...
 
Vector3i Position [get]
 The world-position of the structure More...
 
PrefabInstance PrefabInstance [get]
 The prefab instance of the structure 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...
 

Detailed Description

Interface representing an in-world structure

Member Function Documentation

◆ Build()

void essentials.Systems.Structures.IStructure.Build ( )

Build the structure

Implemented in essentials.Systems.Structures.Structure.

◆ Destroy()

void essentials.Systems.Structures.IStructure.Destroy ( )

Destroy the structure

Property Documentation

◆ Name

string essentials.Systems.Structures.IStructure.Name
get

Name of the structure

The name.

◆ Position

Vector3i essentials.Systems.Structures.IStructure.Position
get

The world-position of the structure

The position.

◆ PrefabInstance

PrefabInstance essentials.Systems.Structures.IStructure.PrefabInstance
get

The prefab instance of the structure

The prefab instance.


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