Main Page   Modules   File List   File Members  

LuaUniverse.cpp File Reference


Detailed Description

System: Scar

>


Namespaces

namespace  LuaBinding

Functions

real32 Universe_GameTime ()
 Get the game time in seconds.

int Universe_CurrentPlayer ()
 Get the local player on the computer, this should never be called in MP games, especially when modifying deterministic data.

int Universe_PlayerCount ()
 Get the number of players in the game.

bool AreAllied (int player0, int player1)
 Are the two give players allies.

void SetAlliance (int player0, int player1)
 Set the two players to allies.

void BreakAlliance (int player0, int player1)
 Set the two players to enemies.

udword Wait_Start (float time)
 wait for the time, gives the id of the wait so you can check it

void Universe_Pause (bool pause, float numSeconds)
 will pause or unpause the universe over numSeconds

void Universe_SlowDown (float factor, float numSeconds)
 value between 0 and 1.0 to slow down the universe, scar is still being updated

void Universe_SetAvoidance (bool active)
 turn on/off collision avoidance

void Universe_EnableSkip (bool canSkip)
 this enables the processing of the skipping key

void Universe_NebulaDelete (const char *nebulaName, float fadeTime)
 this function will return true if any squadron from the sobgroup is INside the nebula

udword EventPointer_AddSobGroup (const char *sobGroupName, udword colour, float radius)
 will display an event pointer around the lead ship of a sob group, radius is in meters if set to 0.0 bounding radius will be used.

udword EventPointer_AddVolume (const char *volumeName, udword colour, float radius)
 will display an event pointer around the specified volume, radius is in meters

udword EventPointer_AddSubSystemFromSobGroup (const char *subsystemName, const char *sobGroupName, udword colour, float radius)
 create an event for the first subsystem named in

void EventPointer_Remove (udword id)
 removes the Event pointer with the proper id

float RandomRange (float min, float max)
 get a random floating point number between min and max (inclusive)

udword RandomIntMax (udword max)
 get a random integer number between 0 and max (inclusive)

void FOW_ForceUpdate ()
 will force an update to the Fog Of War ONLY if the universe is Paused, otherwise the FOW is updated the regular way

double GetSubSystemId (const char *subsystemName)
 get the id for the named subsystem always gives a number even if there isn't a subsystem with the given name

double GetShipId (const char *shipName)
 get the id for the named ship always gives a number even if there isn't a ship with the given name

double GetResearchId (const char *researchName)
 get the id for the named research always gives a number even if there isn't a research item with the given name

void Universe_AllowPlayerOrders (bool enable)
 if true, disables the mouse selection, cursor, mouse over, and all user commands except "cancel"

void Universe_AllowClicks (bool enable)
 if true, disables LEFT/RIGHT MOUSE BUTTON click events

void Universe_Fade (real32 percentage, real32 time)
 fade the screen over the given time, 0 is a black screen, 1 is everything visible

void Universe_EnableCmd (bool enable, udword cmd)
 Enable or disable a command for the player.

void Universe_AllowSelect (bool enable)
 sets whether or not player is allowed to issue a select/deselect command

bool Universe_IsPiePlateActive ()
 will return true if the pie is active

bool Universe_MoveRestrictToVolume (bool enable, const char *volumeName)
 will lock the movement disc to the specified volume's X & Z coordinates returns true if executed successfully

real32 Universe_GetCurrentMoveHeight ()
 will return the current (vertical y axis) offset for an active pieplate


Generated on Fri Oct 31 04:05:39 2003 for Scar by doxygen1.3-rc3