Frame of Reference Game API
1.0.3
|
Main in-game interaction More...
Public Member Functions | |
InGamePresenter (Engine engine, Universe universe) | |
Creates a new presenter for the actual running game More... | |
override void | HookIn () |
override void | HookOut () |
void | PrepareSave () |
Writes back data to Universe so that state gets stored in savegames. More... | |
void | SwingCameraTo (string name) |
Switches from the current camera view to a new view using a cinematic effect. More... | |
void | LockOn (string name) |
Sets InteractivePresenter.SelectedPositionables to a single specific Entity and forces the Camera to stay close to it. More... | |
void | ReleaseLock () |
Releases a camera lock applied by LockOn. More... | |
Public Member Functions inherited from FrameOfReference.Presentation.InteractivePresenter | |
override void | Initialize () |
void | SwingCameraTo (CameraState< Vector2 > cameraState=null) |
Switches from the current camera view to a new view using a cinematic effect. More... | |
void | SwingCameraTo (Vector2 target) |
Swings the camera to look at a specifc set of 2D coordinates. More... | |
void | SwingCameraTo (PositionableRenderable target) |
Swings the camera to look at a specifc PositionableRenderable. More... | |
void | TakeOverSelection () |
Turns all currently selected Entitys into player-controlled characters. More... | |
void | PerspectiveChange (Point pan, int rotation, int zoom) |
virtual void | Hover (Point target) |
virtual void | AreaSelection (Rectangle area, bool accumulate, bool done) |
virtual void | Click (MouseEventArgs e, bool accumulate) |
virtual void | DoubleClick (MouseEventArgs e) |
Public Member Functions inherited from FrameOfReference.Presentation.Presenter | |
override void | Initialize () |
void | RebuildTerrain () |
Rebuilds the terrain from World.Universe.Terrain to reflect any modifications performed. More... | |
override void | DimDown () |
override void | DimUp () |
Public Member Functions inherited from AlphaFramework.Presentation.PresenterBase< Universe, Vector2 > | |
void | Dispose () |
Protected Member Functions | |
override void | MovePositionables (IEnumerable< Positionable< Vector2 >> positionables, Vector2 target) |
Moves one or more Positionable<TCoordinates>s to a new position. | |
override void | PickPositionables (IEnumerable< Positionable< Vector2 >> positionables, bool accumulate) |
Adds one or more Positionable<TCoordinates>s to SelectedPositionables. | |
Protected Member Functions inherited from FrameOfReference.Presentation.InteractivePresenter | |
InteractivePresenter (Engine engine, Universe universe) | |
Creates a new interactive presenter More... | |
override void | Dispose (bool disposing) |
Protected Member Functions inherited from FrameOfReference.Presentation.Presenter | |
Presenter (Engine engine, Universe universe) | |
Creates a new presenter. More... | |
override void | Dispose (bool disposing) |
To be called by IDisposable.Dispose and the object destructor. More... | |
Camera | CreateCamera (CameraState< Vector2 > state=null) |
Creates a new camera based on a state usually loaded from the Universe. More... | |
virtual double | CameraController (DoubleVector3 coordinates) |
Ensures the camera does not go under or outside the Terrain. More... | |
void | SwitchMusicTheme (string theme, bool immediate=false) |
Switches the theme of the music played More... | |
delegate PositionableRenderable | RenderCompononentToEngine< TComponent > (Entity entity, TComponent component) |
A callback for mapping a Render component to an Engine representation. More... | |
void | RegisterRenderComponent< TComponent > (RenderCompononentToEngine< TComponent > create) |
Registers a callback for converting a Render component to an Engine representation. More... | |
void | UpdateRepresentation (Positionable< Vector2 > element, IPositionable representation) |
Applies the position of a Model element to a View representation. More... | |
void | UpdateRepresentation (Entity element, PositionableRenderable representation) |
Applies the position and rotation of a Model element to a View representation. More... | |
void | UpdateRepresentation (Entity element, PointLight representation) |
Applies the position and rotation of a Model element to a View representation. More... | |
override void | RegisterRenderablesSync () |
void | UpdateLighting () |
Updates _lightSun and _lightMoon based on the light phase in PresenterBase<TUniverse,TCoordinates>.Universe. More... | |
Protected Member Functions inherited from AlphaFramework.Presentation.PresenterBase< Universe, Vector2 > | |
PresenterBase (Engine engine, TUniverse universe) | |
Additional Inherited Members | |
Protected Attributes inherited from FrameOfReference.Presentation.Presenter | |
virtual double | MaxCameraRadius => 2250 |
The value for StrategyCamera.MaxRadius. More... | |
bool | Lighting = true |
Use lighting in this presentation? More... | |
Protected Attributes inherited from AlphaFramework.Presentation.PresenterBase< Universe, Vector2 > | |
readonly ModelViewSync< Positionable< TCoordinates >, PositionableRenderable > | RenderablesSync |
readonly ModelViewSync< Positionable< TCoordinates >, LightSource > | LightsSync |
readonly Engine | Engine |
readonly Scene | Scene |
Properties inherited from FrameOfReference.Presentation.InteractivePresenter | |
MonitoredCollection< Positionable< Vector2 > > | SelectedPositionables = new MonitoredCollection<Positionable<Vector2>>() [get] |
The Positionable<TCoordinates>s the user has selected with the mouse More... | |
Properties inherited from FrameOfReference.Presentation.Presenter | |
bool | WireframeTerrain [get, set] |
Render the OmegaEngine.Graphics.Renderables.Terrain in wireframe-mode More... | |
bool | WireframeEntities [get, set] |
Render all entities in wireframe-mode More... | |
bool | BoundingSphereEntities [get, set] |
Visualize the bounding spheres of all entities More... | |
bool | BoundingBoxEntities [get, set] |
Visualize the bounding boxes of all entities More... | |
Terrain | Terrain [get] |
The OmegaEngine representation of World.Universe.Terrain More... | |
CameraState< Vector2 > | CameraState [get] |
Retreives the current state of the Camera for storage in the Universe. More... | |
Properties inherited from AlphaFramework.Presentation.PresenterBase< Universe, Vector2 > | |
View | View |
TUniverse | Universe |
bool | Initialized |
bool | Disposed |
Main in-game interaction
|
inline |
Creates a new presenter for the actual running game
engine | The engine to use for rendering |
universe | The universe to display |
|
inline |
Sets InteractivePresenter.SelectedPositionables to a single specific Entity and forces the Camera to stay close to it.
name | The Positionable<TCoordinates>.Name of a Entity stored in the PresenterBase<TUniverse,TCoordinates>.Universe. |
|
inline |
Writes back data to Universe so that state gets stored in savegames.
|
inline |
Releases a camera lock applied by LockOn.
|
inline |
Switches from the current camera view to a new view using a cinematic effect.
name | The Positionable<TCoordinates>.Name of a CameraState<TCoordinates> stored in the PresenterBase<TUniverse,TCoordinates>.Universe. |