Lua scripting in Eufloria - reference

[Alex]

Thread for lua script command reference

Currently existing commands

Function prototype	return type	Description
GameRunning()	bool	returns true if the game is still running
AddAsteroid(x, y)	Asteroid	Adds an asteroid to the game at the given coordinates during setup.
AddAsteroidWithAttribs(x, y, energy, strength, speed)	Asteroid	Adds an asteroid with the given attributes at the given x,y location, during setup.
GetAsteroid(id)	Asteroid	Get a specific asteroid. Asteroid ID starts at zero and goes up by one with each asteroid created. All of the GetAsteroid functions may return nil if you pass in an invalid ID, so ideally you will check the return value if you are at all uncertain.
GetRandomAsteroid()	Asteroid	Get any asteroid in the current game, at random.
GetRandomRangeAsteroid(start, end)	Asteroid	Get a random asteroid from the given range of IDs (start is inclusive, end is exclusive, so e.g. a range of (4, 10) would select a random asteroid from the asteroids with IDs of 4, 5, 6, 7, 8, and 9)
GetRandomEmptyAsteroid()	Asteroid	Get a random asteroid in the game that is empty (that is, it has no trees or seedlings on it and is owned by the grey team)
GetRandomRangeEmptyAsteroid(start, end)	Asteroid	Get an empty asteroid from the given range of asteroid IDs.
GetGameTime()	number	Returns a real number in seconds showing the time the current game has been running.
MessageBox(string message)	nil	Pops up a message box with an OK button and the given message.
AddAsteroidRing(int numAsteroids, float x, float y, float centreRadius, float beltWidth)	nil	Adds an asteroid ring containing numAsteroids asteroids, centred around coordinates (x, y), with radius centreRadius, and spreading asteroids out over a ring thickness of beltWidth game units.
GetDialogActive()	bool	returns whether there is an active dialog on the screen (from MessageBox).
Pause()	nil	Pauses the game (without popping up the pause menu).
Unpause()	nil	Unpauses the game (without removing the pause menu if it is active)
GetNumInactiveFactions	number	Returns the number of currently inactive factions.
GetFirstInactiveFactionID	number	Returns the number of the first faction number which is 'dead', i.e. has no asteroids.
GetRandomInactiveFactionID	number	Gets a random dead faction and returns its id number.
Quit(bool win)	nil	Stops the game and returns to the main menu. Set the parameter to true if the game was won, false if not.
GetEmpire(int faction)	Empire	Gets the empire with the given ID.
GetAI(int faction)	AI or nil	Gets the AI with the given ID. can return nil, e.g. if you ask for team 1 (the player) the function will return nil as the player has no AI.
SetBackdropColor / SetBackdropColour	nil	Set the level colour (r, g, b values from 0 - 255)
SetVignetteAlpha	nil	Set the darkness of the vignette (value from 0 - 255)
print	nil
SetDysonTreeButtonAvailable(bool available)	nil	Sets the availability of this button.
SetDefenseTreeButtonAvailable(bool available)	nil	Sets the availability of this button.
SetFlowerDefenseButtonAvailable(bool available)	nil	Sets the availability of this button.
SetFlowerSeederButtonAvailable(bool available)	nil	Sets the availability of this button.
SetTreeInfoAvailable(bool available)	nil	Sets the availability of this information on the info panel.
SetEnemyInfoAvailable(bool available)	nil	Sets the availability of this information on the info panel.
SetCoreInfoAvailable(bool available)	nil	Sets the availability of this information on the info panel.
SetAttribsInfoAvailable(bool available)	nil	Sets the availability of this information on the info panel.
SetCameraPosition(float x, float y)	nil	Sets the camera's position, without causing it to smoothly transition.
SetCameraTarget(float x, float y)	nil	Sets the camera target, causing it to smoothly move from the current location to the new target.
SetCameraPositionToAsteroidID(int id)	nil	Sets the camera's position to that of the given asteroid's ID, without causing it to smoothly transition. Will do nothing if the asteroid does not exist.
SetCameraTargetToAsteroidID(int id)	nil	Sets the camera target position to that of the given asteroid's ID, causing it to smoothly move from the current location to the new target.
SetCameraZoom(float zoom)	nil	Sets the camera zoom. The camera will smoothly zoom to the given value.
SetCameraZoomNow(float zoom)	nil	Sets the camera zoom bypassing any smooth transition.
GetNumFactions	int	How many factions are there? This one will tell you.
UnlockArenaLevel(int level)	void	Unlock an arena level (pass in 1 to unlock the first arena, 2 for the second etc)
DrawLine(x1,y1,x2,y2,r1,g1,b1,a1,r2,g2,b2,a2,thickness)	void	(all parameters floating point) Draws a line from (x1,y1) to (x2,y2) with starting colour (r1,g1,b1,a1) and ending colour (r2,g2,b2,a2) where colour values are from 0 to 1. use alpha <1 (e.g. 0.99) rather than 1 in general.
DrawTexLine(int id, x1,y1,x2,y2,r1,g1,b1,a1,r2,g2,b2,a2,thickness)	void	As for DrawLine except applies a texture (see below for id indexes)
DrawSprite(int id, x,y, r,g,b,a, size)	void	Draws sprite of size size and index id at (x,y) in colour (r,g,b,a).
IsOnScreen(x,y, radius)	bool	returns true if the object at x,y with radius radius would be on the screen at the time of drawing.
GetLODAlpha(int LOD)	float	returns the alpha of the given LOD (0,1,2). LOD 2 is the most zoomed-in; LOD 0 is the farthest zoomed-out.
GetCameraScale()	float	returns the current scale of the camera. Divide a value by this to get a size in pixels on-screen to pass to draw functions.
SaveStats(string filename)		e.g. SaveStats("myfile.bin") - saves out the current game stats to the given file
LoadStats(string filename)		e.g. LoadStats("myfile.bin") - loads myfile.bin into the current stats register
GetCameraX()	float	Get camera's x position
GetCameraY()	float	Get camera's y position
GetCameraZoom()	float	Gets the camera zoom - warning this value is different from the value passed in from SetCameraZoom for arcane and ridiculous reasons... the formula is (0.05f + ((float)(Zoom * Zoom * Math.Sign(Zoom)) / 10)) where Zoom is the value you passed in

[Alex]

All accessible from lua. They are floats or ints. Try not to put floating point numbers into int vars... I have put the type after the var name.

Camera vars
Globals.Camera.ViewSupplement (float)

Flower vars
Globals.Flowers.GrowTime (float)
Globals.Flowers.MinSpeed (float)
Globals.Flowers.MaxSpeed (float)
Globals.Flowers.SpeedPower (float)
Globals.Flowers.MinHealth (int)
Globals.Flowers.MaxHealth (int)
Globals.Flowers.HealthPower (float)
Globals.Flowers.Available (int) - sets whether or not flowers will grow (0 = won't grow, anything else = will grow)

Mine vars
Globals.Mines.GrowTime (float)
Globals.Mines.MinSpeed (float)
Globals.Mines.MaxSpeed (float)
Globals.Mines.SpeedPower (float)
Globals.Mines.MinHealth (int)
Globals.Mines.MaxHealth (int)
Globals.Mines.HealthPower (float)
Globals.Mines.NumberOfLasers (int)
Globals.Mines.LaserPowerMin (float)
Globals.Mines.LaserPowerMax (float)
Globals.Mines.LaserPowerRule (float)
Globals.Mines.ExplosionPowerMin (float)
Globals.Mines.ExplosionPowerMax (float)
Globals.Mines.ExplosionPowerRule (float)
Globals.Mines.ExplosionRadiusMin   (float)
Globals.Mines.ExplosionRadiusMax (float)
Globals.Mines.ExplosionRadiusPower  (float)
Globals.Mines.LaserRange  (float)

Missile vars
Globals.Missiles.AmmoAvailable1 (int)
Globals.Missiles.AmmoAvailable2  (int)
Globals.Missiles.AmmoAvailable3  (int)
Globals.Missiles.AmmoAvailable4  (int)
Globals.Missiles.DamageMin  (float)
Globals.Missiles.DamageMax (float)
Globals.Missiles.DamagePowerRule (float)
Globals.Missiles.RadiusMin  (float)
Globals.Missiles.RadiusMax (float)
Globals.Missiles.RadiusPowerRule (float)
Globals.Missiles.SpeedMin  (float)
Globals.Missiles.SpeedMax (float)
Globals.Missiles.SpeedPowerRule  (float)
Globals.Missiles.TriggerDistance  (float)
Globals.Missiles.ReloadMin (float)
Globals.Missiles.ReloadMax (float)
Globals.Missiles.ReloadPowerRule (float)
Globals.Missiles.TurnRate  (float)
Globals.Missiles.LaunchDuration (float)
Globals.Missiles.CheckTimer  (float)

Seedling vars
Globals.Agents.MaxSpeed   (float)
Globals.Agents.MinSpeed  (float)
Globals.Agents.SpeedPower  (float)
Globals.Agents.WanderAttackTime  (float)
Globals.Agents.AttackRepeatTime  (float)
Globals.Agents.MinDamage  (float)
Globals.Agents.MaxDamage (float)
Globals.Agents.DamagePower (float)
Globals.Agents.MinAltitude  (float)
Globals.Agents.MaxAltitude (float)
Globals.Agents.AttackDist   (float)
Globals.Agents.BomVolume  (int)
Globals.Agents.MinHealth  (int)
Globals.Agents.MaxHealth (int)
Globals.Agents.HealthPower  (float)
Globals.Agents.RegenRate (float)
Globals.Agents.NoseLengthMin  (float)
Globals.Agents.NoseLengthMax (float)
Globals.Agents.TurnRate (float)
Globals.Agents.AttackTravellerMultiplier (float)
Globals.Agents.AttackAgentDistanceSuper (float)
Globals.Agents.AttackRepeatTimeSuper (float)
Globals.Agents.SendThresholdEnergy (float)
Globals.Agents.SendThresholdStrength (float)
Globals.Agents.SendThresholdSpeed (float)

Asteroid vars
Globals.Asteroids.MaxVolume (int)
Globals.Asteroids.TakeoverVolume (int)
Globals.Asteroids.MaxTrees (int)
Globals.Asteroids.MinRadius (float)
Globals.Asteroids.MaxRadius (float)
Globals.Asteroids.RadiusPowerRule (float)
Globals.Asteroids.SizeFromEnergy (float)
Globals.Asteroids.SizeFromStrength (float)
Globals.Asteroids.SizeFromSpeed (float)
Globals.Asteroids.AttributeMinimum (float)
Globals.Asteroids.AttributeDivisions (int)
Globals.Asteroids.SendVolume (int)
Globals.Asteroids.AsteroidSelectRadius (int)
Globals.Asteroids.MinSendDistance (float)
Globals.Asteroids.MaxSendDistance (float)
Globals.Asteroids.SendPowerRule (float)
Globals.Asteroids.MinCoreHealth (float)
Globals.Asteroids.MaxCoreHealth (float)
Globals.Asteroids.CoreHealthPower (float)
Globals.Asteroids.SeedlingCap  (int)
Globals.Asteroids.SpawnCap (int)

Dyson tree vars
Globals.Structures.TreeCost  (int)
Globals.Structures.MinHealth  (float)
Globals.Structures.MaxHealth  (float)
Globals.Structures.HealthPower  (float)
Globals.Structures.RegenRate  (float)
Globals.Structures.LevelTime1 (float)
Globals.Structures.LevelTime2  (float)
Globals.Structures.LevelTime3 (float)
Globals.Structures.LevelTime4  (float)
Globals.Structures.SpawnTime1 (float)
Globals.Structures.SpawnTime2 (float)
Globals.Structures.SpawnTime3 (float)
Globals.Structures.SpawnTime4 (float)
Globals.Structures.SoundVolume (float)
Globals.Structures.MinSoundTime (float)
Globals.Structures.MaxSoundTime (float)
Globals.Structures.MaxDamage   (float)
Globals.Structures.MinDamage  (float)
Globals.Structures.DamagePower  (float)
Globals.Structures.FlowerProbability (float)
Globals.Structures.RootSpeed (float) - affects all roots in the game

Defense tree vars
Globals.StructuresDefense.TreeCost (int)
Globals.StructuresDefense.MinHealth (float)
Globals.StructuresDefense.MaxHealth (float)
Globals.StructuresDefense.HealthPower (float)
Globals.StructuresDefense.RegenRate (float)
Globals.StructuresDefense.LevelTime1  (float)
Globals.StructuresDefense.LevelTime2  (float)
Globals.StructuresDefense.LevelTime3  (float)
Globals.StructuresDefense.LevelTime4  (float)
Globals.StructuresDefense.SpawnTime1  (float)
Globals.StructuresDefense.SpawnTime2  (float)
Globals.StructuresDefense.SpawnTime3  (float)
Globals.StructuresDefense.SpawnTime4  (float)
Globals.StructuresDefense.MaxDamage (float)
Globals.StructuresDefense.MinDamage (float)
Globals.StructuresDefense.DamagePower (float)

AI stuff
Globals.AI.MinDecisionTime (float)
Globals.AI.MaxDecisionTime (float)
Globals.AI.GraceTimer (int)

Program vars - try not to change these yourself
Globals.P.ToolTipWait (float)
Globals.P.ToolTipWaitUI (float)
Globals.P.AutoHide (int)
Globals.P.FullScreen (int)
Globals.P.SeenHelp (int)
Globals.P.FontSize (float)
Globals.P.BGFade (float)
Globals.P.PlayerColour  (int)

Game vars
Globals.G.EnemyFactionsMin (int)
Globals.G.EnemyFactionsMax (int)
Globals.G.BeltRadius (int)
Globals.G.BeltWidth  (int)
Globals.G.Asteroids  (int)
Globals.G.MinAsteroidSeparation (int)
Globals.G.StartingSeedlings (int)
Globals.G.StartingSeedlingsPlayer  (int)
Globals.G.MaxAsteroidNeighbourDist (int)
Globals.G.GreysProbability (float)
Globals.G.GreysMin (int)
Globals.G.GreysMax (int)

[Alex]

function LevelSetup()
Called once at the start of the game - use it to set up asteroids and stuff.
Example:

(click to show/hide)

Code: [Select]

function LevelSetup()

SetBackdropColour(237,220,198)

    Globals.Asteroids.MaxTrees=0
    Globals.Asteroids.MinRadius=85
    Globals.Asteroids.MaxRadius=800
    Globals.Asteroids.RadiusPowerRule=1.5
    Globals.Asteroids.MinSendDistance=2500
    Globals.Asteroids.MaxSendDistance=4000
    Globals.Asteroids.SendPowerRule=2.5
Globals.G.MinAsteroidSeparation = 500

AddAsteroidRing(4, 0, 0, 900, 150)

a = GetAsteroid(0)
a.Owner = 1
a:AddSeedlings(4)

a = GetAsteroid(1)
a.Owner = 0
a:AddSeedlings(4)
a:Reveal(1)

a = GetAsteroid(2)
a.Owner = 1
a:AddSeedlings(4)
a:Hide(1)

a = GetAsteroid(3)
a.Owner = 1
a:AddSeedlings(4)
a:Hide(1)

end

function LevelLogic()
Called as a coroutine. Put in while loops with coroutine.yield() in them to hold up your script.
Example:

(click to show/hide)

Code: [Select]

function LevelLogic()

Pause()
MessageBox("Starting message\n\nThis message pops up before the level begins.")
WaitDialog()
Unpause()

player = GetEmpire(1)

while player.NumSeedlings <= 15 do

coroutine.yield()
end

Pause()
MessageBox("Ending message\n\nYou totally won the level.\n\nGo you.")
WaitDialog()
Unpause()

Quit()
end

function LevelDraw()
Optional. Called every time the game draws to the screen. Fill it with your lovely drawing code. Check the script examples thread for an example.

function OnAsteroidTaken(id, owner)
This is optional but if defined will be called whenever an asteroid changes hands. Use it to check for specific asteroids being taken over by specific teams, or whatever you like.

(click to show/hide)

Code: [Select]

function OnAsteroidTaken(id, owner)
if id == 1 then MessageBox("Asteroid "..id.." was taken by faction "..owner..".") end
end

function OnAsteroidRevealed(id, owner)
This is optional but if defined will be called whenever an asteroid is revealed to an owner. So when you discover an asteroid, this will be called with the id of the asteroid and owner 1, for example.

(click to show/hide)

Code: [Select]

function OnAsteroidRevealed(id, owner)
if id == 1 then MessageBox("Asteroid "..id.." was discovered by faction "..owner..".") end
end

[Alex]

Let's say you have an Asteroid called a. To call functions on a, you use the colon like so

Code: [Select]

a:AddTrees(1,2)and to set fields you use the dot like so

Code: [Select]

a.Owner = 3
These are the most important functions and fields available to you as a scripter (there are tons more but listing them all would take ages and confuse people):

Asteroids

Function name	Return value	Description
MoveBy(float, float)	nil	Moves the asteroid by the given offset.
MoveTo(float, float)	nil	Moves the asteroid to the given position.
GetNumSeedlings()	int	Counts the number of seedlings present at the asteroid.
GetNumSeedlings(int faction)	int	Counts the number of seedlings present at the asteroid belonging to the given faction/empire.
GetNumSeedlingsExcluding(int faction)	int	Counts the number of seedlings present at the asteroid, excluding seedlings from the given faction.
GetNumFlowers(int faction)	int	Counts the number of flowers present at the asteroid belonging to the given faction/empire.
GetNumMines(int faction)	int	Counts the number of mines present at the asteroid belonging to the given faction/empire.
GetFlower(int faction)	Flower	Gets one of the flowers of the given faction present on the asteroid. Will return nil if there are none available.
GetMine(int faction)	Mine	Gets one of the mines of the given faction present on the asteroid. Will return nil if there are none available.
GetNumTrees()	int	Counts the number of trees present at the asteroid.
GetNumDysonTrees()	int	Counts the number of these trees present at the asteroid.
GetNumDefenseTrees()	int	Counts the number of these trees present at the asteroid.
FreeSlots()	int	Returns how many places for trees are left here.
AvailableStructureSpace()	bool	Tells you if there is space for any trees here.
SetRadius(float radius)	nil	Set the radius of the asteroid. Probably best not to call this after level setup.
SendSeedlingsToTarget(int faction, int number, Asteroid asteroid)	int	Attempt to send number seedlings from faction faction to asteroid asteroid.
CanAddSeedling(int faction)	bool	Check to see if faction faction can add any seedlings to this asteroid.
CanSpawnSeedling(int faction)	bool	Check to see if faction faction can spawn any seedlings on this asteroid.
AddDysonTree()	Structure	Attempt to add a Dyson tree to the asteroid; if nothing can be done (all tree slots are taken) the function does nothing and returns nil. Otherwise the function returns a Structure, which is the base type of the trees in Dyson.
AddDefenseTree()	Structure	See above.
PlantDysonTree(int faction)	Structure	Attempt to plant a Dyson tree using the seedlings present at the asteroid; if nothing can be done (all tree slots are taken, or there are not enough seedlings or the asteroi is owned by some other faction than team 0 or the given faction) the function does nothing and returns nil. Otherwise the function returns a Structure, which is the base type of the trees in Dyson.
PlantDefenseTree(int faction)	Structure	See above.
ChangeOwner(int faction)	nil	Instantly transfers ownership of the asteroid to the given team.
GetSendDistance()	float	Instantly transfers ownership of the asteroid to the given team.
IsBarren()	bool	Informs of the asteroid's barren status (barren is when team 0 (the greys) is the owner and there are no trees).
AddSeedlings(int numberToAdd)	nil	Adds numberToAdd seedlings to the asteroid of the current asteroid owner's team.
AddSuperSeedlings(int numberToAdd)	nil	Adds numberToAdd enhanced seedlings to the asteroid of the current asteroid owner's team.
AddSeedlings(int numberToAdd, int faction, float energy, float strength, float speed)	nil	Adds numberToAdd seedlings to the asteroid of the given team and with the given attributes.
AddSuperSeedlings(int numberToAdd, int faction, float energy, float strength, float speed)	nil	Adds numberToAdd enhanced seedlings to the asteroid of the given team and with the given attributes.
RemoveSeedlings(int faction, int numberToRemove)	nil	Removes numberToAdd seedlings at random from the asteroid of the given owner's team.
AddFlower()	Flower	Adds a flower of the asteroid's owners type to the asteroid. May return nil if there are too many flowers in the game.
AddFlower(int faction)	Flower	Adds a flower of the given faction type to the asteroid.
AddMine()	Mine	Adds a mine of the asteroid's owners type to the asteroid. May return nil if there are too many mines in the game.
AddMine(int faction)	Mine	Adds a mine of the given faction type to the asteroid.
AddTrees(int dyson, int defense)	nil	Add the given number of trees to the asteroid.
SetGraceTime(float gracetime)	nil	Sets the grace time for the current owner of the asteroid - stops the owner's AI from doing anything with the asteroid while the grace timer is still above 0.
SetFlowerProbability(float probability)	nil	Override the probability (0 = no chance -> 1 = guaranteed) of flowers being grown on trees planted on this asteroid. Will also affect any trees currently planted here - if they are currently not going to grow a flower (as this is decided when they are created), they will "roll the die" again to see if they will grow a flower.
GetRandomDefenseTree() and GetRandomDefenseTree(bool ignoreEnhance)	Structure or nil	This gets a random defense tree. If you send in false as the parameter, it will choose a tree without a flower already planted on it. If no tree is suitable the function returns nil.
GetRandomDysonTree() and GetRandomDysonTree(bool ignoreEnhance)	Structure or nil	This gets a random dyson tree. If you send in false as the parameter, it will choose a tree without a flower already planted on it. If no tree is suitable the function returns nil.
GetRandomTree() and GetRandomTree(bool ignoreEnhance)	Structure or nil	This gets a random tree. If you send in false as the parameter, it will choose a tree without a flower already planted on it. If no tree is suitable the function returns nil.
Field name	Type	Description
ID	int	The ID of the asteroid, corresponding to when it was created in the level setup. Do not edit this value unless you want trouble.
Moveable	bool	Can the game move the asteroid around during setup to make sure it isn't too close / far away from other asteroids? This field will have no effect after level setup.
Name	string	The name of the asteroid. You can name your asteroids if you like.
SeedlingCap	int	Set the maximum number of seedlings allowed on an asteroid.
SpawnCap	int	Set the number of seedlings at an asteroid before Dyson trees stop producing seedlings.
TreeCap	int	Set the maximum number of trees allowed on an asteroid.
CoreHealth	int	Set the asteroid's core health.
MaxCoreHealth	int	Set the asteroid's maximum core health.
SendDistance	float	Set the asteroid's sending distance.

Trees

Function name	Return value	Description
LevelUp()	nil	Level the tree up. If called during setup the tree will start the game with a fully grown root and at the next level up. Call it multiple times have the tree at higher levels.
SetFlowerProbability(float probability)	nil	Override the probability (0 = no chance -> 1 = guaranteed) of flowers being grown on a tree. The tree will "roll the die" again to see if it will grow a flower.
AddFlower()	Flower/Mine or nil	If the tree is a dyson tree this will add a Flower. If the tree is a Defense tree it will add a Mine. If the tree already has a flower or mine this will return nil.
Field name	Type	Description
Enhanced	bool	Sets the tree to have been enhanced (to make super seedlings).

Flower/Mine

Function name	Return value	Description
GrowToMax()	nil	The flower will immediately grow to full age, ready to be plucked.
Pluck()	nil	The flower or mine will detatch itself from its tree, if it is attached.
SendTo(Asteroid destination)	nil	Attempt to send the flower/mine to the destination asteroid.
Plant(Structure tree)	bool	Plant the flower on the given tree, returns false if it couldn't plant.
PlantOnRandomTree()	bool	Plant the flower on a random tree, returns false if it couldn't plant.
PlantOnRandomDysonTree()	bool	Plant the flower on a random dyson tree, returns false if it couldn't plant.
PlantOnRandomDefenseTree()	bool	Plant the flower on a random defense tree, returns false if it couldn't plant.
Field name	Type	Description

Empires

Function name	Return value	Description
GetRandomAsteroid()	Asteroid	.
GetNumOwnedAsteroids()	int	How many asteroids the empire owns
GetNumVisibleAsteroids()	int	How many asteroids the empire knows about
OwnsAsteroidID(int id)	bool	returns true if the empire currently owns asteroid with given id.
Field name	Type	Description
NumSeedlings	int	.
NumTrees	int	.
NumDysonTrees	int	.
NumDefenseTrees	int	.
Defeated	bool	set by the game to true when the empire has been defeated.

AIs - AIs are also Empires, so you can also call/set anything in the above Empire reference on any AI you might have around. e.g. num = GetAI(3).NumSeedlings

Function name	Return value	Description
.	.	.
Field name	Type	Description
MinScoutTime	float	scout timer - how often will we check to scout.
MaxScoutTime	float	The timer is set to a random value between the min and max values.
MinScoutableArmy	int	won't scout from asteroids with this number or fewer seedlings.
MinBattleAnalysisTime	float	Time between periodic checks. When this timer runs out, an analysis of battles in progress is conducted. Various values below are then taken in to account to govern the AI's decisions depending on the battle's progression.
MaxBattleAnalysisTime	float	The timer is set to a random value between the min and max values.
Cowardice	float (0-1)	chances of retreating a battle we are losing.
BattleSavvy	float (0-1)	chances of picking a battle for a valuable asteroid - don't put this at 1 or the AI will only look at one asteroid at a time!
RecognisableThreatProportion	float (0-1)	enemy army size relative to ours before it's considered a threat.
ReinforcementGreed	float (0-1)	proportion of existing forces elsewhere to send in aid of battle.
AidEnthusiasm	float (0-1)	how much to overshoot the battle rating when sending aid, to allow for inbound enemy forces, estimate errors, travel time, wanting to win, etc.
MinExpansionTime	float	Expand the empire. Expansion won't happen if seedling numbers are below a certain value
MaxExpansionTime	float	The timer is set to a random value between the min and max values.
MinExpansionForce	int	This should be at least the cost of a tree.
ExpandToValuableAsteroidChance	float (0-1)	likelihood of choosing a more valuable asteroid to expand to.
GreedyExpansion	float (0-1)	likelihood of sending all/most of the seedlings to expand.
ExpandBlind	float (0-1)	likelihood of expanding to asteroids that haven't been scouted yet.
MinAttackTime	float	Time between checks for vulnerable nearby asteroids that can be attacked.
MaxAttackTime	float	The timer is set to a random value between the min and max values.
MinPlantTime	float	Time between checks for suitable locations for planting trees.
MaxPlantTime	float	The timer is set to a random value between the min and max values.
MinFlowerTime	float	Time between checks that cause the AI to pluck, plant and send flowers.
MaxFlowerTime	float	The timer is set to a random value between the min and max values.
MinGatherTime	float	Time between AI logic used to gather armies on asteroids, and send them to take over enemy asteroids too.
MaxGatherTime	float	The timer is set to a random value between the min and max values.
MinTotalSeedlings	int	the minimum number of seedlings allowed in the empire. if the actual number is below this then the AI will stop expanding and planting trees.
MinTotalAddPerAsteroid	int	adds this number on to the above minimum, per asteroid in the empire.

General game entities - these functions can be used on most anything in the game (seedlings, trees, asteroids, etc)

Function name	Return value	Description
Hide(int faction)	nil	Hides the entity from the given faction.
Reveal(int faction)	nil	Reveals the entity to the given faction.
IsVisible(int faction)	bool	Tells if the entity is visible to the given faction.
SetVisible(int faction, bool visible)	nil	Sets whether the entity can be seen by the given faction.
IsVisible()	bool	Tells if the entity is visible to the game (i.e. will it render if it comes onscreen).
Die()	nil	Deactivate the entity and do whatever else happens when it dies.
SetEnergy(float energy)	nil	Set the energy attribute of the entity from 0.0 to 1.0
SetStrength(float strength)	nil	Set the strength attribute of the entity from 0.0 to 1.0
SetSpeed(float speed)	nil	Set the speed attribute of the entity from 0.0 to 1.0
Regen(float time)	nil	tells the entity to regenerate some of its energy. The parameter is delta time, so set it to e.g. 1 to regenerate a second's worth of energy. Normally this is called once a frame with the duration of the frame passed in.
DistanceSquaredTo(Entity other)	float	returns the squared distance from the centre of this entity to the centre of the one you passed in.
AttackedBy(Entity other)	nil	Tells this entity that it was attacked by the one you pass in.
AttackedBy(Entity other, float time)	nil	Tells this entity that it was attacked by the one you pass in for 'time' seconds. Normally the second value is the frame duration.
Field name	Type	Description
CurrentEnergy	float	Current hit points of the entity.
MaxEnergy	float	Max hitpoints of the entity.
Position	Vector3	Position of the entity - access individual coords with capital letters e.g. entity.Position.X or entity.Position.Y.
Radius	float	radius of the entity.
OnScreen	bool	tells you whether the entity is on the screen or not.
Active	bool	Tells whether the entity is still active. Set it to false to remove the entity from the game.

[Alex]

For reference, here are some standard Lua reference pages online:

Programming in Lua

If you are new to Lua and especiialy if you are new to scripting, at least read the Expressions and Statements sections, preferably also read the Types section, Functions, and Iterators.

Also available is the rather terse and academic official Lua reference.

[jhchrist]

These are the most important functions and fields available to you as a scripter (there are tons more but listing them all would take ages and confuse people):

If documenting the remaining functions would take too long, would it be possible for you to provide us with a list of the remaining functions without descriptions, so that we can at least experiment with them without having to try and guess their names?

[annikk.exe]

I think it's probably a bit more complicated than simply copying and pasting a list over.  I know that Alex is extremely busy with various stuff right now, maybe in a month or so he will get time to make a nice list for us :>  I agree it would be cool to know what else it's possible to do..

[njursten]

If you feel really hardcore you can extract all strings from the executable to try and find commands. How about the extremely useful function PlayWinSound?

[jhchrist]

If you feel really hardcore you can extract all strings from the executable to try and find commands.

I've already been doing this a little bit, but the trick is to find the functions which have lua bindings, too. For example, I want to move an asteroid, but none of the position-related function strings I can find seem to have lua bindings.

[annikk.exe]

I'm not that hardcore :<

[jhchrist]

Okay, so I've gone through the Eufloria.exe file and found a lot of function names that look familiar, so I'm going to assume that all of the functions which are bound in lua are in the executable.

I've attached the (formatted) list of function names which I found. I'm going to try using some of these in a game and see how it goes.

Edit: I have done some more digging, and I think I have a bit more worked out. Lua allows developers to create bindings to C/C++ data structures using something called the userdata datatype. Eufloria seems to have a few of these things defined, such as Eufloria.Music, Eufloria.Asteroid, and Eufloria.Attributes. These userdata types can have functions and parameters associated with them. I have attached a listing of the userdata structures as I understand them so far.

[annikk.exe]

Awesome!! :D

Nice job dude :>

[Alex]

Nice work

I can bind in more lua stuff for later releases. Sorry I haven't given more detailed docs by now.

[Imagamer]

If you have AI variables that determine how soon the AI performs a specific action, like MINPLANTTIME and MAXPLANTTIME, what does MINTICK and MAXTICK do now? Does it start the timer of the other AI variables?

[annikk.exe]

We're not sure, unfortunately.. :>

[ulfn]

Using the time-honored method of trial-and-error I found the following fields for the Asteroid type:

Field	type	description
position	Position	The position of the asteroid.
radius	float	The radius of the asteroid.
attribs	Attributes	Asteroid attributes (strength, energy, speed)

With the types

Position

Field	type
x	float
y	float

Attributes

Field	type
strength	float
energy	float
speed	float

The position and radius are really handy for instance for computing if one asteroid is reachable from another:

(click to show/hide)

function Distance(From, To)
  local dx, dy

  dx = To.position.x - From.position.x
  dy = To.position.y - From.position.y
  return math.sqrt(dx*dx + dy*dy)
end

function Reachable(From, To)
  return Distance(From, To) <= From.SendDistance + To.radius
end

Edit: The attribs and radius are in jh's userdata list, but the position field isn't.

[Alex]

Added to the list (these should be in and working in 2.05):
General game entities - these functions can be used on most anything in the game (seedlings, trees, asteroids, etc)

Function name	Return value	Description
SetVisible(int faction, bool visible)	nil	Sets whether the entity can be seen by the given faction.
Regen(float time)	nil	tells the entity to regenerate some of its energy. The parameter is delta time, so set it to e.g. 1 to regenerate a second's worth of energy. Normally this is called once a frame with the duration of the frame passed in.
DistanceSquaredTo(Entity other)	float	returns the squared distance from the centre of this entity to the centre of the one you passed in.
AttackedBy(Entity other)	nil	Tells this entity that it was attacked by the one you pass in.
AttackedBy(Entity other, float time)	nil	Tells this entity that it was attacked by the one you pass in for 'time' seconds. Normally the second value is the frame duration.
Field name	Type	Description
Position	Vector3	Position of the entity - access individual coords with capital letters e.g. entity.Position.X or entity.Position.Y.
Radius	float	radius of the entity.
OnScreen	bool	tells you whether the entity is on the screen or not.
Active	bool	Tells whether the entity is still active. Set it to false to remove the entity from the game.

[IDemon]

Alex truly a massive thank you for publishing all this for us it has been no end of help in developing my map editor thus far.

[dragoonreas]

I was looking through the userdata structures list jhchrist posted and noticed the get_FacingAngle and get_Rotation functions for Asteroids. I'm assuming the FacingAngle parameter controls the absolute rotation of the asteroid, and the Rotation parameter controls how fast and in what direction the asteroid is spinning. Are these assumptions correct?

I tried using GetAsteroid(id).FacingAngle but it didn't seem to do anything. I might have been setting the facing angle using radians rather then degrees, which may explain why it didn't appear to have any affect if it's supposed to be set using degrees.

I also tried using GetAsteroid(id).Rotation but got an error saying there was no Set function for this parameter. Does this mean that the asteroid rotation (spin) isn't bound in Lua, or is there another way to set it?

[Pilchard123]

Rotation doesn't work. I tried already, a while back.

Here's what Alex said:

...

for now, no rotating asteroids or even experiments with rotating asteroids - sorry!

[dragoonreas]

That's a shame, spinning asteroids would have looked cool in the level I'm making.

I think the FacingAngle still retained the value I gave it though, so at least I won't have to create a separate array to store the angle values I'm using for my tree fractal algorithm. I'll also be making use of that new DistanceSquaredTo function in my algorithm too.

EDIT: Nope, the FacingAngle parameter stays at 0 no matter what you set it to. The DistanceSquaredTo function is also not working for me, as I get the following error message when I try to use it "Object reference not set to an instance of an object."

[annikk.exe]

You CAN rotate asteroids, but the trees and shrubbery and seedlings and everything else do not rotate with it.  Therefore because asteroids are circular, it effectively does nothing.

[spywhere]

Is "Globals.Flowers.MaxVolume" exist in the game?

I just make a commands database in my Tools and set default value as in the game and found that only one field is not used which is Globals.Flowers.MaxVolume

I use default.xml to set default value.

Thanks...

PS. Sorry for my bad English

[Alex]

It does exist - it's used when flowers and mines are plucked, and for the flowers and mines loop sounds.

[annikk.exe]

Alex, what does GetLeafColour(int) do?

I saw it in somebody's code.  I had no idea it was a command!  I gather it must be run on a tree.  What does it return?

If this could be used to check what colour a particular empire is, that would be very useful to me!

[Alex]

It's a function in "Structure" (i.e. trees), takes an integer from 0 to 4 inclusive and returns a colour. Each team has 5 colours that represent it, and trees store an internal version of it so that when tree ownership changes, the leaves that it bears can smoothly change colour instead of changing immediately.

If you want to get a team colour... here's a tasty bit for you.

Code: [Select]

Game = luanet.import_type("Eufloria.ColonyGame");
team1red0 = Game.GetFactionColour(1,0)
team1red1 = Game.GetFactionColour(1,1)
team4red3 = Game.GetFactionColour(4,3)
luanet.import_type gives you access to a class type theoretically giving you the opportunity to create instances of this type as well, though I am not sure what it would mean to do this in many cases for Eufloria's classes.

GetFactionColour is a static function of ColonyGame so you only need the type to be able to access it, not the ColonyGame instance. Hence the code above assigns the type ColonyGame to the variable CG, and this makes available the static functions of that type.

The base game class (that handles the front end etc) is Eufloria.Game, and has a static instance called Eufloria.Game.Instance from which various things are available (including Game.Instance.ColonyGame if the game is running).

e.g.

Code: [Select]

Program = luanet.import_type("Eufloria.Game")
ProgramInstance = Program.Instance
Game = luanet.import_type("Eufloria.ColonyGame")
GameInstance = ProgramInstance.ColonyGame
if (GameInstance ~= nil) -- use some part of colonygame instance e.g. call ApplyDarkModeSettings()!
All very untested and unsupported I must hasted to add!

[Pilchard123]

Can you set the colours with this too?

[annikk.exe]

Even with just what Alex has given me, I could effectively "set" colours.  I could develop a script that checks what the colour is, and changes the asteroid to a different empire number if it's a colour I don't like.  :>

This is freaking awesome... if it works, this will finally give me the ability to produce maps that look exactly how I intend them to look, every time they are played.  :>

[Alex]

I don't think you can set them at the moment, maybe there's a way but as ColorF (the data returned by GetFactionColour) is a struct not a class, you don't get passed back a reference, so going GetFactionColour(1,4).R = 0.8 won't do anything. Same for GetLeafColour. The changing empire plan ought to work though. Just bear in mind that the leaf colours may not be close to any of the team colours if the asteroid was recently taken over.

[annikk.exe]

I'm currently working on an extremely large and complicated level and I'm looking for ways to increase the FPS ingame.  I've already been able to make drastic improvements to some parts of the code by breaking out of loops early, using cheaper calculations to rule things out more quickly, avoiding math.sqrt wherever possible, trying to spot large inefficiencies in the looping structures, and so on.

I was wondering if you know if there are any Eufloria functions that are particularly expensive?  EG, does it cost more CPU cycles to draw a sprite, or a line?  Is "GetAsteroid" expensive?  What about "GetNumSeedlings"?  If there are any obvious cases where you can accomplish something in two different ways, and one is much cheaper than the other, I'd really like to know about them.. :>

[Alex]

Probably better to do this on a case-by-case basis. I don't know of any rotters in there that take more time than they ought, I'd have to take a look to see which are the most hefty.

I'll have a look in the thread now...

[Avaguard]

heres 1 u can maybe add RevealAll() although maybe everyone already knew...........maybe i did something wrong just now

[annikk.exe]

You could just do it this way:

Code: [Select]

for i = 0,numberofasteroidsinyourlevel do
GetAsteroid(i):Reveal(1)
end
:>

[Alex]

RevealAll() is a command that was added and should now work. I haven't updated this docs thread in ages, sorry.

[Aino]

Is there anyone that wants to make a writing program just for Eufloria? So it will recognize all these codes automatically instead of going up here just to figure out?

[Pilchard123]

I'm working one one, I have been for a while now. Search for "EUCLiD". The uploaded one at the moment is rather basic, but will get maps done quick. EUCLiD 2 will be much more functional.


http://www.dyson-game.com/smf/index.php?topic=834.0 is the announcement thread, has a link to a download thread.

[Aino]

I would really like a coding window, and as I see it now, you are using some kind of Visual C... So you know what I mean maybe... If you use some kind of Visual C thingy...

What I meant was a nice program that was just like a notebook or notepad or whatever that recognizes parts of codes and show some examples of codes that looks a little alike...

[Pilchard123]

Ah. Try programmer's notepad, or notepad++

I'll probs put in a coding window to EUCLiD too.

[Aino]

I use notepad++ already What I am talking about is a way to not need to go in here and look after the thing you seek... Simply jsut either search for it in the program or it will pop up in a littl box when you write and you can choose from several(depends) built-in methods to put in...

[Aino]

Is there any way to GET the attribs of an entity? Like entity.attribs.speed?

[annikk.exe]

Yes.

roidstrength = GetAsteroid(x).attribs.strength

For example :>

".attribs.strength" should work for other entities too.  And of course you can call energy and speed, not just strength.

[Aino]

God -.- I have been close though, cause Lua is case sensitive?

[annikk.exe]

Hmm,  not sure.. :>

[Aino]

not working :/ Better check it closeluy then...

Code: [Select]

if GetAsteroid(i).attribs.energy > HighestEnergy then

HighestEnergy = GetAsteroid(i).attribs.energy

end
I get the error: invalid arguments to method call, the function is the AI... and I suspect the attrib part to be the fault...

[Aino]

Solved I think, I saw an error though, I was calling i when it wasn't in a for loop or the variable i was existing Changing now

[Aino]

Any way to select each and every seed in the whole game?

Like:

Code: [Select]

for i = 1,NumSeedlings() do --NumSeedlings can be a variable by adding all the current seeds frome ach empire in the game, thats not the problem :)
if Agent(i) ~= nil then
x = Agent(i).position.X   --position.X is existing for all game enitites, so I guess that would work if you can call each and every agent alone :)
--make a variable containing x, if there is anything like this, is there then possible to track(if the seeds are on move) where they are going(asteroid wise)?
end
end
Now I am asking before I have experimented though... as usual -.-

[Pilchard123]

Just brainstorming, but here goes:

Get the number of empires, the number of asteroids, and the number of seedlings on each asteroid.

At EVERY roid, run a FOR loop for each empire, for the number of their seedlings on that roid. This loop would pick up a specific seedling, there is a way of doing this, but I'm not sure how just atm. Add this collected seedling to a variable.

This variable will hold all seedlings.


...


Maybe.

[Aino]

o.O...

Just do a for loop for all empires and NumSeedlings?

[Pilchard123]

Or that, either way. Why did I not think of that?

[annikk.exe]

I recall there is a way to access an inbuilt array of seedlings, organised per asteroid.  Can't remember offhand how to do it though.
If you make your own array and store the seedlings in it, you could then run commands on them even if they are mid-flight between two asteroids.

[Aino]

Thats exactly what I need for my save code, but now I need to know how to write into a file... IO crashes, so I don't know how...

[Aino]

Is there any possibl way to find the Empire color? Like GetEmpire(faction).Colo(u)r

[Pilchard123]

GetLeafColour()

Ask Annikk about it, he was working with it a while ago.

[annikk.exe]

I did not find an elegant solution to that.  My experiments with GetLeafColour() met with limited success.

[Aino]

Ok, I'll try and see

[Aino]

Hmm, I need that Seedling/Agent thing again >.<

Anyone remember?

[Aino]

What is all of these?

DrawSprite Know that one
DrawLine
DrawEnergyLine
DrawBox
DrawCore
DrawTexturedLine2
DrawTexturedLine
DrawRoot
DrawPolyLine
DrawPolygon
DrawLineTest Guess it is jsut a test, so...

Are they usable, or? And if so, how do you use them(I know thay should either be in LevelDraw() or ScreenDraw(), but I am talking about the arguments it needs)?

[Pilchard123]

Draw sprite draws...a sprite!

There's a list of them somewhere around, iirc.

[Aino]

Lol, forgot to strikeout DrawSprite, I use it way to often to not know what it is

Edit: My 500th post :O

[hitman271]

Any word on DrawPolygon? Is there a way to determine a lua's functions arguments?!

[Pilchard123]

Oh, i made a draw polygon somewheres around. Want a link?

[hitman271]

Yes of course. Why doesn't this game have a proper wiki?

[Lost Seedling]

Regarding the GetFactionColor commands- Sometimes the values returned are spot-on to what they look like on the screen. Most of the time, unfortunately, they are not even close. I've spent many hours the last few weeks trying to use the colors returned to match Draw commands, and I'm convinced it is a hopeless pursuit. I thought perhaps it was a problem with the RGB values being switched around vs. the RBG values in some of the  Draw functions, but it turned out not to be the case. Weird.

[Pilchard123]

http://www.dyson-game.com/smf/index.php?topic=1359.msg9403#msg9403

The arguments X and Y are arrays of the co-ordinates of the vetices.

[BC wins]

I'm not that hardcore :<

Good joke