EDukeWiki - User contributions [en]

Autostep

2012-12-25T21:28:53Z

Overkill666:

'''''autostep''''' controls the maximum difference in height at which a player will "step" onto a surface without needing to jump. The default value is 5120. Note that autostep applies to view/wall aligned [[sprite]]s and regular [[sector]]s.

Making the value smaller allows the player to climb higher sectors and wall aligned sprites, while a larger value means the player will not be able to climb over smaller and smaller heights in sectors and sprites.

If you are making a permanent change to this value, it is best to do it from [[EVENT_ENTERLEVEL]] so the game never overwrites your value with the default.

For above water sectors ([[lotag]] 1) and floor aligned sprites ([[cstat]] 32) (see [[spritebridge]]) please see [[autostep_sbw]].

[[Category:Player structure members]]

Autostep

2012-12-25T21:27:42Z

Overkill666:

'''''autostep''''' controls the maximum difference in height at which a player will "step" onto a surface without needing to jump. The default value is 5120. Note that autostep applies to view/wall aligned [[sprite]]s and regular [[sector]]s.

Making the value smaller allows the player to climb higher sectors and wall aligned sprites, while a larger value means the player will not be able to climb over smaller and smaller heights in sectors and sprites.

A value of zero means the player can cross a sector with a difference of -9216 z units, and any other value would be added to that difference. For example, the default value of 5120 means the player can cross -4096 units.

If you are making a permanent change to this value, it is best to do it from [[EVENT_ENTERLEVEL]] so the game never overwrites your value with the default.

For above water sectors ([[lotag]] 1) and floor aligned sprites ([[cstat]] 32) (see [[spritebridge]]) please see [[autostep_sbw]].

[[Category:Player structure members]]

Autostep

2012-12-25T21:17:47Z

Overkill666:

'''''autostep''''' controls the maximum difference in height at which a player will "step" onto a surface without needing to jump. The default value is 5120. Note that autostep applies to view/wall aligned [[sprite]]s and regular [[sector]]s.

Making the value smaller allows the player to climb higher sectors and wall aligned sprites, while a larger value means the player will not be able to climb over smaller and smaller heights in sectors and sprites.

A value of zero means the player can cross a sector with a difference of -10240 z units, and any other value would be added to that difference.

If you are making a permanent change to this value, it is best to do it from [[EVENT_ENTERLEVEL]] so the game never overwrites your value with the default.

For above water sectors ([[lotag]] 1) and floor aligned sprites ([[cstat]] 32) (see [[spritebridge]]) please see [[autostep_sbw]].

[[Category:Player structure members]]

Current menu

2012-09-30T05:12:08Z

Overkill666:

When the player is displaying the menu ( the menu when the player presses escape or when game starts ) this gamevar is set to the number corresponding to the menu that the player is currently displaying.

* 0: Main menu (title screen)
* 50: Main menu (game paused)
* 100: Select an episode
* 102: Select a user map
* 110: Select skill
* 200: Game setup
* 201: More game setup
* 202: Options
* 203: Video setup
* 204: Keyboard setup
* 205: Mouse setup
* 212: Advanced mouse setup
* 230: Renderer setup
* 231: Color correction
* 300: Load game
* 351: Save game
* 360: Save game (text box)
* 500: "Are you sure you want to quit?"
* 501: "Quit to title?"
* 700: Sound setup
* 1,000: Load game (confirm)
* 1,500: "Abort this game?"
* 2,000: Save game (confirm)
* 20,002: Player setup
* 20,004: Multiplayer macros
* 20,005: Multiplayer macros (text box)

[[Category:Constantly updated gamevars]]

Current menu

2012-09-30T04:59:01Z

Overkill666:

When the player is displaying the menu ( the menu when the player presses escape or when game starts ) this gamevar is set to the number corresponding to the menu that the player is currently displaying.

* 0: Main menu (title screen)
* 50: Main menu (game paused)
* 100: Select an episode
* 102: Select a user map
* 110: Select skill
* 200: Game setup
* 201: More game setup
* 202: Options
* 203: Video setup
* 204: Keyboard setup
* 205: Mouse setup
* 212: Advanced mouse setup
* 230: Renderer setup
* 231: Color correction
* 300: Load game
* 351: Save game
* 500: "Are you sure you want to quit?"
* 501: "Quit to title?"
* 700: Sound setup
* 20,002: Player setup
* 20,004: Multiplayer macros

[[Category:Constantly updated gamevars]]

Members of the player structure

2012-09-28T22:28:19Z

Overkill666:

The various members of the player structure affect various aspects of the player, and manipulating their values is a very important aspect of scripting in EDuke32. Values can be retrieved from the game's internal player structures and stored in a [[gamevar]] with the [[getplayer]] command, and the [[setplayer]] command allows you to set any of the player structure member's value to that of a gamevar.

Here is the list of members of the player structure:

<div style="column-count:3;-moz-column-count:3;">
Config
*[[aim_mode]]
*[[auto_aim]]
*[[weaponswitch]]
Cheat Codes
*[[cheat_phase]]
Ammo
*[[ammo_amount]]
*[[gotweapon]]
*[[max_ammo_amount]]
Weapons
*[[bobcounter]]
*[[bobposx]]
*[[bobposy]]
*[[crack_time]]
*[[curr_weapon]]
*[[fist_incs]]
*[[hbomb_hold_delay]]
*[[hbomb_on]]
*[[holster_weapon]]
*[[kickback_pic]]
*[[knee_incs]]
*[[knuckle_incs]]
*[[last_full_weapon]]
*[[last_quick_kick]]
*[[last_pissed_time]]
*[[last_weapon]]
*[[quick_kick]]
*[[random_club_frame]]
*[[rapid_fire_hold]]
*[[reloading]]
*[[show_empty_weapon]]
*[[subweapon]]
*[[wantweaponfire]]
*[[weapon_ang]]
*[[weapon_pos]]
*[[weapon_sway]]
*[[weaprecs]][2]
*[[weapreccnt]]
Inventory
*[[boot_amount]]
*[[firstaid_amount]]
*[[got_access]]
*[[heat_amount]]
*[[heat_on]]
*[[holoduke_amount]]
*[[holoduke_on]]
*[[invdisptime]]
*[[inven_icon]]
*[[jetpack_amount]]
*[[jetpack_on]]
*[[refresh_inventory]]
*[[scuba_amount]]
*[[scuba_on]]
*[[shield_amount]]
*[[steroids_amount]]
*[[max_shield_amount]]
Coordinates
*[[ang]]
*[[cursectnum]]
*[[i]]
*[[oang]]
*[[oposx]]
*[[oposy]]
*[[oposz]]
*[[posx]]
*[[posy]]
*[[posz]]
Movements speed
*[[angvel]]
*[[posxv]]
*[[posyv]]
*[[poszv]]
*[[runspeed]]
*[[jumping_counter]]
*[[jumping_toggle]]
*[[movement_lock]]
View
*[[dead_flag]]
*[[horiz]]
*[[horizoff]]
*[[look_ang]]
*[[newowner]]
*[[opyoff]]
*[[over_shoulder_on]]
*[[palookup]]
*[[pals]]
*[[pals_time]]
*[[ohoriz]]
*[[ohorizoff]]
*[[pycount]]
*[[pyoff]]
*[[return_to_center]]
*[[rotscrnang]]
*[[visibility]]
*[[zoom]]
Quotes
*[[fta]]
*[[ftq]]
Score
*[[actors_killed]]
*[[max_actors_killed]]
*[[max_secret_rooms]]
*[[player_par]]
*[[secret_rooms]]
Multiplayer
*[[frag]]
*[[frag_ps]]
*[[fraggedself]]
*[[interface_toggle_flag]]
*[[team]]
Deprecated
*[[exitx]][1]
*[[exity]][1]
*[[lastrandomspot]][1]
*[[loogiex]]
*[[loogiey]]
*[[name]][2]
*[[palette]][2]
*[[randomflamex]][1]

Misc
*[[access_incs]]
*[[access_spritenum]]
*[[access_wallnum]]
*[[actorsqu]]
*[[airleft]]
*[[buttonpalette]]
*[[customexitsound]]
*[[dummyplayersprite]]
*[[extra_extra8]]
*[[falling_counter]]
*[[footprintcount]]
*[[footprintpal]]
*[[footprintshade]]
*[[gm]]
*[[hard_landing]]
*[[hurt_delay]]
*[[last_extra]]
*[[loogcnt]]
*[[max_player_health]]
*[[numloogs]]
*[[on_crane]]
*[[on_ground]]
*[[on_warping_sector]]
*[[one_eighty_count]]
*[[one_parallax_sectnum]]
*[[sbs]]
*[[scream_voice]]
*[[somethingonplayer]]
*[[sound_pitch]]
*[[spritebridge]]
*[[timebeforeexit]]
*[[tipincs]]
*[[toggle_key_flag]]
*[[transporter_hold]]
*[[truefz]]
*[[truecz]]
*[[wackedbyactor]]
*[[walking_snd_toggle]]
</div>

[1] Unused members. The game doesn't use them.<br>
[2] Unavailable members. There is no access to them via CON.

[[Category:Player manipulation]]
[[Category:Structure member documentation]]

Htmovflag

2012-09-23T00:03:21Z

Overkill666:

'''htmovflag''' has a nonzero value if the sprite is using a move command and it bumps into something (htmovflag is set to the return value of the movesprite function).

Depending if the moving sprite is bumping into another sprite, wall, floor or ceiling, a different value will be substracted to the ID of it. For example, the ID of another sprite will be equal to htmovflag + 16384.

[[Category:Sprite structure members]]

Htmovflag

2012-09-23T00:03:11Z

Overkill666:

M recstat

2012-07-28T02:23:41Z

Overkill666: Created page with "Seems to control whenever a demo is being recorded or not."

Seems to control whenever a demo is being recorded or not.

Last weapon

2012-07-18T21:48:14Z

Overkill666:

This is set to the currently selected weapon when the player attempts to switch to another weapon. While the ID of the weapon is changed the instant the weapon starts to change, the tile that is drawn on screen is only set after weapon_pos reaches -9, and during that moment last_weapon is used to store the tile of the last weapon.

See [[WEAPON]] for the list of weapon IDs.

[[Category:Player structure members]]

Last full weapon

2012-07-18T21:44:51Z

Overkill666:

last_full_weapon is initialized to zero when a map is loaded.<BR>
This is set to the currently selected weapon when the player attempts to switch to a new weapon. This is used so that the game can determine which weapon to switch back to in the event that the player attempts to switch to a weapon that is out of ammo.

[[Category:Player structure members]]

PROJ YREPEAT

2012-07-09T07:08:55Z

Overkill666:

PROJ_YREPEAT is a defineprojectile property used to set the y size of the projectile. For hitscan type projectiles this determines the y size of the decal.

Syntax is:

[[defineprojectile]] <tile number> PROJ_YREPEAT <number>

Where <number> is the size you wish to set the projectile's y to.

[[Category:Projectile_structure_members]]

PROJ XREPEAT

2012-07-09T07:08:51Z

Overkill666:

PROJ_XREPEAT is a defineprojectile property used to set the x size of the projectile. For hitscan type projectiles this determines the x size of the decal.

Syntax is:

[[defineprojectile]] <tile number> PROJ_XREPEAT <number>

Where <number> is the size you wish to set the projectile's x to.

[[Category:Projectile_structure_members]]

Clipmask

2012-06-17T01:00:46Z

Overkill666:

Clipmask is a value that tells what kinds of objects should be clipped or not. The lower 16 bits are anded (&) with the [[cstat(wall)|cstat of a wall]] and the higher 16 bits are anded with the [[cstat|cstat of a sprite]]. Clipmask is used by the [[getzrange]], [[hitscan]], and [[movesprite]] commands.

One can calculate a mask using this formula:

clipmask=(sprite_cstat*65536)+wall_cstat

[[cstat|sprite_cstat]] and [[cstat(wall)|wall_cstat]] should have only set the bits which should be clipped.
The most important bits are blockable (flag 1), hitable (flag 64 for walls and 256 for sprites), masking wall (flag 16).

The game has two predefined clipmasks: CLIPMASK0 and CLIPMASK1. Apparently the first one is used by regular actors, while the second is for projectiles.

CLIPMASK0 = (1*65536)+1 = 1 0001h

This clips to blocking sprites (flag 1) and walls (flag 1).

CLIPMASK1 = (256*65536)+64 = 100 0040h

This clips to hitscan sprites (flag 256) and walls (flag 64).

Sample clipmask for [[hitscan]] (4294901808) = FFFF 0030h

This clips sprites which have any flags and walls which are one-sided or masking.

Weaponswitch

2012-06-09T22:09:33Z

Overkill666:

Weaponswitch exists for both player and userdef structure members. The player structure controls whenever the action will be made, while the userdef controls the options selected in the menu.

[[bitfield]]

1 = switch to weapon on pickup

2 = switch away when out of ammo

Setting the variable to zero will disable automatic weapon switching.

Example:

setplayer[THISACTOR].weaponswitch 0

[[Category:Bitfields]]
[[Category:Userdef structure members]]

EVENT EGS

2012-05-27T02:55:36Z

Overkill666: Maybe not?

EVENT_EGS is a [[EDuke32_event_list|Game Event]].

This [[event]] is triggered when any sprite is spawned on the map. Like [[EVENT_GAME]], this event run for all actors, thus the gamevar [[THISACTOR]] refers to the ID of the sprite that is executing the code.

This event occurs the moment a sprite is spawned.
useractor notenemy ACTOR
espawn PIGCOP
ifvarg RETURN -1
setactor[RETURN].pal 1
enda

onevent EVENT_EGS
ifactor PIGCOP
spritepal 2
endevent
In this case, the PIGCOP palette will be 1, because the EVENT_EGS code is triggered before the lines below the [[spawn]] command.

This event does not run for sprites present in the map file. For those, try [[EVENT_SPAWN]] or [[EVENT_LOADACTOR]].

[[Category:Events]]

EVENT EGS

2012-05-27T02:52:01Z

Overkill666:

EVENT_EGS (aka Enter Game Spawn) is a [[EDuke32_event_list|Game Event]].

This [[event]] is triggered when any sprite is spawned on the map. Like [[EVENT_GAME]], this event run for all actors, thus the gamevar [[THISACTOR]] refers to the ID of the sprite that is executing the code.

This event occurs the moment a sprite is spawned.
useractor notenemy ACTOR
espawn PIGCOP
ifvarg RETURN -1
setactor[RETURN].pal 1
enda

onevent EVENT_EGS
ifactor PIGCOP
spritepal 2
endevent
In this case, the PIGCOP palette will be 1, because the EVENT_EGS code is triggered before the lines below the [[spawn]] command.

This event does not run for sprites present in the map file. For those, try [[EVENT_SPAWN]] or [[EVENT_LOADACTOR]].

[[Category:Events]]