Debug Shape API definition

Collaboration diagram for Debug Shape API definition:

Topics
	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

Definition at line 140 of file EnDebug.c.

{
  FIRSTCONTACT, //<In many cases only collided=true/false is enough
  NEARESTCONTACT //<We want only one, the nearest contact
  ONLYSTATIC //<Only static objects
  ONLYDYNAMIC //<Only dynamic objects
  ONLYWATER //<Only water components (legacy support for "walk on geometry")
  ALLOBJECTS //<Valid when CF_FIRST_CONTACT, we get first contact for each object
}

ShapeFlags

enum ShapeFlags

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

Definition at line 125 of file EnDebug.c.

{
  NOZBUFFER, //< Do not compare z-buffer when render
  NOZWRITE, //< Do not update z-buffer when render
  WIREFRAME, //< Render just wire-frame outline. No solid faces
  TRANSP, //< Is translucent
  DOUBLESIDE, //< Double-sided (do not cull back-faces)
  ONCE, //< Rendered just once and then it's automatically destroyed. Do not keep pointer to these!!
  NOOUTLINE, //< Render just solid faces. No wire-frame outline.
  BACKFACE, //< Render just back faces
  NOCULL, //< Do not cull shapes by view frustum
  VISIBLE, //< Make it visible. Set by default
  ADDITIVE //< Additive blending (works with ShapeFlags.TRANSP)
};

ShapeType

enum ShapeType

Enumerator
BBOX
LINE
SPHERE
CYLINDER
DIAMOND
PYRAMID

Definition at line 115 of file EnDebug.c.

{
  BBOX, //< Just box
  LINE, //< One or more lines
  SPHERE, //< Sphere represented by triangle mesh
  CYLINDER, //< Cylinder represented by triangle mesh
  DIAMOND, //< Eight faced pyramid. Defined by bound-box, where middle part is  equal to horizontal extents of box and top/bottom apogees lies on top/bottom side of box.
  PYRAMID //< Four sided pyramid. Defined by bound-box, where base is equal to bottom side of box.
};

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 258 of file Effect.c.

  {
    return true;
  }

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

Definition at line 173 of file EnDebug.c.

  {
    vector dir = to - from;
    dir.Normalize();
    vector dir1 = dir * size;
    size = size * 0.5;
 
    vector dir2 = dir.Perpend() * size;
 
    vector pts[5];
    pts[0] = from;
    pts[1] = to;
    pts[2] = to - dir1 - dir2;
    pts[3] = to - dir1 + dir2;
    pts[4] = to;
 
    return CreateLines(color, flags, pts, 5);
  }

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

CreateBridgeArrow()

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

static

Definition at line 192 of file EnDebug.c.

  {
    vector dir = to - from;
    dir.Normalize();
 
    vector dir1 = Vector(0, 0, -size);
    size = size * 0.5;
 
    vector dir2 = dir.Perpend() * size;
 
    vector pts[7];
    pts[0] = from;
    pts[1] = from + "0 0 1";
    pts[2] = to + "0 0 1";
    pts[3] = to;
    pts[4] = to - dir1 - dir2;
    pts[5] = to - dir1 + dir2;
    pts[6] = to;
 
    return CreateLines(color, flags, pts, 7);
  }

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

Definition at line 214 of file EnDebug.c.

  {
    vector org = mat[3];
    int flags = ShapeFlags.NOZWRITE | ShapeFlags.DOUBLESIDE | ShapeFlags.TRANSP | ShapeFlags.ONCE;
    Create(ShapeType.LINE, 0xffff0000, flags, org, mat[0] * 0.5 + org);
    Create(ShapeType.LINE, 0xff00ff00, flags, org, mat[1] * 0.5 + org);
    Create(ShapeType.LINE, 0xff0000ff, flags, org, mat[2] * 0.5 + org);
  }

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.

Definition at line 207 of file Effect.c.

  {
    // Already queued
    if (IsPendingDeletion())
      return;
 
    // Mark it to prevent queuing it up multiple times or get stuck in a call loop
    m_IsPendingDeletion = true;
 
    // Stop it, so that the effects can clean up themselves
    // Since if for example this is EffectParticle and the particle is looping
    // It NEEDS to be stopped to clean up the Particle
    Stop();
 
    // Queue up the destroying, as we should not do it while we are accessing it here
    if (GetGame())
      GetGame().GetCallQueue(CALL_CATEGORY_GAMEPLAY).Call(SEffectManager.DestroyEffect, this);
  }

References CALL_CATEGORY_GAMEPLAY, DestroyDamageTriggerEx(), SEffectManager::DestroyEffect(), GetGame(), IsPendingDeletion(), m_IsPendingDeletion, 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 ( )

protected

Get whether Effect automatically cleans up when it stops.

Returns

bool Whether Effect automatically cleans up when it stops

Definition at line 240 of file Effect.c.

  {
    return m_IsAutodestroy;
  }

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 249 of file Effect.c.

  {
    return m_IsPendingDeletion;
  }

References m_IsPendingDeletion.

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

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 231 of file Effect.c.

  {
    m_IsAutodestroy = auto_destroy;
  }

References m_IsAutodestroy.

SetColor()

proto native void SetColor

(

int

color

)

SetDirection()

proto native void SetDirection

(

vector

direction

)

SetEnableEventFrame()

void SetEnableEventFrame ( bool enable )

protected

Enable Event_OnFrameUpdate for the effect.

Note

Read SEffectManager.Event_OnFrameUpdate for more info

Definition at line 270 of file Effect.c.

  {
    if (enable)
      SEffectManager.Event_OnFrameUpdate.Insert(Event_OnFrameUpdate);
    else
      SEffectManager.Event_OnFrameUpdate.Remove(Event_OnFrameUpdate);
  }

References Event_OnFrameUpdate(), and SEffectManager::Event_OnFrameUpdate.

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

Definition at line 420 of file Effect.c.

  {
    m_Position = pos;
  }

References m_Position.

Referenced by Particle::AddAsChild(), EntityLightSource::AttachOnObject(), ScriptedWidgetEventHandler::CreateFollowedObject(), DynamicArea_Flare::EOnFrame(), DayZSpectator::EOnFrame(), 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 And(), ScriptedWidgetEventHandler::Apply(), Assert(), EntityLightSource::AttachOnMemoryPoint(), Entity::AttemptDestructionBehaviour(), WeaponParticlesBase::CheckParticleOverride(), SEffectManager::Cleanup(), ConstructData(), EmoteConstructor::ConstructEmotes(), CreateBleedingEffect(), Particle::CreateParticleEffect(), ParticleSource::CreateParticleEffect(), CreateParticleEx(), ParticleSource::CreateParticleEx(), CreditsLoader::CreateTestJson(), Weapon::CreateWeaponWithAmmo(), StaminaHandler::DepleteStamina(), 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(), GetMemoryPointPosition(), Weapon::GetMuzzleStates(), ParticleList::GetParticleID(), ParticleList::GetParticleIDByName(), ParticleList::GetParticlePath(), GameplayEffectsData::GetProbabilities(), DayZProfilesOptions::GetProfileOptionDefaultBool(), DayZProfilesOptions::GetProfileOptionDefaultFloat(), DayZProfilesOptions::GetProfileOptionDefaultInt(), GetStringVariant(), Hologram::Hologram(), ScriptedWidgetEventHandler::Init(), Init(), BleedChanceData::InitInfectedChanceMap(), BleedChanceData::InitMeleeChanceMap(), Interact(), Hologram::IsBehindObstacle(), IsFacingFireplace(), IsParticlePlaying(), JsonFileLoader< Class T >::JsonLoadData(), JsonFileLoader< Class T >::JsonLoadFile(), LoadConfig(), ScriptedWidgetEventHandler::LoadContentList(), CfgGameplayHandler::LoadData(), PlayerSpawnHandler::LoadData(), UIScriptedMenu::LoadData(), ScriptedWidgetEventHandler::LoadFilters(), NotificationSystem::LoadNotificationData(), LoadPlayerAttachmentIndexes(), AmmoTypesAPI::MagazineTypeToAmmoType(), WeaponParticlesBase::OnActivate(), ParticleSource::OnCheckAutoDelete(), MissionBase::OnClientNewEvent(), OnErrorThrown(), ActionDigInStash::OnFinishProgressServer(), OnFinishProgressServer(), ActionUnrestrainTargetHands::OnFinishProgressServer(), OnInit(), CfgGameplayHandler::OnRPC(), UndergroundAreaLoader::OnRPC(), CGame::OnRPC(), ParticleSource::OnToDelete(), Or(), EffectArea::PlaceParticles(), PlayEmote(), SEffectManager::PlayOnObject(), PlayParticle(), DestructionEffectBase::PlayParticle(), PlayParticleEx(), IEntity::PlaySoundSetAtMemoryPoint(), HFSMBase< WeaponStateBase, WeaponEventBase, WeaponActionBase, WeaponGuardBase >::RandomizeFSMStateEx(), InventoryLocation::ReadFromContext(), GameplayEffectsData::RegisterData(), ParticleList::RegisterParticle(), ResetParticle(), RestartParticle(), TFModule::Run(), array::Run(), UIScriptedMenu::SaveData(), ScriptedWidgetEventHandler::SaveFilters(), Entity::SetAttachmentExclusionMaskSlot(), ManBase::SetHairLevelToHide(), FireworksLauncherClientEvent::SetupLight(), AnniversaryFireworksLauncherClientEvent::SetupLight(), ItemOptics::ShowReddot(), EffectSound::SoundError(), Weapon::SpawnAttachedMagazine(), ObjectSpawnerHandler::SpawnObjects(), SpawnDataConverter::SpawnObjects(), SEffectManager::Stop(), StopParticle(), ClientData::SyncEvent_PreprocessPlayerList(), EnProfilerTests::TestFuncCountData(), ScriptedWidgetEventHandler::TutorialKeybinds(), UnregisterEntrance(), UnregisterPanel(), ParticleSource::UpdateState(), ValidateMuzzleArray(), EffectParticle::ValidateStart(), and WeaponParticlesBase::WeaponParticlesBase().