Frame of Reference Game API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Properties | Events | List of all members
FrameOfReference.World.Universe Class Reference

Represents a world with a height-map based Terrain. More...

Inheritance diagram for FrameOfReference.World.Universe:

Public Member Functions

 Universe (Terrain< TerrainTemplate > terrain)
 Creates a new Universe with a terrain. More...
 
override void Update (double elapsedGameTime)
 
Entity GetEntity (string name)
 Retrieves an Entity from Positionables by its name. More...
 
Trigger GetTrigger (string name)
 Retrieves an Trigger from Positionables by its name. More...
 
CameraState< Vector2 > GetCamera (string name)
 Retrieves an CameraState{TCoordinates} from Positionables by its name. More...
 
void PlayerMove (Entity entity, Vector2 target)
 Makes a player-controlled Entity move towards a target . More...
 
void MakePlayerControlled (string name)
 Turns a specific Entity into a player-controlled character. More...
 
void MakeAllNpc ()
 Turns all Entitys into NPCs. More...
 
void UnwrapWaypoints ()
 Moves Waypoint from Entity.Waypoints to UniverseBase{TCoordinates}.Positionables. Call to prepare for editing. More...
 
 Universe ()
 Base-constructor for XML serialization. Do not call manually! More...
 
override void Save (string path)
 

Static Public Member Functions

static Universe Load (string path)
 Loads a Universe from a compressed XML file (map file). More...
 
static Universe FromContent (string id)
 Loads a Universe from the game content source via the ContentManager. More...
 

Public Attributes

override MonitoredCollection
< Positionable< Vector2 > > 
Positionables => _positionables
 
const string FileExt = "." + GeneralSettings.AppNameShort + "Map"
 The file extensions when this class is stored as a file. More...
 

Protected Member Functions

override void Update (IUpdateable updateable, double elapsedGameTime)
 

Properties

Terrain< TerrainTemplateTerrain [get, set]
 The Terrain on which Entitys are placed. More...
 
float LightPhase [get, set]
 A value between 0 and 4 representing the current sun and moon positions. (0 = dawn, 1 = noon, 2 = dusk, 3 = midnight) More...
 
float LightPhaseSpeedFactor [get, set]
 The speed with which the LightPhase is incremented. More...
 
Color AmbientColor [get, set]
 The color of the ambient light (background light that is always visible and has no direction). More...
 
XColor AmbientColorValue [get, set]
 Used for XML serialization. More...
 
Color SunColor [get, set]
 The color of the diffuse light (normal directional light) of the sun. More...
 
XColor SunColorValue [get, set]
 Used for XML serialization. More...
 
float SunInclination [get, set]
 The angle of inclination of the sun's path away from the horizon towards south in degrees. More...
 
Color MoonColor [get, set]
 The color of the diffuse light (normal directional light) of the second moon. More...
 
XColor MoonColorValue [get, set]
 Used for XML serialization. More...
 
float MoonInclination [get, set]
 The angle of inclination of the second moon's path away from the horizon towards south in degrees. More...
 
ColorCorrection ColorCorrectionDawn [get, set]
 Color correction values to apply at dawn. More...
 
ColorCorrection ColorCorrectionNoon [get, set]
 Color correction values to apply at noon. More...
 
ColorCorrection ColorCorrectionDusk [get, set]
 Color correction values to apply at dusk. More...
 
ColorCorrection ColorCorrectionMidnight [get, set]
 Color correction values to apply at midnight. More...
 
bool Fog [get, set]
 Is the fog active? More...
 
float FogDistance [get, set]
 The maximum distance one can look through the fog. More...
 
Color FogColor [get, set]
 The color of the fog. More...
 
XColor FogColorValue [get, set]
 Used for XML serialization. More...
 
bool Bleach [get, set]
 Is the fog active? More...
 
int MaxTraversableSlope [get, set]
 The maximum slope the IPathfinder{TCoordinates} considers traversable. More...
 
Terrain< TerrainTemplateTerrainSerialize [get, set]
 Used for XML serialization. More...
 

Events

Action LightingChanged
 Occurs when LightPhase, AmbientColor, SunColor, ColorCorrectionDawn, ColorCorrectionNoon or ColorCorrectionDusk, ColorCorrectionMidnight was changed. More...
 

Detailed Description

Represents a world with a height-map based Terrain.

Constructor & Destructor Documentation

FrameOfReference.World.Universe.Universe ( Terrain< TerrainTemplate terrain)
inline

Creates a new Universe with a terrain.

Parameters
terrainThe terrain for the new Universe.
FrameOfReference.World.Universe.Universe ( )
inline

Base-constructor for XML serialization. Do not call manually!

Member Function Documentation

static Universe FrameOfReference.World.Universe.FromContent ( string  id)
inlinestatic

Loads a Universe from the game content source via the ContentManager.

Parameters
idThe ID of the Universe to load.
Returns
The loaded Universe.
CameraState<Vector2> FrameOfReference.World.Universe.GetCamera ( string  name)
inline

Retrieves an CameraState{TCoordinates} from Positionables by its name.

Returns
The first matching CameraState{TCoordinates}; null if there is no match.
Entity FrameOfReference.World.Universe.GetEntity ( string  name)
inline

Retrieves an Entity from Positionables by its name.

Returns
The first matching Entity; null if there is no match.
Trigger FrameOfReference.World.Universe.GetTrigger ( string  name)
inline

Retrieves an Trigger from Positionables by its name.

Returns
The first matching Trigger; null if there is no match.
static Universe FrameOfReference.World.Universe.Load ( string  path)
inlinestatic

Loads a Universe from a compressed XML file (map file).

Parameters
pathThe file to load from.
Returns
The loaded Universe.
Exceptions
IOExceptionA problem occurred while reading the file.
UnauthorizedAccessExceptionRead access to the file is not permitted.
InvalidOperationExceptionA problem occurred while deserializing the XML data.
void FrameOfReference.World.Universe.MakeAllNpc ( )
inline

Turns all Entitys into NPCs.

void FrameOfReference.World.Universe.MakePlayerControlled ( string  name)
inline

Turns a specific Entity into a player-controlled character.

void FrameOfReference.World.Universe.PlayerMove ( Entity  entity,
Vector2  target 
)
inline

Makes a player-controlled Entity move towards a target .

void FrameOfReference.World.Universe.UnwrapWaypoints ( )
inline

Moves Waypoint from Entity.Waypoints to UniverseBase{TCoordinates}.Positionables. Call to prepare for editing.

Member Data Documentation

const string FrameOfReference.World.Universe.FileExt = "." + GeneralSettings.AppNameShort + "Map"

The file extensions when this class is stored as a file.

Property Documentation

Color FrameOfReference.World.Universe.AmbientColor
getset

The color of the ambient light (background light that is always visible and has no direction).

Is not serialized/stored, AmbientColorValue is used for that.

XColor FrameOfReference.World.Universe.AmbientColorValue
getset

Used for XML serialization.

See Also
AmbientColor
bool FrameOfReference.World.Universe.Bleach
getset

Is the fog active?

ColorCorrection FrameOfReference.World.Universe.ColorCorrectionDawn
getset

Color correction values to apply at dawn.

ColorCorrection FrameOfReference.World.Universe.ColorCorrectionDusk
getset

Color correction values to apply at dusk.

ColorCorrection FrameOfReference.World.Universe.ColorCorrectionMidnight
getset

Color correction values to apply at midnight.

ColorCorrection FrameOfReference.World.Universe.ColorCorrectionNoon
getset

Color correction values to apply at noon.

bool FrameOfReference.World.Universe.Fog
getset

Is the fog active?

Color FrameOfReference.World.Universe.FogColor
getset

The color of the fog.

Is not serialized/stored, FogColorValue is used for that.

XColor FrameOfReference.World.Universe.FogColorValue
getset

Used for XML serialization.

See Also
FogColor
float FrameOfReference.World.Universe.FogDistance
getset

The maximum distance one can look through the fog.

float FrameOfReference.World.Universe.LightPhase
getset

A value between 0 and 4 representing the current sun and moon positions. (0 = dawn, 1 = noon, 2 = dusk, 3 = midnight)

float FrameOfReference.World.Universe.LightPhaseSpeedFactor
getset

The speed with which the LightPhase is incremented.

int FrameOfReference.World.Universe.MaxTraversableSlope
getset

The maximum slope the IPathfinder{TCoordinates} considers traversable.

Color FrameOfReference.World.Universe.MoonColor
getset

The color of the diffuse light (normal directional light) of the second moon.

Is not serialized/stored, MoonColorValue is used for that.

XColor FrameOfReference.World.Universe.MoonColorValue
getset

Used for XML serialization.

See Also
MoonColor
float FrameOfReference.World.Universe.MoonInclination
getset

The angle of inclination of the second moon's path away from the horizon towards south in degrees.

Color FrameOfReference.World.Universe.SunColor
getset

The color of the diffuse light (normal directional light) of the sun.

Is not serialized/stored, SunColorValue is used for that.

XColor FrameOfReference.World.Universe.SunColorValue
getset

Used for XML serialization.

See Also
SunColor
float FrameOfReference.World.Universe.SunInclination
getset

The angle of inclination of the sun's path away from the horizon towards south in degrees.

Terrain<TerrainTemplate> FrameOfReference.World.Universe.Terrain
getset

The Terrain on which Entitys are placed.

Exceptions
InvalidOperationExceptionThe Terrain could not be properly loaded from the file.

Is not serialized/stored, TerrainSerialize is used for that.

Terrain<TerrainTemplate> FrameOfReference.World.Universe.TerrainSerialize
getset

Used for XML serialization.

Event Documentation

Action FrameOfReference.World.Universe.LightingChanged

Occurs when LightPhase, AmbientColor, SunColor, ColorCorrectionDawn, ColorCorrectionNoon or ColorCorrectionDusk, ColorCorrectionMidnight was changed.


The documentation for this class was generated from the following files: