className
stringlengths 1
167
| headerPath
stringlengths 14
166
| description
stringlengths 0
1.62k
| module
stringlengths 3
36
| code
stringlengths 0
11.4k
| variables
listlengths 0
395
|
|---|---|---|---|---|---|
AZoneGraphTestingActor | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Debug actor to visually test zone graph. | ZoneGraphDebug | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(HideCategories=(Actor, Input, Collision, Rendering, Replication, Partition, HLOD, Cooking)) class AZoneGraphTestingActor : public [AActor](API\Runtime\Engine\GameFramework\AActor) | [
{
"type": "TObjectPtr<UZo...",
"name": "DebugComp",
"description": ""
}
] |
IZoneGraphDebug::IsAvailable | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/IZoneGraphDebug.h | Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use | ZoneGraphDebug | static bool IsAvailable() | [] |
IZoneGraphDebug | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/IZoneGraphDebug.h | The public interface to this module. In most cases, this interface is only public to sibling modules within this plugin. | ZoneGraphDebug | class IZoneGraphDebug : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
UZoneGraphTestingComponent::CalcBounds | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size. | ZoneGraphDebug | virtual FBoxSphereBounds CalcBounds ( const FTransform & LocalToWorld ) const | [] |
UZoneGraphTestingComponent::CreateSceneProxy | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Creates a proxy to represent the primitive to the scene manager in the rendering thread.
The proxy object. | ZoneGraphDebug | virtual [FPrimitiveSceneProxy](API\Runtime\Engine\FPrimitiveSceneProxy) * CreateSceneProxy() | [] |
UZoneGraphTestingComponent::DisableCustomTests | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Prevent custom tests to be notified when lane location is updated. Currently active tests will get notified with an invalid location. | ZoneGraphDebug | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, CallInEditor, Category=Test) void DisableCustomTests() | [] |
UZoneGraphTestingComponent::EnableCustomTests | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Allow custom tests to be notified when lane location is updated. | ZoneGraphDebug | [UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, CallInEditor, Category=Test) void EnableCustomTests() | [] |
UZoneGraphTestingComponent::OnRegister | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. | ZoneGraphDebug | virtual void OnRegister() | [] |
UZoneGraphTestingComponent::OnUnregister | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Called when a component is unregistered. Called after DestroyRenderState_Concurrent and OnDestroyPhysicsState are called. | ZoneGraphDebug | virtual void OnUnregister() | [] |
UZoneGraphTestingComponent::OnZoneGraphDataBuildDone | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | void OnZoneGraphDataBuildDone ( const struct [FZoneGraphBuildData](API\Plugins\ZoneGraph\FZoneGraphBuildData) & BuildData ) | [] |
|
UZoneGraphTestingComponent::OnZoneGraphDataChanged | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | void OnZoneGraphDataChanged ( const [AZoneGraphData](API\Plugins\ZoneGraph\AZoneGraphData) * ZoneGraphData ) | [] |
|
UZoneGraphTestingComponent::PostEditChangeProperty | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Called when a property on this object has been modified externally | ZoneGraphDebug | virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent ) | [] |
UZoneGraphTestingComponent::UpdateTests | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | void UpdateTests() | [] |
|
UZoneGraphTestingComponent::UZoneGraphTestingComponent | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | UZoneGraphTestingComponent ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer ) | [] |
|
UZoneGraphTestingComponent | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Actor for testing ZoneGraph functionality. | ZoneGraphDebug | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=Custom, HideCategories=(Physics, Collision, Rendering, Cooking, Lighting, Navigation, Tags, HLOD, Mobile, AssetUserData, Activation)) class UZoneGraphTestingComponent : public [UPrimitiveComponent](API\Runtime\Engine\Components\UPrimitiveComponent) | [
{
"type": "float",
"name": "AdvanceDistance",
"description": ""
},
{
"type": "bool",
"name": "bDrawBVTreeQuery",
"description": ""
},
{
"type": "bool",
"name": "bDrawLanePath",
"description": "Experimental"
},
{
"type": "bool",
"name": "bDrawLaneSmoothing",
"description": ""
},
{
"type": "bool",
"name": "bDrawLaneTangentVectors",
"description": ""
},
{
"type": "bool",
"name": "bDrawLinkedLanes",
"description": ""
},
{
"type": "TArray<TObject...",
"name": "CustomTests",
"description": ""
},
{
"type": "FZoneGraphLaneL...",
"name": "LaneLocation",
"description": ""
},
{
"type": "FZoneGraphLaneP...",
"name": "LanePath",
"description": ""
},
{
"type": "TArray<FZoneGr...",
"name": "LinkedLanes",
"description": ""
},
{
"type": "FZoneGraphLaneL...",
"name": "NearestLaneLocation",
"description": ""
},
{
"type": "FVector",
"name": "NearestTestOffset",
"description": ""
},
{
"type": "FZoneGraphLaneL...",
"name": "NextLaneLocation",
"description": ""
},
{
"type": "FDelegateHandle",
"name": "OnDataAddedHandle",
"description": ""
},
{
"type": "FDelegateHandle",
"name": "OnDataChangedHandle",
"description": ""
},
{
"type": "FDelegateHandle",
"name": "OnDataRemovedHandle",
"description": ""
},
{
"type": "TObjectPtr<AZo...",
"name": "OtherActor",
"description": ""
},
{
"type": "FZoneGraphTagFi...",
"name": "QueryFilter",
"description": ""
},
{
"type": "FVector",
"name": "SearchExtent",
"description": ""
},
{
"type": "TObjectPtr<UZo...",
"name": "ZoneGraph",
"description": ""
}
] |
UZoneLaneTest::Draw | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | virtual void Draw ( [FPrimitiveDrawInterface](API\Runtime\Engine\FPrimitiveDrawInterface) * PDI ) const | [] |
|
UZoneLaneTest::GetOwner | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | const [UZoneGraphTestingComponent](API\Plugins\ZoneGraphDebug\UZoneGraphTestingComponent) * GetOwner() const | [] |
|
UZoneLaneTest::OnLaneLocationUpdated | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | virtual void OnLaneLocationUpdated ( const [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & PrevLaneLocation, const [FZoneGraphLaneLocation](API\Plugins\ZoneGraph\FZoneGraphLaneLocation) & NextLaneLocation ) | [] |
|
UZoneGraphTestingComponent::GetZoneGraphStorage | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Returns the graph storage corresponding to the provided lane handle, if any. | ZoneGraphDebug | const [FZoneGraphStorage](API\Plugins\ZoneGraph\FZoneGraphStorage) * GetZoneGraphStorage ( const [FZoneGraphLaneHandle](API\Plugins\ZoneGraph\FZoneGraphLaneHandle) & LaneHandle ) const | [] |
UZoneLaneTest::OnOwnerSet | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | virtual void OnOwnerSet() | [] |
|
UZoneLaneTest::SetOwner | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | ZoneGraphDebug | void SetOwner ( [UZoneGraphTestingComponent](API\Plugins\ZoneGraphDebug\UZoneGraphTestingComponent) * Owner ) | [] |
|
UZoneLaneTest | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphDebug/Public/ZoneGraphTestingActor.h | Base class to inherit from to be able to perform custom actions on lane detected by the testing actor. | ZoneGraphDebug | [UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, EditInlineNew) class UZoneLaneTest : public [UObject](API\Runtime\CoreUObject\UObject\UObject) | [
{
"type": "TObjectPtr<UZo...",
"name": "OwnerComponent",
"description": ""
}
] |
FZoneGraphEditorModule::ShutdownModule | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphEditor/Public/ZoneGraphEditorModule.h | Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well. | ZoneGraphEditor | virtual void ShutdownModule() | [] |
FZoneGraphEditorModule::StartupModule | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphEditor/Public/ZoneGraphEditorModule.h | FModuleManager::Get().LoadModuleChecked(TEXT("HTTP")); | ZoneGraphEditor | virtual void StartupModule() | [] |
FZoneGraphEditorModule | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphEditor/Public/ZoneGraphEditorModule.h | The public interface to this module | ZoneGraphEditor | class FZoneGraphEditorModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
IZoneGraphEditor | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphEditor/Public/IZoneGraphEditor.h | ZoneGraph Editor public interface | ZoneGraphEditor | class IZoneGraphEditor : public [FAssetEditorToolkit](API\Editor\UnrealEd\Toolkits\FAssetEditorToolkit) | [] |
IZoneGraphTestSuite::Get | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphTestSuite/Public/ZoneGraphTestSuite.h | Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed | ZoneGraphTestSuite | static [IZoneGraphTestSuite](API\Plugins\ZoneGraphTestSuite\IZoneGraphTestSuite) & Get() | [] |
IZoneGraphTestSuite | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphTestSuite/Public/ZoneGraphTestSuite.h | The public interface to this module | ZoneGraphTestSuite | class IZoneGraphTestSuite : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface) | [] |
IZoneGraphTestSuite::IsAvailable | /Engine/Plugins/Runtime/ZoneGraph/Source/ZoneGraphTestSuite/Public/ZoneGraphTestSuite.h | Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use | ZoneGraphTestSuite | static bool IsAvailable() | [] |
Subsets and Splits