sc2-gamedata
Public Attributes | List of all members
SActorDeathBodySquib Struct Reference

#include <Actor.h>

Collaboration diagram for SActorDeathBodySquib:
Collaboration graph
[legend]

Public Attributes

CActorLabelKey Name
 Name. More...
 
CActorCreateKey ActorModel
 Actor Model. More...
 
CModelLink Model
 Model. More...
 
SActorSiteOpsData ModelSiteOps
 Model Site Ops. More...
 
SAttachQuery ModelAttachQuery
 Model Attach Query. More...
 
CActorCreateKey ActorSound
 Actor Sound. More...
 
CSoundLink Sound
 Sound. More...
 
SActorSiteOpsData SoundSiteOps
 Sound Site Ops. More...
 
SAttachQuery SoundAttachQuery
 Sound Attach Query. More...
 

Detailed Description

Remarks
Struct

Member Data Documentation

◆ ActorModel

CActorCreateKey SActorDeathBodySquib::ActorModel

Actor Model.

The name of the actor that will be used to play the model associated with this body squib. This value can be overridden to customize how and when the model plays.

◆ ActorSound

CActorCreateKey SActorDeathBodySquib::ActorSound

Actor Sound.

The name of the actor that will be used to play the sound associated with this body squib. This value can be overridden to customize how and when the sound plays.

◆ Model

CModelLink SActorDeathBodySquib::Model

Model.

The model to create for this body squib. If empty, no model is created, though this is rarely done.

◆ ModelAttachQuery

SAttachQuery SActorDeathBodySquib::ModelAttachQuery

Model Attach Query.

Used to control which attachment points play a body squib model. The Heart of the Swarm ragdoll deaths typically use Damage attach points for this.

◆ ModelSiteOps

SActorSiteOpsData SActorDeathBodySquib::ModelSiteOps

Model Site Ops.

Used to customize the position and rotation of the body squib model.

◆ Name

CActorLabelKey SActorDeathBodySquib::Name

Name.

The name of the body squib specified by this field and its sibling data. Makes it easy for custom deaths to share body squibs without duplicating data repeatedly.

◆ Sound

CSoundLink SActorDeathBodySquib::Sound

Sound.

The sound to play with this body squib. If empty, no sound plays. If this value is set, but SoundSiteOps and SoundAttachQuery are left empty, then a sound is created for and hosted off of each body squib model.

◆ SoundAttachQuery

SAttachQuery SActorDeathBodySquib::SoundAttachQuery

Sound Attach Query.

Used to control which attachment points play a body squib sound. It is often sufficient to simply play one on the Center attachment point. This is not exact for gib-style ragdolls where pieces fly everywhere, because the player might see a body part with a body squib model that does not have an associated sound, and conversely, he might see a body part with no body squib that plays a body squib sound. But in most cases it fairly accurate and it is hard to notice when it is not, so this technique is typically good enough.

◆ SoundSiteOps

SActorSiteOpsData SActorDeathBodySquib::SoundSiteOps

Sound Site Ops.

Used to customize the position of the body squib sound.


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