Actor: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
Fox (talk | contribs)
1,554 edits
No edit summary
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
An actor is any sprite with programming applied to it. The original actors were defined as such:
'''actor''' <picnum> <strength> <action> <move> <moveflag 1> [...] <moveflag N>


actor <name> <strength> <action> <move> <ai> { actor code } [[enda]]
'''useractor''' <type> <picnum> [strength> <action> <move> <moveflag 1> [...] <moveflag N>


This syntax can only be used on tile numbers that were hardcoded as types of actors in the game. 1.4 intorduced the [[useractor]] syntax which allows use of any tile number as an actor.
Defines parameters for in-game sprites, and allows code to be written for sprites of the specific tile number.


<name> is the name/tile of the actor. You can either input a [[define]]d name, or the tile number directly.
The token '''enda''' marks the end of the actor.


<strength> is the health of the actor.
'''actor''' MYACTOR
  [...]
'''enda'''
'''useractor''' notenemy MYACTOR2
  [...]
'''enda'''


<action> is the intial [[action]] an actor uses (optional).
Loosely speaking, "actors" are sprites that run code in game, such as enemies, breakable objects, etc.


<move> is the initial [[move]] of the actor (optional).
When defined with '''actor''' or '''useractor''', the sprites will execute their code once every tic, except for dormant enemies. Actors or dormant actors will have a statnum of 1 and 2 respectively.


<ai> is the actor's initial [[ai]] routine (optional).
Prior to v1.4, only tile numbers hard-coded to execute script would work with the '''actor''' command. After v1.4 new actors could be defined, and the '''useractor''' command was added which allowed actors to be defined as specific types for hard-coded behavior.


{ actor code } is obviously the code for the actor.
With '''useractor''', the old '''actor''' command is deprecated.


[[enda]] ends an actor.
Example:
define MYACTOR 3585
'''actor''' MYACTOR 0
  ifpdistl 1024
  {
    palfrom 32 0 16 0
  }
enda


Example actor:
See also [[state]].


<pre>
== Parameters ==
define SOMEACTOR 3585


actor SOMEACTOR 0
All parameters after <picnum> are optional.
ifpdistl 1024
 
{  
{| {{prettytable}}
    palfrom 32 0 16 0  
| <type> || is the actor type for special behavior. Only used by '''useractor'''.
}
|-
enda
| <picnum> || You can either input a [[define]]d name, or the tile number directly.
</pre>
|-
| <strength> || is the health of the actor.
|-
| <action> || is the intial [[action]] an actor uses.
|-
| <move> || is the initial [[move]] of the actor.
|-
| <moveflag> || is a sequence of parameters that specify certain hard-coded movement behavior.
|}
 
== Types ==
 
The type is technically a [[bitfield]], though "3" is invalid. It is generally either "enemy", "enemystayput", or "notenemy".
 
{| {{prettytable}}
!Value!!DEFS.CON label!![[gameflags]]!!Description
|-
|0||notenemy||<font color="gray">(None)</font>||Default. Code begins executing at the start of a level.
|-
|1||enemy||SFLAG_BADGUY||Enables hard-coded behavior. Code only begins executing upon player sight.
|-
|2||enemystayput||SFLAG_BADGUY<br>SFLAG_BADGUYSTAYPUT||Same as "enemy" plus the [[actor]] will not leave the [[sector]] it is placed in.
|-
|4||<font color="gray">(None)</font>||SFLAG_ROTFIXED||The actor's position in rotating sectors is calculated without rounding errors.
|}


[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Sprite manipulation]]
[[Category:Sprite manipulation]]

Revision as of 00:46, 20 February 2020

actor <picnum> <strength> <action> <move> <moveflag 1> [...] <moveflag N>

useractor <type> <picnum> [strength> <action> <move> <moveflag 1> [...] <moveflag N>

Defines parameters for in-game sprites, and allows code to be written for sprites of the specific tile number.

The token enda marks the end of the actor. 

actor MYACTOR
  [...]
enda

useractor notenemy MYACTOR2
  [...]
enda

Loosely speaking, "actors" are sprites that run code in game, such as enemies, breakable objects, etc.

When defined with actor or useractor, the sprites will execute their code once every tic, except for dormant enemies. Actors or dormant actors will have a statnum of 1 and 2 respectively.

Prior to v1.4, only tile numbers hard-coded to execute script would work with the actor command. After v1.4 new actors could be defined, and the useractor command was added which allowed actors to be defined as specific types for hard-coded behavior.

With useractor, the old actor command is deprecated.

Example: 

define MYACTOR 3585

actor MYACTOR 0
  ifpdistl 1024 
  { 
    palfrom 32 0 16 0 
  }
enda

See also state.

Parameters

All parameters after <picnum> are optional.

<type> is the actor type for special behavior. Only used by useractor.
<picnum> You can either input a defined name, or the tile number directly.
<strength> is the health of the actor.
<action> is the intial action an actor uses.
<move> is the initial move of the actor.
<moveflag> is a sequence of parameters that specify certain hard-coded movement behavior.

Types

The type is technically a bitfield, though "3" is invalid. It is generally either "enemy", "enemystayput", or "notenemy".

Value DEFS.CON label gameflags Description
0 notenemy (None) Default. Code begins executing at the start of a level.
1 enemy SFLAG_BADGUY Enables hard-coded behavior. Code only begins executing upon player sight.
2 enemystayput SFLAG_BADGUY
SFLAG_BADGUYSTAYPUT		 Same as "enemy" plus the actor will not leave the sector it is placed in.
4 (None) SFLAG_ROTFIXED The actor's position in rotating sectors is calculated without rounding errors.
Retrieved from "https://wiki.eduke32.com/w/index.php?title=Actor&oldid=12885"