Debug Shape API definition

Modules
	Diag menu API definition

Enumerations
enum	ShapeType {   BBOX , LINE , SPHERE , CYLINDER ,   DIAMOND , PYRAMID }
enum	ShapeFlags {   NOZBUFFER , NOZWRITE , WIREFRAME , TRANSP ,   DOUBLESIDE , ONCE , NOOUTLINE , BACKFACE ,   NOCULL , VISIBLE , ADDITIVE }
enum	CollisionFlags

Functions
proto native void	GetMatrix (out vector mat[4])
proto native void	SetMatrix (vector mat[4])
proto native void	SetDirection (vector direction)
proto native void	SetPosition (vector position)
	Set the world position of the Effect.
proto native void	SetColor (int color)
proto native void	SetFlags (ShapeFlags flags)
proto native void	Destroy ()
	Cleans up the Effect, including unregistering if needed.
static proto native Shape	Create (ShapeType type, int color, ShapeFlags flags, vector p1, vector p2)
static proto native Shape	CreateLines (int color, ShapeFlags flags, vector p[], int num)
static proto native Shape	CreateTris (int color, ShapeFlags flags, vector p[], int num)
static proto native Shape	CreateSphere (int color, ShapeFlags flags, vector origin, float radius)
static proto native Shape	CreateFrustum (float horizontalAngle, float verticalAngle, float length, int color, ShapeFlags flags)
static proto native Shape	CreateCylinder (int color, ShapeFlags flags, vector origin, float radius, float length)
static Shape	CreateArrow (vector from, vector to, float size, int color, ShapeFlags flags)
static Shape	CreateBridgeArrow (vector from, vector to, float size, int color, ShapeFlags flags)
static void	CreateMatrix (vector mat[4])

Variables
enum ShapeType	ErrorEx

Destroy
Methods regarding automatic cleanup
void	SetAutodestroy (bool auto_destroy)
	Sets whether Effect automatically cleans up when it stops.
bool	IsAutodestroy ()
	Get whether Effect automatically cleans up when it stops.
bool	IsPendingDeletion ()
	Get whether the Effect is queued up for being cleaned up.
bool	CanDestroy ()
	Get whether the Effect can be destroyed right now.
void	SetEnableEventFrame (bool enable)
	Enable Event_OnFrameUpdate for the effect.

Detailed Description

Enumeration Type Documentation

CollisionFlags

enum CollisionFlags

ShapeFlags

enum ShapeFlags

Enumerator
NOZBUFFER
NOZWRITE
WIREFRAME
TRANSP
DOUBLESIDE
ONCE
NOOUTLINE
BACKFACE
NOCULL
VISIBLE
ADDITIVE

ShapeType

enum ShapeType

Enumerator
BBOX
LINE
SPHERE
CYLINDER
DIAMOND
PYRAMID

Function Documentation

CanDestroy()

bool CanDestroy

(

)

Get whether the Effect can be destroyed right now.

Returns

bool Whether the Effect can be destroyed right now

Create()

static proto native Shape Create ( ShapeType  type, int  color, ShapeFlags  flags, vector  p1, vector  p2  )

static

Referenced by CreateMatrix().

CreateArrow()

static Shape CreateArrow ( vector  from, vector  to, float  size, int  color, ShapeFlags  flags  )

static

References CreateLines(), vector::Normalize(), and vector::Perpend().

CreateBridgeArrow()

static Shape CreateBridgeArrow ( vector  from, vector  to, float  size, int  color, ShapeFlags  flags  )

static

References CreateLines(), vector::Normalize(), vector::Perpend(), and Vector().

CreateCylinder()

static proto native Shape CreateCylinder ( int  color, ShapeFlags  flags, vector  origin, float  radius, float  length  )

static

CreateFrustum()

static proto native Shape CreateFrustum ( float  horizontalAngle, float  verticalAngle, float  length, int  color, ShapeFlags  flags  )

static

CreateLines()

static proto native Shape CreateLines ( int  color, ShapeFlags  flags, vector  p[], int  num  )

static

Referenced by CreateArrow(), and CreateBridgeArrow().

CreateMatrix()

static void CreateMatrix ( vector  mat[4] )

static

References Create().

CreateSphere()

static proto native Shape CreateSphere ( int  color, ShapeFlags  flags, vector  origin, float  radius  )

static

CreateTris()

static proto native Shape CreateTris ( int  color, ShapeFlags  flags, vector  p[], int  num  )

static

Destroy()

proto native void Destroy

(

)

Cleans up the Effect, including unregistering if needed.

Note

Will stop the Effect and queue up the deletion in the callqueue

Is intended for usage from within the Effect itself, use SEffectManager.DestroyEffect when working from a pointer

Cleans up the Effect, including unregistering if needed.

References ScriptCallQueue::Call(), CALL_CATEGORY_GAMEPLAY, DestroyDamageTriggerEx(), SEffectManager::DestroyEffect(), CGame::GetCallQueue(), GetGame(), IsPendingDeletion(), m_IsPendingDeletion, AreaDamageEvents::OnTriggerDestroyed(), and Stop().

Referenced by EntityLightSource::CheckLifetime(), EntityLightSource::HandleBrightnessFadeing(), EntityLightSource::HandleRadiusFadeing(), and ~AreaDamageManager().

GetMatrix()

proto native void GetMatrix

(

out vector

mat[4]

)

IsAutodestroy()

bool IsAutodestroy

(

)

Get whether Effect automatically cleans up when it stops.

Returns

bool Whether Effect automatically cleans up when it stops

References m_IsAutodestroy.

IsPendingDeletion()

bool IsPendingDeletion

(

)

Get whether the Effect is queued up for being cleaned up.

Returns

bool Whether the Effect is queued up for being cleaned up

References m_IsPendingDeletion.

Referenced by Destroy(), Entity::IsSetForDeletion(), and EffectSound::SoundStop().

SetAutodestroy()

void SetAutodestroy

(

bool

auto_destroy

)

Sets whether Effect automatically cleans up when it stops.

Note

This means that it will be unregistered from SEffectManager as well

Parameters

auto_destroy

bool Whether Effect automatically cleans up when it stops

References m_IsAutodestroy.

SetColor()

proto native void SetColor

(

int

color

)

Referenced by InventoryItem::ReadVarsFromCTX().

SetDirection()

proto native void SetDirection

(

vector

direction

)

SetEnableEventFrame()

void SetEnableEventFrame

(

bool

enable

)

Enable Event_OnFrameUpdate for the effect.

Note

Read SEffectManager.Event_OnFrameUpdate for more info

References Event_OnFrameUpdate(), SEffectManager::Event_OnFrameUpdate, ScriptInvoker::Insert(), and ScriptInvoker::Remove().

Referenced by EffEngineSmoke::EffEngineSmoke(), EffectSound::UpdateEvents(), and ~Effect().

SetFlags()

proto native void SetFlags

(

ShapeFlags

flags

)

Referenced by DayZCreature::DayZCreatureAI(), DynamicArea_Flare::DynamicArea_Flare(), EasterEgg(), EntityAI::Man(), Particle::ParticleInit(), and Trigger::Trigger().

SetMatrix()

proto native void SetMatrix

(

vector

mat[4]

)

SetPosition()

proto native void SetPosition

(

vector

pos

)

Set the world position of the Effect.

Warning

Only sets the cached variable, for immediate effect use SetCurrent variant

Parameters

pos	vector The world position for the Effect

References m_Position.

Referenced by Particle::AddAsChild(), EntityLightSource::AttachOnObject(), ScriptedWidgetEventHandler::CreateFollowedObject(), DynamicArea_Flare::EOnFrame(), DayZSpectator::EOnFrame(), BoatScript::FlipVehicle(), ScriptedWidgetEventHandler::GetPosition(), EntityLightSource::HandleDancingShadows(), PointLightBase::OnFrameLightSource(), OnPlacementComplete(), ManBase::OnStoreLoad(), ItemBase::PlaceOnGround(), SetCurrentPosition(), TrapSpawnBase::SetupTrap(), SetupTrapPlayer(), ItemBase::SetupTrapPlayer(), Particle::StopParticle(), and UnlockServer().

Variable Documentation

ErrorEx

enum ShapeType ErrorEx

Referenced by DimmingConfig::AddDimmingPattern(), AddModifier(), And(), ScriptedWidgetEventHandler::Apply(), GameInventory::AreChildrenAccessible(), Assert(), EntityLightSource::AttachOnMemoryPoint(), Entity::AttemptDestructionBehaviour(), WeaponParticlesBase::CheckParticleOverride(), SEffectManager::Cleanup(), ConstructData(), EmoteConstructor::ConstructEmotes(), CreateBleedingEffect(), Particle::CreateParticleEffect(), ParticleSource::CreateParticleEffect(), CreateParticleEx(), ParticleSource::CreateParticleEx(), CreateResultDataStructure(), CreditsLoader::CreateTestJson(), Weapon::CreateWeaponWithAmmo(), StaminaHandler::DepleteStaminaEx(), ParticleSource::DestroyParticleEffect(), array< Class T >::DifferentAtPosition(), Effect(), SEffectManager::EffectRegister(), EmoteBase::EmoteFBStanceCheck(), ParticleSource::EOnFrame(), MenuDefaultCharacterData::EquipDefaultCharacter(), ImpactMaterials::EvaluateImpactEffect(), Math::Factorial(), Ammunition_Base::GetAmmoWeightByBulletType(), FireworksLauncher::GetColorSequence(), GetControlMappingInfo(), UIScriptedMenu::GetControlMappingInfo(), DayZPlayerCameraBase::GetCurrentSightInfo(), HitDirectionEffectBase::GetCurrentType(), Weapon_Base::GetCylinderRotation(), CreditsLoader::GetData(), DlcDataLoader::GetData(), UndergroundAreaLoader::GetData(), EffectAreaLoader::GetData(), UIScriptedMenu::GetData(), JsonMissionLoaderData::GetData(), FireworksLauncherClientEvent::GetExplParticleFromSequence(), AnniversaryFireworksLauncherClientEvent::GetExplParticleFromSequence(), GetLastClientMessage(), GetLastServerMessage(), GetLightPosition(), WorldData::GetLiquidTypeEnviroTemperature(), GetMemoryPointPosition(), Weapon::GetMuzzleStates(), ParticleList::GetParticleID(), ParticleList::GetParticleIDByName(), ParticleList::GetParticlePath(), GameplayEffectsData::GetProbabilities(), DayZProfilesOptions::GetProfileOptionDefaultBool(), DayZProfilesOptions::GetProfileOptionDefaultFloat(), DayZProfilesOptions::GetProfileOptionDefaultInt(), GetStringVariant(), Hologram::Hologram(), ScriptedWidgetEventHandler::Init(), Init(), InitCatchingItemData(), BleedChanceData::InitInfectedChanceMap(), CatchingContextTrapsBase::InitItemValues(), BleedChanceData::InitMeleeChanceMap(), Interact(), Hologram::IsBehindObstacle(), IsFacingFireplace(), IsParticlePlaying(), JsonFileLoader< Class T >::JsonLoadData(), JsonFileLoader< Class T >::JsonLoadFile(), LoadConfig(), ScriptedWidgetEventHandler::LoadContentList(), CfgGameplayHandler::LoadData(), CfgPlayerRestrictedAreaHandler::LoadData(), PlayerSpawnHandler::LoadData(), ScriptedWidgetEventHandler::LoadFilters(), NotificationSystem::LoadNotificationData(), LoadPlayerAttachmentIndexes(), AmmoTypesAPI::MagazineTypeToAmmoType(), WeaponParticlesBase::OnActivate(), ParticleSource::OnCheckAutoDelete(), MissionBase::OnClientNewEvent(), OnErrorThrown(), ActionDigInStash::OnFinishProgressServer(), OnFinishProgressServer(), ActionUnrestrainTargetHands::OnFinishProgressServer(), OnInit(), InventoryItem::OnQuantityChanged(), CfgGameplayHandler::OnRPC(), CfgPlayerRestrictedAreaHandler::OnRPC(), UndergroundAreaLoader::OnRPC(), CGame::OnRPC(), OnStoreLoadCustom(), OnStoreSave(), ParticleSource::OnToDelete(), Or(), PlayEmote(), SEffectManager::PlayOnObject(), PlayParticle(), DestructionEffectBase::PlayParticle(), PlayParticleEx(), IEntity::PlaySoundSetAtMemoryPoint(), HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::RandomizeFSMStateEx(), InventoryLocation::ReadFromContext(), GameplayEffectsData::RegisterData(), ParticleList::RegisterParticle(), ParticleList::RegisterParticleByFullPath(), SymptomManager::RegisterSymptom(), ScriptConsoleCameraTab::ReloadDOFPresetsList(), ReloadWeatherPresetsList(), UIScriptedMenu::ResetAll(), ResetParticle(), RestartParticle(), CatchingResultBase::RollChanceSeeded(), TFModule::Run(), array::Run(), UIScriptedMenu::SaveData(), ScriptedWidgetEventHandler::SaveFilters(), Entity::SetAttachmentExclusionMaskSlot(), ManBase::SetHairLevelToHide(), CAContinuousRepeatFishing::SetNewSignalData(), YieldItemBase::SetRegistrationIdx(), SetupInitialTypes(), FireworksLauncherClientEvent::SetupLight(), AnniversaryFireworksLauncherClientEvent::SetupLight(), SetupProbabilityArray(), ItemOptics::ShowReddot(), EffectSound::SoundError(), SpawnAndSetupCatch(), Weapon::SpawnAttachedMagazine(), ObjectSpawnerHandler::SpawnObjects(), SpawnDataConverter::SpawnObjects(), SymptomManager::SpawnSymptom(), AutotestRunner::Start(), SEffectManager::Stop(), StopParticle(), ClientData::SyncEvent_PreprocessPlayerList(), EnProfilerTests::TestFuncCountData(), ScriptedWidgetEventHandler::TutorialKeybinds(), Land_WarheadStorage_PowerStation::UnregisterBunker(), UnregisterEntrance(), UnregisterPanel(), ParticleSource::UpdateState(), CatchingContextTrapsBase::UpdateUsedBait(), ValidateMuzzleArray(), EffectSound::ValidateSoundWave(), and WeaponParticlesBase::WeaponParticlesBase().