Actor - Revision history

Doom64hunter: Add some missing info such as default values, and reword some paragraphs.

2021-01-10T09:31:45Z

Add some missing info such as default values, and reword some paragraphs.

← Older revision		Revision as of 02:31, 10 January 2021
Line 1:		Line 1:
	<span {{code}}>'''actor''' <picnum> [strength] [action] [move] [moveflag 1] [...] [moveflag N]</span>		<span {{code}}>'''useractor''' <type> <picnum> [strength] [action] [move] [moveflag 1] [...] [moveflag N]</span>

			Deprecated: <span {{code}}>'''actor''' <picnum> [strength] [action] [move] [moveflag 1] [...] [moveflag N]</span>

	~~<span {{code}}>'''useractor''' <type> <picnum> [strength] [action] [move] [moveflag 1] [...] [moveflag N]</span>~~

	Defines ~~parameters for in-game sprites~~, and ~~allows~~ code to be written for sprites of ~~the specific~~ tile number.		Defines the given tile number as an actor, enabling hardcoded actor behavior, attributes and allowing code to be written for sprites of that tile number.

	The token '''enda''' marks the end of the ~~actor~~.		Loosely speaking, "actors" are sprites that run code in game, such as enemies, breakable objects, etc.

			The token '''actor''' specifies the start of an actor code block, while '''enda''' marks the end of the block.

	'''actor''' MYACTOR		'''actor''' MYACTOR
Line 14:		Line 17:
	[...]		[...]
	'''enda'''		'''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.		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.
Line 21:		Line 22:
	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.		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. Using '''actor''' is identical to '''useractor''' except it's always "notenemy" type.		With the addition of '''useractor''', the old '''actor''' command is deprecated and remains for compatibility reasons. Using '''actor''' is identical to '''useractor''' except that it always uses the "notenemy" type.

	Example:		Example:
Line 33:		Line 34:
	enda		enda

	~~See~~ also [[state]].		To reuse code between actors, see also: [[state]].

	== Parameters ==		== Parameters ==

	All parameters after <picnum> are optional.		All parameters after <picnum> are optional, and receive a default value of 0 if left undefined.

	{\| {{prettytable}}		{\| {{prettytable}}
	\| <type> \|\| is the actor type ~~for special behavior~~. Only used by '''useractor'''.		\| <type> \|\| Defines the actor's hardcoded behavior type. Only used by '''useractor'''.
	\|-		\|-
	\| <picnum> \|\| ~~You can either input~~ a [[define]]~~d name~~, or the tile number ~~directly~~.		\| <picnum> \|\| Either a [[define]] label, or the tile number as a constant. Identifies the tile to be defined as actor.
	\|-		\|-
	\| <strength> \|\| is the health of the actor.		\| [strength] \|\| Defines the initial health of the actor.
	\|-		\|-
	\| <action> \|\| is the ~~intial~~ [[action]] an actor uses.		\| [action] \|\| Defines the initial [[action]] an actor uses when activated.
	\|-		\|-
	\| <move> \|\| is the initial [[move]] of the actor.		\| [move] \|\| Defines the initial [[move]] of the actor when activated.
	\|-		\|-
	\| <moveflag> \|\| ~~is a~~ sequence of ~~parameters~~ that ~~specify certain~~ hard-coded movement behavior.		\| [moveflag]... \|\| A sequence of bit flags that specifies which hard-coded movement behavior to use, see [[move#moveflags\|moveflags]].
	\|}		\|}

Line 60:		Line 61:
	!Value!!DEFS.CON label!![[gameflags]]!!Description		!Value!!DEFS.CON label!![[gameflags]]!!Description
	\|-		\|-
	\|0\|\|notenemy\|\|<font color="gray">(None)</font>\|\|Default. Code begins executing at the start of a level.		\|0\|\|notenemy\|\|<font color="gray">(None)</font>\|\|Default. Code begins executing at the start of a level. Generally used for interactive objects.
	\|-		\|-
	\|1\|\|enemy\|\|SFLAG_BADGUY\|\|Enables hard-coded behavior. Code only begins executing upon player sight.		\|1\|\|enemy\|\|SFLAG_BADGUY\|\|Enables hard-coded enemy 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.		\|2\|\|enemystayput\|\|SFLAG_BADGUY<br>SFLAG_BADGUYSTAYPUT\|\|Same as "enemy" plus the [[actor]] will not leave the [[sector]] it is placed in.

Doom64hunter: Use Fox' code formatting, use square brackets to denote optional arguments

2021-01-10T07:43:47Z

Use Fox' code formatting, use square brackets to denote optional arguments

← Older revision		Revision as of 00:43, 10 January 2021
Line 1:		Line 1:
	'''actor''' <picnum> <strength~~> <~~action~~> <~~move~~> <~~moveflag 1> [...] <moveflag N>		<span {{code}}>'''actor''' <picnum> [strength] [action] [move] [moveflag 1] [...] [moveflag N]</span>

	'''useractor''' <type> <picnum> <strength~~> <~~action~~> <~~move~~> <~~moveflag 1> [...] <moveflag N>		<span {{code}}>'''useractor''' <type> <picnum> [strength] [action] [move] [moveflag 1] [...] [moveflag N]</span>

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

Fox at 11:15, 29 August 2020

2020-08-29T11:15:55Z

← Older revision		Revision as of 04:15, 29 August 2020
Line 21:		Line 21:
	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.		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.		With '''useractor''', the old '''actor''' command is deprecated. Using '''actor''' is identical to '''useractor''' except it's always "notenemy" type.

	Example:		Example:
	define MYACTOR 3585		define MYACTOR 3585

	'''~~actor~~''' MYACTOR 0		'''useractor''' notenemy MYACTOR 0
	ifpdistl 1024		ifpdistl 1024
	{		{

Rob Anybody: Fix typo

2020-08-04T21:37:50Z

Fix typo

← Older revision		Revision as of 14:37, 4 August 2020
Line 1:		Line 1:
	'''actor''' <picnum> <strength> <action> <move> <moveflag 1> [...] <moveflag N>		'''actor''' <picnum> <strength> <action> <move> <moveflag 1> [...] <moveflag N>

	'''useractor''' <type> <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.		Defines parameters for in-game sprites, and allows code to be written for sprites of the specific tile number.

Fox at 07:46, 20 February 2020

2020-02-20T07:46:49Z

← Older revision		Revision as of 00:46, 20 February 2020
Line 21:		Line 21:
	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.		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 ~~the~~ '''useractor''' ~~command~~, '''actor''' is deprecated.		With '''useractor''', the old '''actor''' command is deprecated.

	Example:		Example:

Fox at 07:46, 20 February 2020

2020-02-20T07:46:30Z

← Older revision		Revision as of 00:46, 20 February 2020
Line 21:		Line 21:
	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.		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''', '''actor''' is deprecated.		With the '''useractor''' command, '''actor''' is deprecated.

	Example:		Example:

Fox at 07:46, 20 February 2020

2020-02-20T07:46:14Z

← Older revision		Revision as of 00:46, 20 February 2020
Line 20:		Line 20:

	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.		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''', '''actor''' is deprecated.

	Example:		Example:

Fox: /* Types */

2020-02-20T07:41:55Z

Types

← Older revision		Revision as of 00:41, 20 February 2020
Line 52:		Line 52:

	== Types ==		== Types ==

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

	{\| {{prettytable}}		{\| {{prettytable}}

Fox at 07:34, 20 February 2020

2020-02-20T07:34:24Z

← Older revision		Revision as of 00:34, 20 February 2020
Line 1:		Line 1:
	'''actor''' <~~name~~> <strength> <action> <move> <~~moveflags...~~>~~<br>~~		'''actor''' <picnum> <strength> <action> <move> <moveflag 1> [...] <moveflag N>
	~~:(actor code~~...)<br>
	~~[[enda]]~~

	<~~name~~> ~~is the name/tile of the actor. You can either input a~~ [[~~define~~]~~]d name, or the tile number directly.~~		'''useractor''' <type> <picnum> [strength> <action> <move> <moveflag 1> [...] <moveflag N>

	~~<strength> is the health~~ of the ~~actor~~.		Defines parameters for in-game sprites, and allows code to be written for sprites of the specific tile number.

	~~<action> is~~ the ~~intial [[action]] an~~ actor ~~uses (optional)~~.		The token '''enda''' marks the end of the actor.

	~~<move> is the initial~~ [[~~move~~]~~] of the actor (optional).~~		'''actor''' MYACTOR
			[...]
			'''enda'''

			'''useractor''' notenemy MYACTOR2
			[...]
			'''enda'''

	~~<moveflags...> is is a (possibly empty) sequence of parameters~~ that ~~specify certain hardcoded movement behavior (optional~~, ~~see [[move]])~~.		Loosely speaking, "actors" are sprites that run code in game, such as enemies, breakable objects, etc.

	(actor ~~code...) is~~ the code for ~~the actor~~.		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.

	~~[[enda]] ends an~~ actor.		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.

			Example:
			define MYACTOR 3585

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

	~~Loosely speaking, actors are sprites that run code in game, such as enemies and breakable props. More precisely, an actor is a sprite with a~~ [[~~statnum~~]] of 1. Sprites with that statnum will execute their actor code once every game tic. Prior to version 1.4, only the tile numbers hardcoded to be actors could be actors. In the GAME.CON script file, they were designated by the [[actor]] command.		See also [[state]].

	~~Version 1.4 introduced the [[useractor]] syntax which allows use of any tile number as an actor.~~		== Parameters ==

			All parameters after <picnum> are optional.

	~~Example~~ actor:		{\| {{prettytable}}
	~~define SOMEACTOR 3585~~		\| <type> \|\| is the actor type for special behavior. Only used by '''useractor'''.
			\|-
	'''~~actor~~''' ~~SOMEACTOR 0~~		\| <picnum> \|\| You can either input a [[define]]d name, or the tile number directly.
	~~ifpdistl 1024~~		\|-
	{		\| <strength> \|\| is the health of the actor.
	~~palfrom 32 0 16~~ 0		\|-
	}		\| <action> \|\| is the intial [[action]] an actor uses.
	~~enda~~		\|-
			\| <move> \|\| is the initial [[move]] of the actor.
			\|-
			\| <moveflag> \|\| is a sequence of parameters that specify certain hard-coded movement behavior.
			\|}

			== Types ==

			{\| {{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]]

Helixhorned: ai -> moveflags... this was actually wrong all the time.

2012-06-17T17:59:32Z

ai -> moveflags... this was actually wrong all the time.

← Older revision		Revision as of 10:59, 17 June 2012
Line 1:		Line 1:
	'''actor''' <name> <strength> <action> <move> <ai><br>		'''actor''' <name> <strength> <action> <move> <moveflags...><br>
	:(actor code...)<br>		:(actor code...)<br>
	[[enda]]		[[enda]]
Line 11:		Line 11:
	<move> is the initial [[move]] of the actor (optional).		<move> is the initial [[move]] of the actor (optional).

	<ai> is ~~the actor's initial~~ [[ai]] ~~routine (optional~~).		<moveflags...> is is a (possibly empty) sequence of parameters that specify certain hardcoded movement behavior (optional, see [[move]]).

	(actor code...) is the code for the actor.		(actor code...) is the code for the actor.