Pyrogenesis  trunk
Functions
JSI_GameView Namespace Reference

Functions

 IMPLEMENT_BOOLEAN_SCRIPT_SETTING (Culling)
 
 IMPLEMENT_BOOLEAN_SCRIPT_SETTING (LockCullCamera)
 
 IMPLEMENT_BOOLEAN_SCRIPT_SETTING (ConstrainCamera)
 
void RegisterScriptFunctions_Settings (const ScriptRequest &rq)
 
JS::Value GetCameraRotation (const ScriptRequest &rq)
 
JS::Value GetCameraZoom ()
 
JS::Value GetCameraPivot (const ScriptRequest &rq)
 
JS::Value GetCameraPosition (const ScriptRequest &rq)
 
void CameraMoveTo (entity_pos_t x, entity_pos_t z)
 Move camera to a 2D location. More...
 
void SetCameraTarget (float x, float y, float z)
 Set the camera to look at the given location. More...
 
void SetCameraData (entity_pos_t x, entity_pos_t y, entity_pos_t z, entity_pos_t rotx, entity_pos_t roty, entity_pos_t zoom)
 Set the data (position, orientation and zoom) of the camera. More...
 
void CameraFollow (entity_id_t entityid)
 Start / stop camera following mode. More...
 
void CameraFollowFPS (entity_id_t entityid)
 Start / stop first-person camera following mode. More...
 
entity_id_t GetFollowedEntity ()
 
CFixedVector3D GetTerrainAtScreenPoint (int x, int y)
 
void RegisterScriptFunctions (const ScriptRequest &rq)
 

Function Documentation

◆ CameraFollow()

void JSI_GameView::CameraFollow ( entity_id_t  entityid)

Start / stop camera following mode.

Parameters
entityidunit id to follow. If zero, stop following mode

◆ CameraFollowFPS()

void JSI_GameView::CameraFollowFPS ( entity_id_t  entityid)

Start / stop first-person camera following mode.

Parameters
entityidunit id to follow. If zero, stop following mode.

◆ CameraMoveTo()

void JSI_GameView::CameraMoveTo ( entity_pos_t  x,
entity_pos_t  z 
)

Move camera to a 2D location.

◆ GetCameraPivot()

JS::Value JSI_GameView::GetCameraPivot ( const ScriptRequest rq)

◆ GetCameraPosition()

JS::Value JSI_GameView::GetCameraPosition ( const ScriptRequest rq)

◆ GetCameraRotation()

JS::Value JSI_GameView::GetCameraRotation ( const ScriptRequest rq)

◆ GetCameraZoom()

JS::Value JSI_GameView::GetCameraZoom ( )

◆ GetFollowedEntity()

entity_id_t JSI_GameView::GetFollowedEntity ( )

◆ GetTerrainAtScreenPoint()

CFixedVector3D JSI_GameView::GetTerrainAtScreenPoint ( int  x,
int  y 
)

◆ IMPLEMENT_BOOLEAN_SCRIPT_SETTING() [1/3]

JSI_GameView::IMPLEMENT_BOOLEAN_SCRIPT_SETTING ( Culling  )

◆ IMPLEMENT_BOOLEAN_SCRIPT_SETTING() [2/3]

JSI_GameView::IMPLEMENT_BOOLEAN_SCRIPT_SETTING ( LockCullCamera  )

◆ IMPLEMENT_BOOLEAN_SCRIPT_SETTING() [3/3]

JSI_GameView::IMPLEMENT_BOOLEAN_SCRIPT_SETTING ( ConstrainCamera  )

◆ RegisterScriptFunctions()

void JSI_GameView::RegisterScriptFunctions ( const ScriptRequest rq)

◆ RegisterScriptFunctions_Settings()

void JSI_GameView::RegisterScriptFunctions_Settings ( const ScriptRequest rq)

◆ SetCameraData()

void JSI_GameView::SetCameraData ( entity_pos_t  x,
entity_pos_t  y,
entity_pos_t  z,
entity_pos_t  rotx,
entity_pos_t  roty,
entity_pos_t  zoom 
)

Set the data (position, orientation and zoom) of the camera.

◆ SetCameraTarget()

void JSI_GameView::SetCameraTarget ( float  x,
float  y,
float  z 
)

Set the camera to look at the given location.