Empeld
Empeld plugin documentation.
essentials.Prefabs.IReadonlyPrefab Interface Reference

An interface for a readonly prefab object More...

Inheritance diagram for essentials.Prefabs.IReadonlyPrefab:
essentials.Prefabs.IPrefab essentials.Prefabs.Prefab

Public Member Functions

bool InBounds (int x, int y, int z)
 Returns whether or not a point is within the bounds of the prefab More...
 
bool InBounds (Vector3i pt)
 Returns whether or not a point is within the bounds of the prefab More...
 

Properties

int Width [get]
 The width of the prefab More...
 
int Length [get]
 The length of the prefab More...
 
int Height [get]
 The height of the prefab More...
 
Size3i Size [get]
 The size of the prefab (width, length, height) More...
 
Vector3i Center [get]
 The relative center coordinate of the prefab More...
 

Detailed Description

An interface for a readonly prefab object

Member Function Documentation

◆ InBounds() [1/2]

bool essentials.Prefabs.IReadonlyPrefab.InBounds ( int  x,
int  y,
int  z 
)

Returns whether or not a point is within the bounds of the prefab

Returns
true, if bounds was in, false otherwise.
Parameters
xThe x coordinate.
yThe y coordinate.
zThe z coordinate.

◆ InBounds() [2/2]

bool essentials.Prefabs.IReadonlyPrefab.InBounds ( Vector3i  pt)

Returns whether or not a point is within the bounds of the prefab

Returns
true, if bounds was in, false otherwise.
Parameters
ptPoint.

Property Documentation

◆ Center

Vector3i essentials.Prefabs.IReadonlyPrefab.Center
get

The relative center coordinate of the prefab

The center.

◆ Height

int essentials.Prefabs.IReadonlyPrefab.Height
get

The height of the prefab

The height.

◆ Length

int essentials.Prefabs.IReadonlyPrefab.Length
get

The length of the prefab

The length.

◆ Size

Size3i essentials.Prefabs.IReadonlyPrefab.Size
get

The size of the prefab (width, length, height)

The size.

◆ Width

int essentials.Prefabs.IReadonlyPrefab.Width
get

The width of the prefab

The width.


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