1. Epic GamesDeveloper
  3. ACelestialVaultDaySequenceActor

ACelestialVaultDaySequenceActor

API > API/Plugins > API/Plugins/CelestialVault

   
Name ACelestialVaultDaySequenceActor
Type class
Header File /Engine/Plugins/Experimental/CelestialVault/Source/CelestialVault/Public/CelestialVaultDaySequenceActor.h
Include Path #include "CelestialVaultDaySequenceActor.h"

Syntax

UCLASS (Blueprintable, HideCategories=(Tags, Networking, LevelInstance))  
class ACelestialVaultDaySequenceActor : public ADaySequenceActor

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

ACelestialVaultDaySequenceActor ( const FObjectInitializer& Init
)

   CelestialVaultDaySequenceActor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsDaylightSavings bool Set to true if your current date is during the DST period CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Date & Location"
bKeepPlanetsInfos bool If true, the Stars information will be kept in memory and queryable at runtime CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Planets"
bKeepStarsInfo bool If true, the Stars information will be kept in memory and queryable at runtime CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Stars"
bManualControl bool If true, the moon Age (Phase) and location can be overriden CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • Category="Celestial Vault|Moons"
bUseCurrentDate bool If true, ignore the Year Month Day value and use the current system Date CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Date & Location"
CelestialStarCatalog TObjectPtr< UDataTable > A Datatable containing a Celestial Star Catalog data CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Stars"
CelestialVaultComponent TObjectPtr< USceneComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
CelestialVaultDistance double We generate the sky elements the "Platon" way, using a sphere surrounding the Earth. CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Kilometers", ClampMin="0", ClampMax="500000")
Day int Current Day CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Date & Location"
  • Meta=(EditConditionHides, EditCondition="bUseCurrentDate==false", ClampMin="1", ClampMax="31")
DeepSkyComponent TObjectPtr< UStaticMeshComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
ExponentialHeightFogComponent TObjectPtr< UExponentialHeightFogComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
FictionalStarCatalog TObjectPtr< UDataTable > A Datatable containing a Fictional Star Catalog data CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Stars"
GlobalPostProcessVolume TObjectPtr< UPostProcessComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
GMST_AtTOD_0 double Greenwich Mean Sidereal Time at corresponding to a 0 Time of Day (midnight in the morning) for the selected Date. CelestialVaultDaySequenceActor.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category="Celestial Vault|Date & Location"
GMT_TimeZone double Current Time Zone CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Date & Location"
  • Meta=(ClampMin="-11", ClampMax="14")
Latitude double Latitude of Level Origin on planet CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Date & Location"
  • Meta=(ForceUnits="Degrees", ClampMin="-90", ClampMax="90")
Longitude double Longitude of Level Origin on planet CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Date & Location"
  • Meta=(ForceUnits="Degrees", ClampMin="-180", ClampMax="180")
MaxVisibleMagnitude float All stars from the catalog with a Magnitude dimmer than this threshold won't be generated - Usually 6 is the naked eye visibility limit CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Stars"
  • Meta=(ClampMin="-30", ClampMax="30")
Month int Current Month CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Date & Location"
  • Meta=(EditConditionHides, EditCondition="bUseCurrentDate==false", ClampMin="1", ClampMax="12")
MoonAge float Lunar age. 0 = New Moon, 0.25 = First quarter, 0.5 = Full Moon, 1 = Next New Mo CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • Category="Celestial Vault|Moons"
  • Meta=(EditConditionHides, EditCondition="bManualControl==true", ClampMin="0", ClampMax="1")
MoonBodyInfo FPlanetaryBodyInfo Celestial Info for the Moon, at the beginning of the Day CelestialVaultDaySequenceActor.h
  • BlueprintReadOnly
  • Category="Celestial Vault|Moons"
MoonDiscComponent TObjectPtr< UStaticMeshComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
MoonLightComponent TObjectPtr< UDirectionalLightComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
MoonLightIntensity float Base Moonlight Intensity (for Full Moon) Typically 0.1 Lux, up to 0.32 Lux when the moon is at it's perigee (SuperMoon) CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Lux", ClampMin="0", ClampMax="200000")
MoonOffset_DEC float When faking the moon location, we need to give a location relative to the sun This is a way to control this "Vertically" using an offset in Declination. CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • Category="Celestial Vault|Moons"
  • Meta=(EditConditionHides, DisplayName="Moon Offset to Sun's Declination", EditCondition="bManualControl==true", ForceUnits="Degrees", ClampMin="-45", ClampMax="45")
MoonOffset_RA float When faking the moon location, we need to give a location relative to the sun This is a way to control this "Horizontally" using an offset in Right Ascension. CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • Category="Celestial Vault|Moons"
  • Meta=(EditConditionHides, DisplayName="Moon Offset to Sun's Right Ascension", EditCondition="bManualControl==true", ForceUnits="Hours", ClampMin="0", ClampMax="24")
MoonScale float Factor to artificially increase the Moon size CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Moons"
  • Meta=(ClampMin="0")
MoonVaultPercentage double Percentage of the CelestialVaultDistance at which the Moons are created CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Percent", ClampMin="0.1", ClampMax="100")
PlanetCenterComponent TObjectPtr< USceneComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
PlanetCenterTransform FTransform Transform to apply to the planet to have it located tangent to the Origin. CelestialVaultDaySequenceActor.h
  • BlueprintReadOnly
  • VisibleAnywhere
  • Category="Celestial Vault|Date & Location"
PlanetsCatalog TObjectPtr< UDataTable > The Data Catalog containing all Planets data CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Planets"
PlanetsComponent TObjectPtr< UInstancedStaticMeshComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
PlanetsInfos TArray< FPlanetaryBodyInfo > Array of the created planetary bodies, with all their computed information - Only populated if KeepPlanetsInfos is true CelestialVaultDaySequenceActor.h
  • BlueprintReadOnly
  • Category="Celestial Vault|Planets"
PlanetsScale float Factor to artificially increase the Planetary bodies size CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Planets"
  • Meta=(ClampMin="0")
PlanetsVaultPercentage double Percentage of the CelestialVaultDistance at which the Planets are created CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Percent", ClampMin="0.1", ClampMax="100")
SkyAtmosphereComponent TObjectPtr< USkyAtmosphereComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
SkyLightComponent TObjectPtr< USkyLightComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
StarsComponent TObjectPtr< UInstancedStaticMeshComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
StarsInfo TArray< FStarInfo > Array of the created Stars information - Only populated if KeepStarsInfo is true CelestialVaultDaySequenceActor.h
  • BlueprintReadOnly
  • Category="Celestial Vault|Stars"
StarsVaultPercentage double Percentage of the CelestialVaultDistance at which the Stars are created CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Percent", ClampMin="0.1", ClampMax="100")
SunInfo FSunInfo Celestial Info for the Sun, at the beginning of the Day CelestialVaultDaySequenceActor.h
  • BlueprintReadOnly
  • Category="Celestial Vault|Sun"
SunLightComponent TObjectPtr< UDirectionalLightComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
SunLightIntensity float Base Sun Intensity Typically 120000 Lux CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • AdvancedDisplay
  • Category="Celestial Vault"
  • Meta=(ForceUnits="Lux", ClampMin="0", ClampMax="200000")
VolumetricCloudComponent TObjectPtr< UVolumetricCloudComponent >   CelestialVaultDaySequenceActor.h
  • VisibleDefaultsOnly
  • BlueprintReadOnly
  • Category="Celestial Vault"
  • Meta=(AllowPrivateAccess="true")
Year int Current Year CelestialVaultDaySequenceActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Celestial Vault|Date & Location"
  • Meta=(EditConditionHides, EditCondition="bUseCurrentDate==false", ClampMin="1", ClampMax="9999")

Protected

Name Type Remarks Include Path Unreal Specifiers
DrawDebugDelegateHandle FDelegateHandle   CelestialVaultDaySequenceActor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetClosestPlanetaryBody ( FVector StartPosition,
FVector LookupDirection,
double ThresholdAngleDegree,
FPlanetaryBodyInfo& FoundPlanetaryBodyInfo,
FTransform& BodyTransform
)

 Return the Celestial Information of the Planetary Body (moon, planet) closest to a specific direction, within an angle threshold CelestialVaultDaySequenceActor.h
  • BlueprintCallable
  • Category="Celestial Vault|Queries"

bool GetClosestStarInfo ( FVector ObserverLocation,
FVector LookupDirection,
double ThresholdAngleDegree,
FStarInfo& FoundStarInfo,
FTransform& StarTransform
)

 Return the Celestial Information of the Star closest to a specific direction, within an angle threshold CelestialVaultDaySequenceActor.h
  • BlueprintCallable
  • Category="Celestial Vault|Queries"

FDateTime GetDate()

 Returns the current defined day, without any Time, because the Time will be controlled by the DaySequence Time of day - Uses "Now" or the Year/Month/Day properties CelestialVaultDaySequenceActor.h
  • BlueprintCallable
  • Category="Celestial Vault|Date & Location"

double GetDayCelestialVaultAngle()

 Returns the Celestial vault rotation angle for the current Date at t=0 midnight CelestialVaultDaySequenceActor.h  

FPlanetaryBodyInfo GetMoonInfo ( double JulianDate
)

 Returns the Celestial Info for the Moon, at a specific Julian Date CelestialVaultDaySequenceActor.h
  • BlueprintCallable
  • Category="Celestial Vault|Queries"

bool GetPlanetaryBodyByOrbitType ( EOrbitType OrbitType,
FPlanetaryBodyInfo& FoundPlanetaryBodyInfo,
FTransform& BodyTransform
)

 Return the Celestial Information of a specific Planetary Body (by its orbit type) CelestialVaultDaySequenceActor.h
  • BlueprintCallable
  • Category="Celestial Vault|Queries"

FSunInfo GetSunInfo ( double JulianDate
)

 Returns the Celestial Info for the Sun, at a specific Julian Date CelestialVaultDaySequenceActor.h
  • BlueprintCallable
  • Category="Celestial Vault|Sun"

void SetMoonDiscAge ( float InMoonAge
)

 Manually set the Moon Age (Phase) CelestialVaultDaySequenceActor.h
  • BlueprintCallable
  • Category="Celestial Vault|Moons"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   CelestialVaultDaySequenceActor.h  

Protected

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

 BeginPlay and OnConstruction overrides auto-register this actor with the DaySequenceSubsystem. CelestialVaultDaySequenceActor.h  

virtual void OnConstruction ( const FTransform& Transform
)

   CelestialVaultDaySequenceActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page