server.baseentityoptions.md

Home > server > BaseEntityOptions

BaseEntityOptions interface

The base options for an entity.

Signature:

export interface BaseEntityOptions 

Properties

Property	Modifiers	Type	Description
controller?		BaseEntityController	(Optional) The entity controller to use for the entity.
name?		string	(Optional) The name of the entity.
opacity?		number	(Optional) The opacity of the entity between 0 and 1. 0 is fully transparent, 1 is fully opaque.
parent?		Entity	(Optional) The parent entity of the entity, entities with a parent will ignore creating their own colliders.
parentNodeName?		string	(Optional) The name of the parent's node (if parent is a model entity) to attach the entity to.
rigidBodyOptions?		RigidBodyOptions	(Optional) The rigid body options for the entity.
tag?		string	(Optional) An arbitrary identifier tag of the entity. Useful for your own logic.
tintColor?		RgbColor	(Optional) The tint color of the entity as a hex code.