VerticesEngine.vxRegisterAsSandboxEntityAttribute Class Reference

Inheritance diagram for VerticesEngine.vxRegisterAsSandboxEntityAttribute:

Public Member Functions
	vxRegisterAsSandboxEntityAttribute (string name, object category, object subCategory, string assetPath, EntityType EntityType=EntityType.BaseEntity, EntityAssetType EntityAssetType=EntityAssetType.Model, bool IsVisibleInSandboxList=true)
	This tags a class as a sandbox item and allows you to explicitly set the asset path. This will generate an icon on launch.
	vxRegisterAsSandboxEntityAttribute (string name, object category, object subCategory, int x, int y, int width, int height, EntityType EntityType=EntityType.BaseEntity)
	This tags a class as a sandbox item and allows you to explicitly set the asset path. This will generate an icon on launch.
	vxRegisterAsSandboxEntityAttribute (string name, object category, object subCategory, int x, int y, int width, int height, bool hideFromSandboxUI)
	This tags a class as a sandbox item and allows you to explicitly set the asset path. This will generate an icon on launch.

Properties
string	Name [get]
	Entity Name.
object	Category [get]
	Entity Category.
object	SubCategory [get]
	Entity Sub Category.
string	AssetPath [get]
	The Asset Path.
bool	GenerateIcon [get]
	Should it generate an icon every loop.
bool	HasSpriteSheet [get]
	If it has a sprite sheet, then a location must be specified. The sprite sheet used will be the content pack sprite sheet by default.
Rectangle	SpritesheetLocation [get]
	The sprite sheet location on the main sprite sheet.
Rectangle	IconLocation [get]
	The icon location on the content packs main sprite sheet.
EntityType	EntityType [get]
	Entity Type.
EntityAssetType	EntityAssetType [get]
	Asset Type.
bool	HideFromSandboxUI [get]
	Hide's this entity in the sandbox creation UIs.
bool	IsVisibleInSandboxList [get]
	Is this item visible in the sandbox list.

Constructor & Destructor Documentation

vxRegisterAsSandboxEntityAttribute() [1/3]

VerticesEngine.vxRegisterAsSandboxEntityAttribute.vxRegisterAsSandboxEntityAttribute	(	string	name,
		object	category,
		object	subCategory,
		string	assetPath,
		EntityType	EntityType = EntityType::BaseEntity,
		EntityAssetType	EntityAssetType = EntityAssetType::Model,
		bool	IsVisibleInSandboxList = true )

This tags a class as a sandbox item and allows you to explicitly set the asset path. This will generate an icon on launch.

Parameters

name
categoryKey
subCategory
assetPath

vxRegisterAsSandboxEntityAttribute() [2/3]

VerticesEngine.vxRegisterAsSandboxEntityAttribute.vxRegisterAsSandboxEntityAttribute	(	string	name,
		object	category,
		object	subCategory,
		int	x,
		int	y,
		int	width,
		int	height,
		EntityType	EntityType = EntityType::BaseEntity )

This tags a class as a sandbox item and allows you to explicitly set the asset path. This will generate an icon on launch.

Parameters

name
category
subCategory
x
y
width
height
EntityType

vxRegisterAsSandboxEntityAttribute() [3/3]

VerticesEngine.vxRegisterAsSandboxEntityAttribute.vxRegisterAsSandboxEntityAttribute	(	string	name,
		object	category,
		object	subCategory,
		int	x,
		int	y,
		int	width,
		int	height,
		bool	hideFromSandboxUI )

This tags a class as a sandbox item and allows you to explicitly set the asset path. This will generate an icon on launch.

Parameters

name
category
subCategory
x
y
width
height
hideFromSandboxUI

---

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

• /github/workspace/src/VerticesEngine/src.shared/Attributes/vxRegisterAsSandboxEntityAttribute.cs