WorldObjectScript Class Reference

#include "WorldObjectScript.h"

Inheritance diagram for WorldObjectScript:

Public Member Functions
bool	IsDatabaseBound () const override
virtual void	OnWorldObjectDestroy (WorldObject *)
	This hook called before destroy world object. More...
virtual void	OnWorldObjectCreate (WorldObject *)
	This hook called after create world object. More...
virtual void	OnWorldObjectSetMap (WorldObject *, Map *)
	This hook called after world object set to map. More...
virtual void	OnWorldObjectResetMap (WorldObject *)
	This hook called after world object reset. More...
virtual void	OnWorldObjectUpdate (WorldObject *, uint32)
	This hook called after world object update. More...
Public Member Functions inherited from ScriptObject
virtual bool	IsDatabaseBound () const
virtual bool	isAfterLoadScript () const
virtual void	checkValidity ()
const std::string &	GetName () const
uint16	GetTotalAvailableHooks ()

Protected Member Functions
	WorldObjectScript (const char *name, std::vector< uint16 > enabledHooks=std::vector< uint16 >())
Protected Member Functions inherited from ScriptObject
	ScriptObject (const char *name, uint16 totalAvailableHooks=0)
virtual	~ScriptObject ()=default

Detailed Description

Constructor & Destructor Documentation

WorldObjectScript()

WorldObjectScript::WorldObjectScript ( const char *  name, std::vector< uint16 >  enabledHooks = std::vector<uint16>()  )

protected

    : ScriptObject(name, WORLDOBJECTHOOK_END)
{
    // If empty - enable all available hooks.
    if (enabledHooks.empty())
        for (uint16 i = 0; i < WORLDOBJECTHOOK_END; ++i)
            enabledHooks.emplace_back(i);
 
    ScriptRegistry<WorldObjectScript>::AddScript(this, std::move(enabledHooks));
}

References ScriptRegistry< TScript >::AddScript(), and WORLDOBJECTHOOK_END.

Member Function Documentation

IsDatabaseBound()

bool WorldObjectScript::IsDatabaseBound ( ) const

inlineoverridevirtual

Reimplemented from ScriptObject.

{ return false; }

OnWorldObjectCreate()

virtual void WorldObjectScript::OnWorldObjectCreate ( WorldObject *  )

inlinevirtual

This hook called after create world object.

Parameters

object

Contains information about the WorldObject

{ }

OnWorldObjectDestroy()

virtual void WorldObjectScript::OnWorldObjectDestroy ( WorldObject *  )

inlinevirtual

This hook called before destroy world object.

Parameters

object

Contains information about the WorldObject

{ }

OnWorldObjectResetMap()

virtual void WorldObjectScript::OnWorldObjectResetMap ( WorldObject *  )

inlinevirtual

This hook called after world object reset.

Parameters

object

Contains information about the WorldObject

{ }

OnWorldObjectSetMap()

virtual void WorldObjectScript::OnWorldObjectSetMap ( WorldObject *  , Map *    )

inlinevirtual

This hook called after world object set to map.

Parameters

object

Contains information about the WorldObject

{ }

OnWorldObjectUpdate()

virtual void WorldObjectScript::OnWorldObjectUpdate ( WorldObject *  , uint32    )

inlinevirtual

This hook called after world object update.

Parameters

object	Contains information about the WorldObject
diff	Contains information about the diff time

{ }