aom.scripting.anim

Interface Logic

public interface Logic

This interface lists all possible logics that can be used in an animation script. A typical logic construct using parameters is as follows:

    ExampleLogic param_1/param_2/.../param_n
    set hotspot
    {
       version
       {
          //do stuff when param_1 applies
       }
    }
    set hotspot
    {
       version
       {
          //do stuff when param_2 applies
       }
    }
    set hotspot {...}
    set hotspot
    {
       version
       {
          //do stuff when param_n applies
       }
    }
 

A typical logic construct without parameters is similar to this:

    ExampleLogic
    set hotspot
    {
       version
       {
          //do stuff when "example" is not true/active/enabled/...
       }
    }
    set hotspot
    {
       version
       {
          //do stuff when "example" is true/active/enabled/...
       }
    }
 

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
void	AgeLogic() Checks whether the player has advanced to a specific age yet.
void	CarryTypeLogic(string carry_1, string carry_2, string carry_3, string carry_4, string carry_n) Checks whether this unit carries a specific resource.
void	CinematicLogic() Checks whether the game is in cinematic mode.
void	CivilizationLogic(string civ_1, string civ_2, string civ_n) Checks whether this unit is owned by a specific civilization.
void	ConstructionLogic(int int_1, int int_2, int int_n) Checks whether this unit is in an specific percentage of construction.
void	ContainLogic() Checks whether this unit contains another unit.
void	CultureLogic(string culture_1, string culture_2, string culture_3, string culture_4) Checks whether this unit is owned by a specific culture.
void	DamageLogic() Checks whether this unit has suffered (more than) a specific percentage of damage.
void	EditorModeLogic() Checks whether the game is in editor mode.
void	EmpowerLogic() Checks whether this unit is being empowered by another unit.
void	ExperienceLogic(int int_1, int int_2, int int_n) Checks whether this unit has earned a specific percentage of experience.
void	FrozenLogic() Checks whether this unit is frozen.
void	InventoryLogic() Checks whether this unit has an amount of resource in its inventory.
void	ItemLogic()
void	LastItemLogic()
void	PowerLogic() Possible checks whether a specific God Power is still available.
void	ResourceLogic(int int_1, int int_2, int int_n) Checks whether this unit (e.g.
void	SpriteLogic() Checks whether this unit should use sprites.
void	TargetLogic(string unittype_1, string unittype_2, string unittype_n) Checks whether this unit is targeting a specific unit type.
void	TechLogic(string tech_1, string tech_2, string tech_n) Checks whether a specific technology has been researched yet.
void	UpgradeLogic(int int_1, int int_2, int int_n) Checks whether this unit is being upgraded to the next stage (i.e.
void	UsedLogic() Possible checks whether a specific God Power has been used yet.
void	VariationLogic() Checks whether this unit is using one of its variations.
void	WorkedOnLogic() Checks whether this unit is worked on.

Method Detail

WorkedOnLogic

void WorkedOnLogic()

Checks whether this unit is worked on. First section: not worked on. Second section: worked on.

Example

A buoy is added to fish being gathered from.

ContainLogic

void ContainLogic()

Checks whether this unit contains another unit. First section: nothing contained. Second section: something (e.g. relic) contained.

LastItemLogic

void LastItemLogic()

EmpowerLogic

void EmpowerLogic()

Checks whether this unit is being empowered by another unit. First section: not empowered. Second section: empowered.

UsedLogic

void UsedLogic()

Possible checks whether a specific God Power has been used yet.

ItemLogic

void ItemLogic()

CarryTypeLogic

void CarryTypeLogic(string carry_1,
                    string carry_2,
                    string carry_3,
                    string carry_4,
                    string carry_n)

Checks whether this unit carries a specific resource. Parameters are separated by slashes. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

carry_1 - (e.g. grain)

carry_2 - (e.g. meat)

carry_3 - (e.g. fish)

carry_4 - (e.g. wood)

carry_n - (e.g. gold)

Note

There is no "none" options here. To solve this, an inventory check can be done first to determine whether the unit is effectively holding something.

See Also:

InventoryLogic()

CinematicLogic

void CinematicLogic()

Checks whether the game is in cinematic mode. First section: not in cinematic mode. Second section: in cinematic mode.

PowerLogic

void PowerLogic()

Possible checks whether a specific God Power is still available.

ResourceLogic

void ResourceLogic(int int_1,
                   int int_2,
                   int int_n)

Checks whether this unit (e.g. gold mine) has left only a specific percentage of the initial resources. Parameters are separated by spaces. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

int_1 - (e.g. 100)

int_2 - (e.g. 50)

int_n - (e.g. 25)

InventoryLogic

void InventoryLogic()

Checks whether this unit has an amount of resource in its inventory. Parameters are separated by spaces. Each section corresponds to 1 of the parameters respectively, in the order they are provided. When checking whether a unit is holding something (e.g. relic, resources), the parameters are: 0 1. When checking how much a herdable has fattened, possible parameters are (for example): 25 75.

DamageLogic

void DamageLogic()

Checks whether this unit has suffered (more than) a specific percentage of damage. Possible parameters are: 0 25 100.

EditorModeLogic

void EditorModeLogic()

Checks whether the game is in editor mode. First section: not in editor mode. Second section: in editor mode.

SpriteLogic

void SpriteLogic()

Checks whether this unit should use sprites. First section: should not use sprites. Second section: should use sprites.

FrozenLogic

void FrozenLogic()

Checks whether this unit is frozen. First section: unit is not frozen. Second section: unit is frozen.

CivilizationLogic

void CivilizationLogic(string civ_1,
                       string civ_2,
                       string civ_n)

Checks whether this unit is owned by a specific civilization. Parameters are separated by slashes. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

civ_1 - (e.g. zeus)

civ_2 - (e.g. hades)

civ_n - More than two civilization can be provided.

Example

civilizationLogic none/set determines whether this unit is under Set's control.

TechLogic

void TechLogic(string tech_1,
               string tech_2,
               string tech_n)

Checks whether a specific technology has been researched yet. Parameters are separated by slashes. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

tech_1 - (e.g. none)

tech_2 - (e.g. plow)

tech_n - More than two technologies can be provided.

UpgradeLogic

void UpgradeLogic(int int_1,
                  int int_2,
                  int int_n)

Checks whether this unit is being upgraded to the next stage (i.e. Settlement to Town Center). Parameters are separated by spaces. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

int_1 - (e.g. 0)

int_2 - (e.g. 25)

int_n - (e.g. 100)

ExperienceLogic

void ExperienceLogic(int int_1,
                     int int_2,
                     int int_n)

Checks whether this unit has earned a specific percentage of experience. Parameters are separated by spaces. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

int_1 - (e.g. 0)

int_2 - (e.g. 25)

int_n - (e.g. 100)

ConstructionLogic

void ConstructionLogic(int int_1,
                       int int_2,
                       int int_n)

Checks whether this unit is in an specific percentage of construction. Parameters are separated by spaces. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

int_1 - (e.g. 0)

int_2 - (e.g. 25)

int_n - (e.g. 100)

AgeLogic

void AgeLogic()

Checks whether the player has advanced to a specific age yet.

TargetLogic

void TargetLogic(string unittype_1,
                 string unittype_2,
                 string unittype_n)

Checks whether this unit is targeting a specific unit type. Parameters are separated by slashes. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

unittype_1 - (e.g. none)

unittype_2 - (e.g. abstractTitan)

unittype_n - More than two unit types can be provided.

Example

Titans attack other Titans in a different fashion compared to regular units.

VariationLogic

void VariationLogic()

Checks whether this unit is using one of its variations. Each section corresponds to 1 of the possible variations respectively.

Example

Male and Female Villagers look differently.

CultureLogic

void CultureLogic(string culture_1,
                  string culture_2,
                  string culture_3,
                  string culture_4)

Checks whether this unit is owned by a specific culture. Parameters are separated by slashes. Each section corresponds to 1 of the parameters respectively, in the order they are provided.

Parameters:

culture_1 - (e.g. Egyptian)

culture_2 - (e.g. Greek)

culture_3 - (e.g. Norse)

culture_4 - (e.g. Atlantean)