SCR_BaseSpawnable Interface Reference

Inheritance diagram for SCR_BaseSpawnable:

Public Member Functions
void	SetVariables (WorldEditorAPI api, IEntitySource source, array< ref ContainerIdPathEntry > path, int index)
bool	CompareAttributes (SCR_BaseSpawnable other)
bool	AlreadyExists (WorldEditorAPI api, IEntitySource source, int index)
bool	CreateObject (WorldEditorAPI api, IEntitySource source, array< ref ContainerIdPathEntry > path, int index)
void	CopyToSource (WorldEditorAPI api, IEntitySource source, array< ref ContainerIdPathEntry > path, int index, string currentObjectName)
void	GetSpawnTransform (IEntity owner, out vector outMat[4], bool localCoords=false)
	Calculates the spawn tranformation matrix for the object.
IEntity	Spawn (IEntity owner, Physics parentPhysics, SCR_HitInfo hitInfo, bool snapToTerrain=false)
	Spawns the object.

Protected Attributes
vector	m_vOffsetPosition
vector	m_vOffsetRotation

Member Function Documentation

AlreadyExists()

bool SCR_BaseSpawnable.AlreadyExists	(	WorldEditorAPI	api,
		IEntitySource	source,
		int	index
	)

Parameters

[in]	api
[in]	source
[in]	index

Returns

CompareAttributes()

bool SCR_BaseSpawnable.CompareAttributes

(

SCR_BaseSpawnable

other

)

Parameters

[in]

other

Returns

true when attributes are the same, false otherwise

Implemented in SCR_DebrisSpawnable, SCR_PrefabSpawnable, and SCR_ParticleSpawnable.

CopyToSource()

void SCR_BaseSpawnable.CopyToSource	(	WorldEditorAPI	api,
		IEntitySource	source,
		array< ref ContainerIdPathEntry >	path,
		int	index,
		string	currentObjectName
	)

Parameters

[in]	api
[in]	source
[in]	path
[in]	index
[in]	currentObjectName

CreateObject()

bool SCR_BaseSpawnable.CreateObject	(	WorldEditorAPI	api,
		IEntitySource	source,
		array< ref ContainerIdPathEntry >	path,
		int	index
	)

Parameters

[in]	api
[in]	source
[in]	path
[in]	index

Returns

Implemented in SCR_DebrisSpawnable, SCR_PrefabSpawnable, and SCR_ParticleSpawnable.

GetSpawnTransform()

void SCR_BaseSpawnable.GetSpawnTransform	(	IEntity	owner,
		out vector	outMat[4],
		bool	localCoords = false
	)

Calculates the spawn tranformation matrix for the object.

Parameters

[in]	owner
[out]	outMat
[in]	localCoords

SetVariables()

void SCR_BaseSpawnable.SetVariables	(	WorldEditorAPI	api,
		IEntitySource	source,
		array< ref ContainerIdPathEntry >	path,
		int	index
	)

Parameters

[in]	api
[in]	source
[in]	path
[in]	index

Implemented in SCR_DebrisSpawnable, SCR_PrefabSpawnable, and SCR_ParticleSpawnable.

Spawn()

IEntity SCR_BaseSpawnable.Spawn	(	IEntity	owner,
		Physics	parentPhysics,
		SCR_HitInfo	hitInfo,
		bool	snapToTerrain = false
	)

Spawns the object.

Parameters

[in]	owner
[in]	parentPhysics
[in]	hitInfo
[in]	snapToTerrain

Returns

Implemented in SCR_DebrisSpawnable, SCR_PrefabSpawnable, and SCR_ParticleSpawnable.

Member Data Documentation

m_vOffsetPosition

vector SCR_BaseSpawnable.m_vOffsetPosition

protected

m_vOffsetRotation

vector SCR_BaseSpawnable.m_vOffsetRotation

protected

---

The documentation for this interface was generated from the following file:

• Game/Destruction/SCR_DestructionDamageManagerComponent.c