Topics
	Diag menu API definition

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

Functions
static proto native Shape	Create (ShapeType type, int color, ShapeFlags flags, vector p1, vector p2)
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 proto native Shape	CreateCylinder (int color, ShapeFlags flags, vector origin, float radius, float length)
static proto native Shape	CreateFrustum (float horizontalAngle, float verticalAngle, float length, int color, ShapeFlags flags)
static proto native Shape	CreateLines (int color, ShapeFlags flags, vector p[], int num)
static void	CreateMatrix (vector mat[4], float axisLength=0.05, float arrowSize=0.0)
static proto native Shape	CreateSphere (int color, ShapeFlags flags, vector origin, float radius)
static proto native Shape	CreateTris (int color, ShapeFlags flags, vector p[], int num)
proto native void	Destroy ()
	Cleans up the Effect, including unregistering if needed.
proto native void	GetMatrix (out vector mat[4])
proto native void	SetColor (int color)
proto native void	SetDirection (vector direction)
proto native void	SetFlags (ShapeFlags flags)
proto native void	SetMatrix (vector mat[4])
proto native void	SetPosition (vector position)
	Set the world position of the Effect.

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

Definition at line 140 of file endebug.c.

◆ ShapeFlags

enum ShapeFlags

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

Definition at line 125 of file endebug.c.

◆ ShapeType

enum ShapeType

Enumerator
BBOX
LINE
SPHERE
CYLINDER
DIAMOND
PYRAMID

Definition at line 115 of file endebug.c.

Function Documentation

◆ CanDestroy()

bool CanDestroy ( )

protected

Get whether the Effect can be destroyed right now.

Returns: bool Whether the Effect can be destroyed right now

Definition at line 269 of file effect.c.

◆ Create()

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

static

References Shape.

Referenced by CreateMatrix().

◆ CreateArrow()

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

static

Definition at line 173 of file endebug.c.

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

Referenced by CreateMatrix().

◆ CreateBridgeArrow()

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

static

Definition at line 192 of file endebug.c.

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

◆ CreateCylinder()

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

static

References Shape.

◆ CreateFrustum()

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

static

References Shape.

◆ CreateLines()

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

static

References Shape.

Referenced by CreateArrow(), and CreateBridgeArrow().

◆ CreateMatrix()

void CreateMatrix	(	vector	mat[4],
		float	axisLength = 0.05,
		float	arrowSize = 0.0 )

static

Definition at line 214 of file endebug.c.

References Create(), and CreateArrow().

◆ CreateSphere()

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

static

References Shape.

◆ CreateTris()

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

static

References Shape.

◆ 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

Definition at line 216 of file effect.c.

References CALL_CATEGORY_GAMEPLAY, DestroyDamageTriggerEx(), SEffectManager::DestroyEffect(), g_Game, IsPendingDeletion(), m_IsPendingDeletion, m_Root, OnTriggerDestroyed(), and Stop().

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

◆ GetMatrix()

proto native void GetMatrix ( out vector mat[4] )

◆ IsAutodestroy()

bool IsAutodestroy ( )

protected

Get whether Effect automatically cleans up when it stops.

Returns: bool Whether Effect automatically cleans up when it stops

Definition at line 251 of file effect.c.

References m_IsAutodestroy.

◆ IsPendingDeletion()

bool IsPendingDeletion ( )

protected

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

Returns: bool Whether the Effect is queued up for being cleaned up

Definition at line 260 of file effect.c.

References m_IsPendingDeletion.

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

◆ SetAutodestroy()

void SetAutodestroy ( bool auto_destroy )

protected

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

Definition at line 242 of file effect.c.

References m_IsAutodestroy.

◆ SetColor()

proto native void SetColor ( int color )

Referenced by InventoryItem::ReadVarsFromCTX().

◆ SetDirection()

proto native void SetDirection ( vector direction )

Referenced by IEntity::Gizmo_SetWorldTransform().

◆ SetEnableEventFrame()

void SetEnableEventFrame ( bool enable )

protected

Enable Event_OnFrameUpdate for the effect.

Note: Read SEffectManager.Event_OnFrameUpdate for more info

Definition at line 282 of file effect.c.

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

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

◆ SetFlags()

proto native void SetFlags ( ShapeFlags flags )

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

◆ 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

Definition at line 463 of file effect.c.

References m_Position.

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

Variable Documentation

◆ ErrorEx

enum ShapeType ErrorEx

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

Topics

Enumerations

Functions

Variables

Destroy

Detailed Description

Enumeration Type Documentation

◆ CollisionFlags

◆ ShapeFlags

◆ ShapeType

Function Documentation

◆ CanDestroy()

◆ Create()

◆ CreateArrow()

◆ CreateBridgeArrow()

◆ CreateCylinder()

◆ CreateFrustum()

◆ CreateLines()

◆ CreateMatrix()

◆ CreateSphere()

◆ CreateTris()

◆ Destroy()

◆ GetMatrix()

◆ IsAutodestroy()

◆ IsPendingDeletion()

◆ SetAutodestroy()

◆ SetColor()

◆ SetDirection()

◆ SetEnableEventFrame()

◆ SetFlags()

◆ SetMatrix()

◆ SetPosition()

Variable Documentation

◆ ErrorEx