Debug Shape API definition

Topics
	Diag menu API definition

Перечисления
enum	ShapeType {   BBOX , LINE , SPHERE , CYLINDER ,   DIAMOND , PYRAMID }
enum	ShapeFlags {   NOZBUFFER , NOZWRITE , WIREFRAME , TRANSP ,   DOUBLESIDE , ONCE , NOOUTLINE , BACKFACE ,   NOCULL , VISIBLE , ADDITIVE }
enum	CollisionFlags

Функции
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])

Переменные
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.

Подробное описание

Перечисления

CollisionFlags

enum CollisionFlags

{
    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

Элементы перечислений
NOZBUFFER
NOZWRITE
WIREFRAME
TRANSP
DOUBLESIDE
ONCE
NOOUTLINE
BACKFACE
NOCULL
VISIBLE
ADDITIVE

{
    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

Элементы перечислений
BBOX
LINE
SPHERE
CYLINDER
DIAMOND
PYRAMID

{
    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.
};

Функции

CanDestroy()

bool CanDestroy ( )

protected

Get whether the Effect can be destroyed right now.

Возвращает

bool Whether the Effect can be destroyed right now

    {
        return true;
    }

Create()

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

static

Используется в CreateMatrix().

CreateArrow()

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

static

    {
        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);
    }

Перекрестные ссылки CreateLines(), vector::Normalize() и vector::Perpend().

CreateBridgeArrow()

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

static

    {
        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);
    }

Перекрестные ссылки CreateLines(), vector::Normalize(), vector::Perpend() и 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

Используется в CreateArrow() и CreateBridgeArrow().

CreateMatrix()

static void CreateMatrix ( vector mat[4] )

static

    {
        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);
    }

Перекрестные ссылки 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.

Заметки

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.

    {
        // 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);
        }
    }

Перекрестные ссылки CALL_CATEGORY_GAMEPLAY, DestroyDamageTriggerEx(), SEffectManager::DestroyEffect(), GetGame(), IsPendingDeletion(), m_IsPendingDeletion, OnTriggerDestroyed() и Stop().

Используется в EntityLightSource::CheckLifetime(), EntityLightSource::HandleBrightnessFadeing(), EntityLightSource::HandleRadiusFadeing() и ~AreaDamageManager().

GetMatrix()

proto native void GetMatrix

(

out vector

mat[4]

)

IsAutodestroy()

bool IsAutodestroy ( )

protected

Get whether Effect automatically cleans up when it stops.

Возвращает

bool Whether Effect automatically cleans up when it stops

    {
        return m_IsAutodestroy;
    }

Перекрестные ссылки m_IsAutodestroy.

IsPendingDeletion()

bool IsPendingDeletion ( )

protected

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

Возвращает

bool Whether the Effect is queued up for being cleaned up

    {
        return m_IsPendingDeletion;
    }

Перекрестные ссылки m_IsPendingDeletion.

Используется в Destroy(), Entity::IsSetForDeletion() и EffectSound::SoundStop().

SetAutodestroy()

void SetAutodestroy ( bool auto_destroy )

protected

Sets whether Effect automatically cleans up when it stops.

Заметки

This means that it will be unregistered from SEffectManager as well

Аргументы

auto_destroy

bool Whether Effect automatically cleans up when it stops

    {
        m_IsAutodestroy = auto_destroy;
    }

Перекрестные ссылки m_IsAutodestroy.

SetColor()

proto native void SetColor

(

int

color

)

Используется в InventoryItem::ReadVarsFromCTX().

SetDirection()

proto native void SetDirection

(

vector

direction

)

SetEnableEventFrame()

void SetEnableEventFrame ( bool enable )

protected

Enable Event_OnFrameUpdate for the effect.

Заметки

Read SEffectManager.Event_OnFrameUpdate for more info

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

Перекрестные ссылки Event_OnFrameUpdate() и SEffectManager::Event_OnFrameUpdate.

Используется в EffEngineSmoke::EffEngineSmoke(), EffectSound::UpdateEvents() и ~Effect().

SetFlags()

proto native void SetFlags

(

ShapeFlags

flags

)

Используется в DayZCreature::DayZCreatureAI(), DynamicArea_Flare::DynamicArea_Flare(), EasterEgg(), EntityAI::Man(), Particle::ParticleInit() и Trigger::Trigger().

SetMatrix()

proto native void SetMatrix

(

vector

mat[4]

)

SetPosition()

proto native void SetPosition

(

vector

pos

)

Set the world position of the Effect.

Предупреждения

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

Аргументы

pos	vector The world position for the Effect

    {
        m_Position = pos;
    }

Перекрестные ссылки m_Position.

Используется в 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() и UnlockServer().

Переменные

ErrorEx

enum ShapeType ErrorEx

Используется в 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::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(), 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(), 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(), UIScriptedMenu::ResetAll(), ResetParticle(), RestartParticle(), CatchingResultBase::RollChanceSeeded(), TFModule::Run(), array::Run(), UIScriptedMenu::SaveData(), ScriptedWidgetEventHandler::SaveFilters(), Entity::SetAttachmentExclusionMaskSlot(), ManBase::SetHairLevelToHide(), YieldItemBase::SetRegistrationIdx(), SetupInitialTypes(), FireworksLauncherClientEvent::SetupLight(), AnniversaryFireworksLauncherClientEvent::SetupLight(), SetupProbabilityArray(), ItemOptics::ShowReddot(), EffectSound::SoundError(), SpawnAndSetupCatch(), Weapon::SpawnAttachedMagazine(), ObjectSpawnerHandler::SpawnObjects(), SpawnDataConverter::SpawnObjects(), SymptomManager::SpawnSymptom(), SEffectManager::Stop(), StopParticle(), ClientData::SyncEvent_PreprocessPlayerList(), EnProfilerTests::TestFuncCountData(), ScriptedWidgetEventHandler::TutorialKeybinds(), Land_WarheadStorage_PowerStation::UnregisterBunker(), UnregisterEntrance(), UnregisterPanel(), ParticleSource::UpdateState(), CatchingContextTrapsBase::UpdateUsedBait(), ValidateMuzzleArray() и WeaponParticlesBase::WeaponParticlesBase().