FPlanetaryBodyInfo | Unreal Engine 5.6 Documentation

API > API/Plugins > API/Plugins/CelestialVault

Runtime structure to store the computed properties of a Planetary Body, for any Query.


Name	FPlanetaryBodyInfo
Type	struct
Header File	/Engine/Plugins/Experimental/CelestialVault/Source/CelestialVault/Public/CelestialDataTypes.h
Include Path	#include "CelestialDataTypes.h"

Syntax

USTRUCT (BlueprintType )  
struct FPlanetaryBodyInfo

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
Age	double	Indication of the lunar age. 0 = New Moon, 0.25 = First quarter, 0.5 = Full Moon, 1 = Next New Moon	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"
ApparentDiameterDegrees	double	The True apparent diameter of the body seen from Earth (Angular size, in degrees)	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault" Meta=(ForceUnits="Degrees")
ApparentMagnitude	double	The Magnitude of the body seen from Earth	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"
DEC	double	The Body Declination in the Celestial Frame - In Degrees	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault" Meta=(ForceUnits="Degrees")
DirectionTowardEarth	FVector	Keep track of the location toward the Earth	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"
DistanceInAU	double	The Body distance to Earth - In Astronomical Units!	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"
IlluminationPercentage	double	Indication of percentage of a full moon illumination	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"
ISMInstanceIndex	int32	Internal value of the ISM Instance corresponding to this planet	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"
Name	FString	The body Name	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"
OrbitType	EOrbitType	One of the predefined body types (Solar system planets), any custom one for fantasy planets	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"
RA	double	The Body Right Ascension in the Celestial Frame - In hours!	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault" Meta=(ForceUnits="Hours")
Radius	double	The Body Radius in Kilometers	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault" Meta=(ForceUnits="Kilometers")
ScaledApparentDiameterDegrees	double	The Scaled apparent diameter of the body seen from Earth (Angular size, in degrees) Takes the fake scaling factor into consideration, so useful for camera FOV tracking.	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault" Meta=(ForceUnits="Degrees")
UETransform	FTransform	Keep track of the Vault-relative transform, at ToD = 0 for animated bodies (Moon)	CelestialDataTypes.h	BlueprintReadWrite EditAnywhere Category="Celestial Vault"

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void ComputeTranform ( double UEDistance, double BodyScale )		CelestialDataTypes.h
FString ToString()	Can't use a UFUNCTION inside a struct --> Use the Celestial Maths Blueprint Function Library.	CelestialDataTypes.h

Navigation

Syntax

Variables

Public

Functions

Public