Category:Structure access - Revision history

Oasiz: Add missing shorthands to the table, relocate few existing ones to the dedicated column

2026-01-15T18:08:07Z

Add missing shorthands to the table, relocate few existing ones to the dedicated column

← Older revision		Revision as of 11:08, 15 January 2026
Line 40:		Line 40:

	{\| {{prettytablebordered}}		{\| {{prettytablebordered}}
	!Get/Set Name!!Quick Name!!ID type!![[THISACTOR]] meaning!!Description!!Notes		!Get/Set Name!!Quick Name!!Shorthand!!ID type!![[THISACTOR]] meaning!!Description!!Notes
	\|-		\|-
	\|[[Members of the sprite, hittype, and spriteext structures\|actor]]		\|[[Members of the sprite, hittype, and spriteext structures\|actor]]
	\|[[Members of the sprite, hittype, and spriteext structures\|sprite]]		\|[[Members of the sprite, hittype, and spriteext structures\|sprite]]
			\| a
	\|[[sprite id]]		\|[[sprite id]]
	\|current sprite		\|current sprite
Line 50:		Line 51:
	\|-		\|-
	\|colspan="2"\|actorvar		\|colspan="2"\|actorvar
			\| av
	\|[[sprite id]]		\|[[sprite id]]
	\|current sprite		\|current sprite
Line 56:		Line 58:
	\|-		\|-
	\|colspan="2"\|[[Members of the tsprite structure\|tspr]]		\|colspan="2"\|[[Members of the tsprite structure\|tspr]]
			\|
	\|[[sprite id]]		\|[[sprite id]]
	\|current sprite		\|current sprite
Line 62:		Line 65:
	\|-		\|-
	\|colspan="2"\|[[Members of the projectile structure\|projectile]]		\|colspan="2"\|[[Members of the projectile structure\|projectile]]
			\|
	\|[[tile number]]		\|[[tile number]]
	\|(none)		\|(none)
Line 68:		Line 72:
	\|-		\|-
	\|colspan="2"\|[[Members of the projectile structure\|thisprojectile]]		\|colspan="2"\|[[Members of the projectile structure\|thisprojectile]]
			\|
	\|[[sprite id]]		\|[[sprite id]]
	\|current sprite		\|current sprite
Line 74:		Line 79:
	\|-		\|-
	\|colspan="2"\|[[Members of the sector structure\|sector]]		\|colspan="2"\|[[Members of the sector structure\|sector]]
			\| s
	\|[[sector id]]		\|[[sector id]]
	\|current sprite's sector		\|current sprite's sector
Line 80:		Line 86:
	\|-		\|-
	\|colspan="2"\|[[Members of the wall structure\|wall]]		\|colspan="2"\|[[Members of the wall structure\|wall]]
			\| w
	\|[[wall id]]		\|[[wall id]]
	\|(none)		\|(none)
Line 86:		Line 93:
	\|-		\|-
	\|colspan="2"\|[[Members of the player structure\|player]]		\|colspan="2"\|[[Members of the player structure\|player]]
			\| p
	\|[[player id]]		\|[[player id]]
	\|current player		\|current player
	\|players		\|players
	\| ~~getp can be used as a shorthand.~~		\|
	\|-		\|-
	\|colspan="2"\|playervar		\|colspan="2"\|playervar
			\| pv
	\|[[player id]]		\|[[player id]]
	\|current player		\|current player
	\|per-player gamevars		\|per-player gamevars
	\| ~~getpv can be used as a shorthand.~~		\|
	\|-		\|-
	\|colspan="2"\|[[Members of the input structure\|input]]		\|colspan="2"\|[[Members of the input structure\|input]]
			\| i
	\|[[player id]]		\|[[player id]]
	\|current player		\|current player
	\|input		\|input
	\|Generally used within [[EVENT_PROCESSINPUT]]~~; geti can be used as a shorthand.~~		\|Generally used within [[EVENT_PROCESSINPUT]]
	\|-		\|-
	\|colspan="2"\|[[Members of the userdef structure\|userdef]]		\|colspan="2"\|[[Members of the userdef structure\|userdef]]
			\| u
	\|(none)		\|(none)
	\|(none)		\|(none)
	\|user preferences, game state		\|user preferences, game state
	\|Use nothing within the brackets~~; getu can be used as a shorthand.~~		\|Use nothing within the brackets
	\|-		\|-
	\|colspan="2"\|[[Members of the tiledata structure\|tiledata]]		\|colspan="2"\|[[Members of the tiledata structure\|tiledata]]
			\|
	\|[[tile number]]		\|[[tile number]]
	\|current sprite's picnum		\|current sprite's picnum
Line 117:		Line 129:
	\|(none)		\|(none)
	\|[[Members of the paldata structure\|paldata]]		\|[[Members of the paldata structure\|paldata]]
			\|
	\|[[palookup number]]		\|[[palookup number]]
	\|(none)		\|(none)
Line 123:		Line 136:
	\|}		\|}

			Shorthands above can be seen as aliases, i.e. <code>getav</code> == <code>getactorvar</code>.
	[[Category:EDuke32 end-user documentation]]		[[Category:EDuke32 end-user documentation]]
	[[Category:Scripting documentation]]		[[Category:Scripting documentation]]

Jblade at 10:01, 2 August 2020

2020-08-02T10:01:43Z

← Older revision		Revision as of 03:01, 2 August 2020
Line 107:		Line 107:
	\|(none)		\|(none)
	\|user preferences, game state		\|user preferences, game state
	\|Use nothing within the brackets.		\|Use nothing within the brackets; getu can be used as a shorthand.
	\|-		\|-
	\|colspan="2"\|[[Members of the tiledata structure\|tiledata]]		\|colspan="2"\|[[Members of the tiledata structure\|tiledata]]

Jblade at 10:00, 2 August 2020

2020-08-02T10:00:26Z

← Older revision		Revision as of 03:00, 2 August 2020
Line 89:		Line 89:
	\|current player		\|current player
	\|players		\|players
	\| getp can be used as a shorthand		\| getp can be used as a shorthand.
	\|-		\|-
	\|colspan="2"\|playervar		\|colspan="2"\|playervar
Line 95:		Line 95:
	\|current player		\|current player
	\|per-player gamevars		\|per-player gamevars
	\| getpv can be used as a shorthand		\| getpv can be used as a shorthand.
	\|-		\|-
	\|colspan="2"\|[[Members of the input structure\|input]]		\|colspan="2"\|[[Members of the input structure\|input]]
Line 101:		Line 101:
	\|current player		\|current player
	\|input		\|input
	\|Generally used within [[EVENT_PROCESSINPUT]].		\|Generally used within [[EVENT_PROCESSINPUT]]; geti can be used as a shorthand.
	\|-		\|-
	\|colspan="2"\|[[Members of the userdef structure\|userdef]]		\|colspan="2"\|[[Members of the userdef structure\|userdef]]

Jblade at 09:58, 2 August 2020

2020-08-02T09:58:00Z

← Older revision		Revision as of 02:58, 2 August 2020
Line 89:		Line 89:
	\|current player		\|current player
	\|players		\|players
	\|		\| getp can be used as a shorthand
	\|-		\|-
	\|colspan="2"\|playervar		\|colspan="2"\|playervar
Line 95:		Line 95:
	\|current player		\|current player
	\|per-player gamevars		\|per-player gamevars
	\|		\| getpv can be used as a shorthand
	\|-		\|-
	\|colspan="2"\|[[Members of the input structure\|input]]		\|colspan="2"\|[[Members of the input structure\|input]]

Hendricks266: /* Structs */

2018-03-15T03:59:22Z

Structs

← Older revision		Revision as of 20:59, 14 March 2018
Line 109:		Line 109:
	\|Use nothing within the brackets.		\|Use nothing within the brackets.
	\|-		\|-
	\|~~[[Members of the tiledata structure\|tiledata]]~~		\|colspan="2"\|[[Members of the tiledata structure\|tiledata]]
	\|[[Members of the tiledata structure\|tiledata]]
	\|[[tile number]]		\|[[tile number]]
	\|current sprite's picnum		\|current sprite's picnum

StrikerTheHedgefox: /* Structs */

2018-03-15T01:41:40Z

Structs

← Older revision		Revision as of 18:41, 14 March 2018
Line 109:		Line 109:
	\|Use nothing within the brackets.		\|Use nothing within the brackets.
	\|-		\|-
	\|~~(none)~~		\|[[Members of the tiledata structure\|tiledata]]
	\|[[Members of the tiledata structure\|tiledata]]		\|[[Members of the tiledata structure\|tiledata]]
	\|[[tile number]]		\|[[tile number]]
	\|~~(none)~~		\|current sprite's picnum
	\|art tiles		\|art tiles
	\|		\|

Hendricks266 at 21:45, 31 January 2016

2016-01-31T21:45:26Z

← Older revision		Revision as of 14:45, 31 January 2016
Line 18:		Line 18:

	The '''set''' commands assign the value provided to the member.		The '''set''' commands assign the value provided to the member.

			<id> can be omitted entirely, which implies an id of [[THISACTOR]].

	The commands with the "var" suffix are used to access custom members for a struct, which are really just that ID's gamevars which have the per-<struct> flag set. So <code>setactorvar[THISACTOR].temp 0</code> is the same as <code>setvar temp 0</code>.		The commands with the "var" suffix are used to access custom members for a struct, which are really just that ID's gamevars which have the per-<struct> flag set. So <code>setactorvar[THISACTOR].temp 0</code> is the same as <code>setvar temp 0</code>.

Hendricks266 at 04:28, 4 April 2015

2015-04-04T04:28:29Z

Show changes

Hendricks266 at 02:08, 4 April 2015

2015-04-04T02:08:45Z

← Older revision		Revision as of 19:08, 3 April 2015
Line 1:		Line 1:
			get<struct>[<id>].<[[Full list of structure members\|member]]> <[[gamevar]]><br>
			set<struct>[<id>].<[[Full list of structure members\|member]]> <value><br>
			get<struct>var[<id>].<[[gamevar]]> <[[gamevar]]><br>
			set<struct>var[<id>].<[[gamevar]]> <value><br>
			getuserdef .<[[Members of the userdef structure\|member]]> <[[gamevar]]><br>
			setuserdef .<[[Members of the userdef structure\|member]]> <value><br>

			The '''get''' commands fetch one of the [[Full list of structure members\|members of a structure]] into a [[gamevar]].

			The '''set''' commands assign the value provided to the member.

			The commands with the "var" suffix are used to access custom members for a struct, which are really just that ID's gamevars which have the per-<struct> flag set. So <code>setactorvar[THISACTOR].temp 0</code> is the same as <code>setvar temp 0</code>.

			{\| {{prettytable}}
			!Struct!!ID type!!<nowiki>-</nowiki>'''var'''<nowiki>?</nowiki>!!Description!!Notes!!
			\|-
			\|[[Members of the sprite, hittype, and spriteext structures\|actor]]
			\|[[sprite id]]
			\|Yes
			\|sprites and hittypes
			\|You can use [[THISACTOR]] as the id for current sprite.
			\|-
			\|[[Members of the tsprite structure\|tspr]]
			\|[[sprite id]]
			\|No
			\|sprites' display properties
			\|Can only be used within [[EVENT_ANIMATESPRITES]] on sprites with [[mdflags]] containing flag 16.<br>You can use [[THISACTOR]] as the id for current sprite.
			\|-
			\|[[Members of the projectile structure\|projectile]]
			\|[[tile number]]
			\|No
			\|projectile types
			\|
			\|-
			\|[[Members of the projectile structure\|thisprojectile]]
			\|[[sprite id]]
			\|No
			\|individual projectiles
			\|You can use [[THISACTOR]] as the id for current sprite.
			\|-
			\|[[Members of the sector structure\|sector]]
			\|[[sector id]]
			\|No
			\|sectors, floors, and ceilings
			\|You can use [[THISACTOR]] as the sector id for the sector in which the current actor is in.
			\|-
			\|[[Members of the wall structure\|wall]]
			\|[[wall id]]
			\|No
			\|walls
			\|
			\|-
			\|[[Members of the player structure\|player]]
			\|[[yvel\|player id]]
			\|Yes
			\|players
			\|The player id is usually [[THISACTOR]], but [[screenpeek]] and [[myconnectindex]] are technically possible.
			\|-
			\|[[Members of the input structure\|input]]
			\|[[yvel\|player id]]
			\|No
			\|input
			\|Generally used within [[EVENT_PROCESSINPUT]].<br>The player id is usually provided by [[THISACTOR]]. It is unknown whether other values are useful or applicable.
			\|-
			\|[[Members of the userdef structure\|userdef]]
			\|(none)
			\|No
			\|user preferences, game state
			\|Brackets are not required.
			\|}

	[[Category:EDuke32 end-user documentation]]		[[Category:EDuke32 end-user documentation]]
	[[Category:Scripting documentation]]		[[Category:Scripting documentation]]

Hendricks266: Hendricks266 moved page Category:Structure member documentation to Category:Structure access

2015-04-04T02:00:47Z

Hendricks266 moved page Category:Structure member documentation to Category:Structure access

← Older revision		Revision as of 19:00, 3 April 2015
(No difference)