Actor

Description

The Actor is the main class of the ECS, it corresponds to the entity and is composed of componenents and behaviours (scripts)

• C++ related class: OvCore::ECS::Actor

Variables

This usertype has no variables

Constructors

This usertype has no constructors

Functions

Name	Input	Output	Description
GetName	Actor: instance	string	Returns the name of the actor
SetName	Actor: instance string: name		Defines a name for the actor
GetTag	Actor: instance	string	Returns the tag of the actor
GetChildren	Actor: instance	Actor[]	Returns children of this actor
SetTag	Actor: instance	string	Defines a tag for the actor
GetID	Actor: instance	number	Returns the ID of this actor
GetParent	Actor: instance	Actor	Returns the parent (or nil) of this actor
SetParent	Actor: instance Actor: newParent		Defines a new parent to this actor
DetachFromParent	Actor: instance		Detaches the actor from its parent
IsDescendantOf	Actor: instance Actor: otherActor	boolean	Returns true if the otherActor is the topmost parent of the instance in the hierarchy
Destroy	Actor: instance		Removes the actor from the scene
IsSelfActive	Actor: instance	boolean	Returns true if the actor is active, ignoring his parent (if any) active state
IsActive	Actor: instance	boolean	Returns true if the actor is active
SetActive	Actor: instance boolean: active		Defines if the actor is active
GetTransform	Actor: instance	Transform	Returns the Transform attached to this actor
GetPhysicalObject	Actor: instance	PhysicalObject	Returns the PhysicalObject attached to this actor (If any)
GetPhysicalBox	Actor: instance	PhysicalBox	Returns the PhysicalBox attached to this actor (If any)
GetPhysicalSphere	Actor: instance	PhysicalSphere	Returns the PhysicalSphere attached to this actor (If any)
GetPhysicalCapsule	Actor: instance	PhysicalCapsule	Returns the PhysicalCapsule attached to this actor (If any)
GetCamera	Actor: instance	Camera	Returns the Camera attached to this actor (If any)
GetLight	Actor: instance	Light	Returns the Light attached to this actor (If any)
GetPointLight	Actor: instance	PointLight	Returns the PointLight attached to this actor (If any)
GetSpotLight	Actor: instance	SpotLight	Returns the SpotLight attached to this actor (If any)
GetDirectionalLight	Actor: instance	DirectionalLight	Returns the DirectionalLight attached to this actor (If any)
GetAmbientBoxLight	Actor: instance	AmbientBoxLight	Returns the AmbientBoxLight attached to this actor (If any)
GetAmbientSphereLight	Actor: instance	AmbientSphereLight	Returns the AmbientSphereLight attached to this actor (If any)
GetModelRenderer	Actor: instance	ModelRenderer	Returns the ModelRenderer attached to this actor (If any)
GetMaterialRenderer	Actor: instance	MaterialRenderer	Returns the MaterialRenderer attached to this actor (If any)
GetAudioSource	Actor: instance	AudioSource	Returns the AudioSource attached to this actor (If any)
GetAudioListener	Actor: instance	AudioListener	Returns the AudioListener attached to this actor (If any)
GetPostProcessStack	Actor: instance	PostProcessStack	Returns the PostProcessStack attached to this actor (If any)
GetReflectionProbe	Actor: instance	ReflectionProbe	Returns the ReflectionProbe attached to this actor (If any)
GetBehaviour	Actor: instance string: behaviour	Usertype	Returns the Behaviour of the given type attached to this actor (If any)
AddTransform	Actor: instance	Transform	Adds a Transform component to the actor and returns it
AddModelRenderer	Actor: instance	ModelRenderer	Adds a ModelRenderer component to the actor and returns it
AddPhysicalBox	Actor: instance	PhysicalBox	Adds a PhysicalBox component to the actor and returns it
AddPhysicalSphere	Actor: instance	PhysicalSphere	Adds a PhysicalSphere component to the actor and returns it
AddPhysicalCapsule	Actor: instance	PhysicalCapsule	Adds a PhysicalCapsule component to the actor and returns it
AddCamera	Actor: instance	Camera	Adds a Camera component to the actor and returns it
AddPointLight	Actor: instance	PointLight	Adds a PointLight component to the actor and returns it
AddSpotLight	Actor: instance	SpotLight	Adds a SpotLight component to the actor and returns it
AddDirectionalLight	Actor: instance	DirectionalLight	Adds an DirectionalLight component to the actor and returns it
AddAmbientBoxLight	Actor: instance	AmbientBoxLight	Adds an AmbientBoxLight component to the actor and returns it
AddAmbientSphereLight	Actor: instance	AmbientSphereLight	Adds an AmbientSphereLight component to the actor and returns it
AddMaterialRenderer	Actor: instance	MaterialRenderer	Adds a MaterialRenderer component to the actor and returns it
AddAudioSource	Actor: instance	AudioSource	Adds an AudioSource component to the actor and returns it
AddAudioListener	Actor: instance	AudioListener	Adds an AudioListener component to the actor and returns it
AddPostProcessStack	Actor: instance	PostProcessStack	Adds a PostProcessStack component to the actor and returns it
AddReflectionProbe	Actor: instance	ReflectionProbe	Adds an ReflectionProbe component to the actor and returns it
AddBehaviour	Actor: instance	Usertype	Adds a behaviour of given type to the actor and returns it
RemoveModelRenderer	Actor: instance	boolean	Removes the ModelRenderer component from the actor (Returns true of success)
RemovePhysicalBox	Actor: instance	boolean	Removes the PhysicalBox component from the actor (Returns true of success)
RemovePhysicalSphere	Actor: instance	boolean	Removes the PhysicalSphere component from the actor (Returns true of success)
RemovePhysicalCapsule	Actor: instance	boolean	Removes the PhysicalCapsule component from the actor (Returns true of success)
RemoveCamera	Actor: instance	boolean	Removes the Camera component from the actor (Returns true of success)
RemovePointLight	Actor: instance	boolean	Removes the PointLight component from the actor (Returns true of success)
RemoveSpotLight	Actor: instance	boolean	Removes the SpotLight component from the actor (Returns true of success)
RemoveDirectionalLight	Actor: instance	boolean	Removes the DirectionalLight component from the actor (Returns true of success)
RemoveAmbientBoxLight	Actor: instance	boolean	Removes the AmbientBoxLight component from the actor (Returns true of success)
RemoveAmbientSphereLight	Actor: instance	boolean	Removes the AmbientSphereLight component from the actor (Returns true of success)
RemoveMaterialRenderer	Actor: instance	boolean	Removes the MaterialRenderer component from the actor (Returns true of success)
RemoveAudioSource	Actor: instance	boolean	Removes the AudioSource component from the actor (Returns true of success)
RemoveAudioListener	Actor: instance	boolean	Removes the AudioListener component from the actor (Returns true of success)
RemovePostProcessStack	Actor: instance	PostProcessStack	Removes the PostProcessStack component from the actor (Returns true of success)
RemoveReflectionProbe	Actor: instance	ReflectionProbe	Removes the ReflectionProbe component from the actor (Returns true of success)
RemoveBehaviour	Actor: instance string: behaviour	boolean	Removes the behaviour of given type (Returns true on success)

Operators

This usertype has no operators