SCR_ParticleSpawnable Interface Reference

Inheritance diagram for SCR_ParticleSpawnable:

Public Member Functions
void	GetPositionAndRotation (out notnull array< vector > positionAndRotation)
override bool	CompareAttributes (SCR_BaseSpawnable other)
	Returns true when attributes are the same Returns false otherwise.
override void	SetVariables (WorldEditorAPI api, IEntitySource source, array< ref ContainerIdPathEntry > path, int index)
override bool	CreateObject (WorldEditorAPI api, IEntitySource source, array< ref ContainerIdPathEntry > path, int index)
ParticleEffectEntity	SpawnAsChild (IEntity owner, SCR_HitInfo hitInfo, bool snapToTerrain=false)
override ParticleEffectEntity	Spawn (IEntity owner, Physics parentPhysics, SCR_HitInfo hitInfo, bool snapToTerrain=false)
	Spawns the object.
Public Member Functions inherited from SCR_BaseSpawnable
bool	AlreadyExists (WorldEditorAPI api, IEntitySource source, 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.

Public Attributes
ResourceName	m_Particle
bool	m_bAtCenter
bool	m_bDirectional

Additional Inherited Members
Protected Attributes inherited from SCR_BaseSpawnable
vector	m_vOffsetPosition
vector	m_vOffsetRotation

Member Function Documentation

CompareAttributes()

override bool SCR_ParticleSpawnable.CompareAttributes

(

SCR_BaseSpawnable

other

)

Returns true when attributes are the same Returns false otherwise.

Implements SCR_BaseSpawnable.

Implemented in SCR_RandomParticleSpawnable.

CreateObject()

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

Implements SCR_BaseSpawnable.

Implemented in SCR_RandomParticleSpawnable.

GetPositionAndRotation()

void SCR_ParticleSpawnable.GetPositionAndRotation

(

out notnull array< vector >

positionAndRotation

)

SetVariables()

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

Implements SCR_BaseSpawnable.

Implemented in SCR_RandomParticleSpawnable.

Spawn()

override ParticleEffectEntity SCR_ParticleSpawnable.Spawn	(	IEntity	owner,
		Physics	parentPhysics,
		SCR_HitInfo	hitInfo,
		bool	snapToTerrain = false )

Spawns the object.

Implements SCR_BaseSpawnable.

Implemented in SCR_RandomParticleSpawnable.

SpawnAsChild()

ParticleEffectEntity SCR_ParticleSpawnable.SpawnAsChild	(	IEntity	owner,
		SCR_HitInfo	hitInfo,
		bool	snapToTerrain = false )

Member Data Documentation

m_bAtCenter

bool SCR_ParticleSpawnable.m_bAtCenter

m_bDirectional

bool SCR_ParticleSpawnable.m_bDirectional

m_Particle

ResourceName SCR_ParticleSpawnable.m_Particle

---

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

• Game/Destruction/SCR_ParticleSpawnable.c