dp88_buildingScripts_functionSpawnZone Class Reference

Building Function - Spawn Zone. More...

#include <dp88_buildingScripts.h>

Public Member Functions
void	OnBuildingOffline (GameObject *obj)
void	OnBuildingOnline (GameObject *obj)
void	OnBuildingDestroyed (GameObject *obj)

Additional Inherited Members
Protected Member Functions inherited from dp88_buildingScripts_baseClass
GameObject *	RegisterWithParent (GameObject *obj, const char *preset_name, int type)
void	Custom (GameObject *obj, int type, int param, GameObject *sender)
virtual void	OnCustom (GameObject *obj, int type, int param, GameObject *sender)
virtual void	OnBuildingCaptured (GameObject *obj, int team)
Protected Attributes inherited from dp88_buildingScripts_baseClass
int	m_parentId

Detailed Description

Author

Daniel Paul (danpa.nosp@m.ul88.nosp@m.@yaho.nosp@m.o.co.nosp@m..uk)

Spawns a script zone at the location of the object this script is attached to and, optionally, destroys the zone when the parent building is offline and/or destroyed. This can be used to proxy script zones into the correct locations using Daves Arrow type presets with this script.

Parameters

Building_Controller_Preset	Name of the preset to which the controller script for this building is attached. Note that if there are multiple copies of this preset on the map the script will use the closest instance as its parent.
scriptZonePreset	Name of the script zone preset to be spawned
scriptZoneSize	The size of the script zone in the + and - directions on each axis, so a size of 1x1x2 will create a 2x2x4 script zone centered on the object this script is attached to
destroyZoneWhenDisabled	Whether to destroy the spawned script zone when the parent building is offline. It will be created again when the building comes back online. 1 to enable, 0 to disable
destroyZoneWhenDestroyed	Whether to destroy the spawned script zone when the parent building is destroyed. 1 to enable, 0 to disable

Member Function Documentation

OnBuildingDestroyed()

void dp88_buildingScripts_functionSpawnZone::OnBuildingDestroyed ( GameObject * obj )

virtual

Event function called when the building has been destroyed

Reimplemented from dp88_buildingScripts_baseClass.

OnBuildingOffline()

void dp88_buildingScripts_functionSpawnZone::OnBuildingOffline ( GameObject * obj )

virtual

Event function called when the building enters the "offline" state

Reimplemented from dp88_buildingScripts_baseClass.

OnBuildingOnline()

void dp88_buildingScripts_functionSpawnZone::OnBuildingOnline ( GameObject * obj )

virtual

Event function called when the building enters the "online" state

Reimplemented from dp88_buildingScripts_baseClass.