Editing EDF spritenames
From Eternity Wiki
Jump to navigationJump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
Sprite names are defined as a list of string values which must be exactly four characters long, and should contain only capital letters and numbers | Sprite names are defined as a list of string values which must be exactly four characters long, and should contain only capital letters and numbers. | ||
'''NOTE''': The custom-set sprite-based pickup effects (defined by the pickupitem keyword) are not supported any more. It has been verified that no released EE mods have used this feature. Native sprite to item type associations are still active, which means that you can still change the sprite of a given item (with SPECIAL flag) and the effect will correspond to the new sprite. | |||
{{backto|EDF}} | {{backto|EDF}} | ||
Line 30: | Line 29: | ||
# add a few values in later (maybe near a thing or frames that use them)... | # add a few values in later (maybe near a thing or frames that use them)... | ||
spritenames += { "BLAH", "WOOT" } | spritenames += { "BLAH", "WOOT" } | ||
== | =Sprite-related variables= | ||
There are two sprite-related variables which may be specified in user EDF files: | |||
*playersprite | |||
*blanksprite | |||
playersprite sets the sprite to be used by the default "Marine" player skin. This must be one of the four-character sprite mnemonics defined in the spritenames array. If not provided in any EDF file, this variable defaults to the value "PLAY" (and if PLAY is not defined in that case, an error will occur). | |||
blanksprite sets the sprite to be used when objects or guns attempt to use a sprite which has no graphics loaded. This must be one of the four-character sprite mnemonics defined in the spritenames array. If not provided in any EDF file, this variable defaults to the value "TNT1" (and if TNT1 is not defined in that case, an error will occur). | |||
These values are parsed immediately after the sprite name list is loaded, and can be placed anywhere. If defined more than once, the last definition encountered takes precedence. These values must be defined at the topmost level of an EDF file. | |||
==Syntax== | |||
playersprite <sprite mnemonic> | |||
blanksprite <sprite mnemonic> | |||
==Full example== | |||
# set the player skin sprite to BLAH | |||
playersprite = BLAH | |||
# set the blank sprite to FOO1 | |||
blanksprite = FOO1 | |||
[[category:EDF]] | [[category:EDF]] |