Structure access: Difference between revisions

From EDukeWiki
Jump to navigation Jump to search
Created page with "get<struct>[<id>].<member> <gamevar><br> get<struct>var[<id>].<member> <gamevar><br> set<struct>[<id..."
 
Redirected page to Category:Structure access
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
get<struct>[<id>].<[[Full list of structure members|member]]> <[[gamevar]]><br>
#REDIRECT [[:Category:Structure access]]
get<struct>var[<id>].<[[Full list of structure members|member]]> <[[gamevar]]><br>
set<struct>[<id>].<[[Full list of structure members|member]]> <value><br>
set<struct>var[<id>].<[[Full list of structure members|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!!
|-
|actor
|[[sprite id]]
|Yes
|sprites and hittypes
|You can use [[THISACTOR]] as the id for current sprite.
|-
|tspr
|[[sprite id]]
|No
|sprites' display properties
|Can only be used within [[EVENT_ANIMATESPRITES]] on sprites with [[mdflags]] containing flag 16. You can use [[THISACTOR]] as the id for current sprite.
|-
|projectile
|[[tile number]]
|No
|projectile types
|
|-
|thisprojectile
|[[sprite id]]
|No
|individual projectiles
|You can use [[THISACTOR]] as the id for current sprite.
|-
|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.
|-
|wall
|[[wall id]]
|No
|walls
|
|-
|player
|[[player id]]
|Yes
|players
|The player id can be [[THISACTOR]], [[screenpeek]], or [[myconnectindex]], though using myconnectindex is strongly recommended against.
|-
|input
|[[player id]]
|No
|input
|Can only be used within [[EVENT_PROCESSINPUT]].  The player id is usually provided by [[THISACTOR]].  It is unknown whether other values are useful or applicable.
|-
|userdef
|(none)
|No
|user preferences
|Use [[THISACTOR]] for the id.
|}
 
[[Category:Structure member documentation]]

Latest revision as of 18:09, 3 April 2015