GSC reference › Built-in
FindVolumeDecalIndexArray()
Built-in (engine)
Client
Gfx
Returns an array indices of a volume decal whose targetname matches the passed in string
Signature
FindVolumeDecalIndexArray(<string targetname>)
Parameters
| Name | Required? | Details |
|---|---|---|
| string targetname | Required | The targetname of the volume decal |
Example (from Treyarch's docs)
vdIndexArray = FindVolumeDecalIndexArray( "foo" )
Notes
This function is potentially very expensive to call. And, since it can directly impact frame rate due to it running on the client side, you should pre-cache the results during level init and use the results when needed rather than calling at that moment.
Real uses in BO3's scripts
Called 5 times in the decompiled scripts. A few, zombies first:
- scripts/zm/zm_island_side_ee_spore_hallucinations.csc, line 40
var_68003f28 = findvolumedecalindexarray("side_ee_horror_room_lab_a"); - scripts/zm/zm_island_side_ee_spore_hallucinations.csc, line 41
var_da07ae63 = findvolumedecalindexarray("side_ee_horror_room_lab_b"); - scripts/zm/zm_island_side_ee_spore_hallucinations.csc, line 42
var_b40533fa = findvolumedecalindexarray("side_ee_horror_room_operation"); - scripts/cp/bonuszm/_bonuszm.csc, line 147
var_9302fbfc = findvolumedecalindexarray("zombie_volume_decal"); - scripts/cp/lotus_util.csc, line 465
a_indexes = findvolumedecalindexarray(self.targetname);
Related built-ins
- FindStaticModelIndexArray()Returns an array indices of a static model whose name matches the passed in string
- HideVolumeDecal()Hide a static model
- UnhideVolumeDecal()Unhide a static model
- ArrayRemoveIndex()Remove a value from an array at a given index
- GetSnapshotIndexArray()Returns an array of the indices of current snapshots for all connected clients.
- SetUkkoScriptIndex()Set ukko index from script.
- AddBoltedFXExclusionVolume()Create a bolted volume that will exclude FX that are flagged as "Respect Exclusion Volumes".
- SetClientVolumetricFog()Set the client volumetric fog properties
- FindStaticModelIndex()Returns an index of a static model whose origin matches the passed in position
- MapMaterialIndex()Maps the material to an index
- RemoveFXExclusionVolume()Removes the given exclusion volume.
- AddFXExclusionVolume()Create a volume that will exclude FX that are flagged as "Respect Exclusion Volumes".
New to GSC?
Start with the basics, or paste a compile error to get the fix.
Built-in descriptions, parameters and examples come from Treyarch's BO3 mod tools docs. Usage links point at shiversoftdev/t7-source (decompiled BO3 scripts).