ScriptComponent Class Reference

#include <ScriptComponent.hpp>

Inheritance diagram for ScriptComponent:

Public Member Functions
	ScriptComponent ()
virtual	~ScriptComponent ()
virtual void	init ()
virtual void	destroy ()
virtual void	awake () override
virtual void	tick (float deltaSecods) override
virtual void	onCollision (Actor *actor)
virtual void	onTrigger (Actor *actor)
virtual shared_ptr< Component >	clone () override
virtual shared_ptr< ComponentDescription >	getComponentDescription () override
virtual void	deserialize (shared_ptr< ComponentDescription > desc) override
Public Member Functions inherited from Component
	Component ()
virtual	~Component ()
virtual void	setActive (bool isActive)
shared_ptr< Actor >	getActor ()
void	setActor (weak_ptr< Actor > actor)

Additional Inherited Members
Protected Member Functions inherited from Component
void	setCopyMode (bool initWithData)
Protected Attributes inherited from Component
bool	initWithData
bool	isActive

Detailed Description

ScriptComponent is a Component that allows for Custom Behaviour. For example the controller of a space ship, a manager or anything that needs its own specific rules.

Constructor & Destructor Documentation

ScriptComponent::ScriptComponent

(

)

Default Constructor

ScriptComponent::~ScriptComponent ( )

virtual

Default Destructor

Member Function Documentation

virtual void ScriptComponent::awake ( )

inlineoverridevirtual

Component awake override

Reimplemented from Component.

Reimplemented in ScaleTool, PlayerScript, MoveTool, RotateHandle, RotateTool, and IncreaseColliderScript.

shared_ptr< Component > ScriptComponent::clone ( )

overridevirtual

Clones current component (Prototype Design Pattern)

Returns

shared_ptr to cloned ScriptComponent Component

Implements Component.

Reimplemented in PlayerScript.

virtual void ScriptComponent::destroy ( )

inlinevirtual

Component destroy override

Reimplemented from Component.

virtual void ScriptComponent::init ( )

inlinevirtual

Component init override

Reimplemented from Component.

Reimplemented in EditorCameraControl.

virtual void ScriptComponent::onCollision ( Actor *  actor )

inlinevirtual

Callback function called when a collision occurs

Reimplemented in PlayerScript.

virtual void ScriptComponent::onTrigger ( Actor *  actor )

inlinevirtual

Callback function called when a trigger collision occurs

Reimplemented in PlayerScript.

virtual void ScriptComponent::tick ( float  deltaSecods )

inlineoverridevirtual

Component tick override

Parameters

[in]

deltaSeconds

last frame durations

Reimplemented from Component.

Reimplemented in ScaleHandle, ScaleTool, PlayerScript, MoveHandle, RotateOverTime, AddForceScript, MoveTool, RotateHandle, EditorCameraControl, RotateTool, and IncreaseColliderScript.

---

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

• /Users/guilherme_cunha/Dev/GITHUB/GUInity/Source/ScriptComponent.hpp
• /Users/guilherme_cunha/Dev/GITHUB/GUInity/Source/ScriptComponent.cpp