Wikiadmin: Created page with "The Upgrade definition describes how an Entity (usually the Player) will be affected by an upgrade. To create an upgrade select the File:DefineUpgrade.png|..."

2020-05-24T13:57:36Z

Created page with "The Upgrade definition describes how an Entity (usually the Player) will be affected by an upgrade. To create an upgrade select the File:DefineUpgrade.png|..."

New page

The Upgrade definition describes how an Entity (usually the [[Add a Player|Player]]) will be affected by an upgrade. To create an upgrade select the [[File:DefineUpgrade.png|link=]] Upgrade Definition icon on the [[Define Menu|Define Menu]] in the [[Level Editor|Level Editor]].

A range of things can be upgraded – properties such as speed, health, weapons, shields; etc. Upgrades can be temporary, permanent or lost when the player loses a life. Upgrades can be set to be triggered when a [[Create a Wave|Wave of NPCs]] is destroyed or in the [[Actions Tab|Actions Tab]] of a [[Add a Player | Player]], [[Add an Object | Object]], [[Add an NPC | NPC]], [[Add an NPC Generator | NPC Generator]], [[Add a Timer|Timer]], [[Add a Trigger|Trigger]] or [[Add a Formation|Formation]].

[[File:UpgradeDef1.png|link=]]

'''Duration'''

An upgrade can be temporary and the effect only lasting a specified time. If the ''Duration'' property is set to 0 then the upgrade will be permanent (also see the ''Reset when lost life'' property). If the ''Duration'' is not zero then the upgrade will only be active for the specified number of seconds, after which any properties will be reverted to their previous settings.

'''Reset when lost life'''

When set, the ''Reset when lost life'' property will reset any active upgrades when the Entity (usually the player) loses a life.

'''Reset when damaged'''

When set, the ''Reset when damaged property'' will reset any active upgrades when the Entity receives damage.

'''Particle'''

The ''Particle'' property specifies which [[Particle Editor|particle system]] will play when the upgrade is activated.

'''Sound Cue'''

The Sound Cue property specifies which [[Sound Editor|audio effect]] will play when the upgrade is activated.

'''Type'''

Specifies the type of upgrade that will occur:

'''Enable Weapon'''

[[File:UpgradeDef2.png|link=]]

The ''Enable Weapon'' type will enable the weapon in the specified [[Weapons Tab|Weapon Slot]].

'''Disable Weapon'''

[[File:UpgradeDef3.png|link=]]

The ''Disable Weapon'' type will disable the weapon in the specified [[Weapons Tab|Weapon Slot]].

'''Modify Player Definition'''

[[File:UpgradeDef4.png|link=]]

Modifying the [[Player Definition|Player Definition]] will apply any properties from the specified Player Definition that are different to the Player Definition the player started with. This allows individual properties (such as ''Max Health'', for example) to be upgraded while leaving other properties unmodified.

'''Replace Player Definition'''

[[File:UpgradeDef5.png|link=]]

Replacing the [[Player Definition|Player Definition]] will apply all the properties from the specified Player Definition onto the player.

'''Modify Input Definition'''

[[File:UpgradeDef6.png|link=]]

Modifying the [[Input Definition|Input Definition]] will apply any properties from the specified Input Definition that are different to the Input Definition the entity started with. This allows individual properties (such as assigning ''Fire Button 1'', for example) to be upgraded while leaving other properties unmodified.

'''Replace Input Definition'''

[[File:UpgradeDef7.png|link=]]

Replacing the [[Input Definition|Input Definition]] will apply all the properties from the specified Input Definition onto the entity.

'''Modify Movement Definition'''

[[File:UpgradeDef8.png|link=]]

Modifying the [[Movement Definition|Movement Definition]] will apply any properties from the specified Movement Definition that are different to the Movement Definition the entity started with. This allows individual properties (such as ''Max Acceleration'', for example) to be upgraded while leaving other properties unmodified.

'''Replace Movement Definition'''

[[File:UpgradeDef9.png|link=]]

Replacing the [[Movement Definition|Movement Definition]] will apply all the properties from the specified Movement Definition onto the entity.

'''Change Properties'''

[[File:UpgradeDef10.png|link=]]

To select which property you’d like the upgrade, click on the ''Property'' value (initially set to'' None'') and select a property from the list.

'''Change Multipliers'''

[[File:UpgradeDef11.png|link=]]

Select which multiplier you’d like the upgrade by using the ''Multiplier'' drop down list.

'''Change User Variable'''

[[File:UpgradeDef12.png|link=]]

To select which [[Custom Variables|custom variable]] you’d like the upgrade, click on the ''User Variable'' value (initially set to ''None'') and select a custom variable from the list.

'''Extra Life'''

[[File:UpgradeDef13.png|link=]]

The ''Extra Life'' upgrade type is a convenient way of giving the entity an extra life.

'''Add to Health'''

[[File:UpgradeDef14.png|link=]]

The ''Add to Health'' upgrade type is a convenient way of giving the entity some extra health.

'''Add to Shield'''

[[File:UpgradeDef15.png|link=]]

The ''Add to Shield'' upgrade type will add the value from the ''Add'' property to the entity’s shield strength.

'''Add to Score'''

[[File:UpgradeDef16.png|link=]]

The ''Add to Score'' upgrade type will add the value from the ''Add'' property to the entity’s score.

'''Enable Shield'''

[[File:UpgradeDef17.png|link=]]

The ''Enable Shield'' upgrade type will activate the entity’s [[Shield Definition|shield]].

'''Disable Shield'''

[[File:UpgradeDef18.png|link=]]

The ''Disable Shield'' upgrade type will deactivate the entity’s [[Shield Definition|shield]].

Upgrade Definition - Revision history

Wikiadmin: Created page with "The Upgrade definition describes how an Entity (usually the Player) will be affected by an upgrade. To create an upgrade select the File:DefineUpgrade.png|..."