EDukeWiki - User contributions [en]

Sectsetinterpolation

2025-01-03T14:04:59Z

Sangman: recreate cause I needed it

'''sectsetinterpolation''' <sectnum>

Applies interpolation on the movement of a specific sector.
Useful for smoothing sector movement executed via CON, typically by moving its wallpoints using [[dragpoint]].

Sector coordinates update every 30 tics, which will look jittery by default. This command as the name suggests will enable interpolation of these updates.

== Parameters ==

{| {{prettytable}}
| <sectnum> || Number of the sector.
|-
|}

Somethingonplayer

2023-12-03T22:08:29Z

Sangman:

If a slimer is currently attached to the player, this holds the slimer's sprite ID. Otherwise, this is -1.

To kill the slimer from code, we can't just apply [[htextra]] as we would expect, the correct way to kill a facehugging slimer is this:

<pre>
ifn player[].somethingonplayer -1
{
seta[player[].somethingonplayer].htextra 1
seta[player[].somethingonplayer].htg_t 0 0
setp[].somethingonplayer -1
}
</pre>

[[Category:Player structure members]]

Somethingonplayer

2023-12-03T22:07:59Z

Sangman:

If a slimer is currently attached to the player, this holds the slimer's sprite ID. Otherwise, this is -1.

To kill the slimer from code, we can't just apply [[htextra]] as we would expect, the correct way to kill a facehugging slimer is this:

<code>
ifn player[].somethingonplayer -1
{
seta[player[].somethingonplayer].htextra 1
seta[player[].somethingonplayer].htg_t 0 0
setp[].somethingonplayer -1
}
</code>

[[Category:Player structure members]]

Quote

2023-11-26T20:58:35Z

Sangman: Specified fta/ftq

'''quote''' <quote number>

Causes the quote <quote number> as defined by [[definequote]] to be displayed on the top of the screen, center aligned. The quote fades out after two seconds. This command requires a context where the player is defined, e.g. it cannot be used in [[EVENT_LOADACTOR]].

Quotes also appear in the console and log file, but when the same quote is displayed multiple times in a row, only the first instance will appear in the console and log. This applies ''even if the quote has been redefined''. To log things for debugging or analysis, consider [[userquote]] instead.

This command will only accept a numeric constant, however it is possible to display a quote number that is specified in a variable. For this, see player structure members [[fta]] and [[ftq]]. Set fta to 99 and ftq to the variable.

[[Category:Duke3D 1.3/1.5 commands]]
[[Category:Screen drawing commands]]
[[Category:String manipulation]]

Avel

2023-11-09T21:40:00Z

Sangman:

The avel member of the input structure holds the value of the player's current "angle velocity", corresponding to the analog input assigned to turning. Digital turning normally sets this to +/-30.

The avel/q16avel member can be modified to slow down the player's turn rate, but for such a scenario this must be done using the event EVENT_PREUPDATEANGLES.
[[Category:Input structure members]]

Checkactivatormotion

2022-12-30T01:23:20Z

Sangman: corrected var name

'''checkactivatormotion''' <lotag>

Checks to see if the activator with the lotag specified is in motion or not - if it is, than [[RETURN]] is set to 1.

==Detecting MasterSwitch motion==
'''checkactivatormotion''' only detects activator motions, but it won't return 1 if it's a delayed masterswitch that goes off.
Fortunately, there is a way to check for this. When a MasterSwitch starts moving, the sprite is deleted, meaning that we can catch it in EVENT_KILLIT and act appropriately.

One way to handle this:
<pre>
var MASTERSWITCH_SUBSCRIPTION 0 2
var MASTERSWITCH_RETURN 0 2
var temp 0 2
var temp2 0 2

appendevent EVENT_KILLIT
ifactor MASTERSWITCH
{
for temp sprofstat 1
{
getav[temp].MASTERSWITCH_SUBSCRIPTION temp2

ife temp2 sprite[].lotag
setav[temp].MASTERSWITCH_RETURN 1
}
}
endevent

useractor notenemy MASTERSWITCHHANDLER // this actor has to do something if it detects the masterswitch is moving
set MASTERSWITCH_SUBSCRIPTION <lotag to check>
ife MASTERSWITCH_RETURN 1
{
// do stuff
set MASTERSWITCH_RETURN 0 // remember to reset this or whatever code will keep triggering
}
enda
</pre>

[[Category:EDuke32 specific commands]]

Sizeto

2021-11-15T21:44:50Z

Sangman: Some input from Dan

'''sizeto''' <xrepeat> <yrepeat>

Gradually sizes the current [[actor]]'s x and y sizes to the given values. 64 64 is the default sprite size. See [[sizeat]].
The speed of the sizing can be increased by calling sizeto multiple times in a row.

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

Validate maximum difference between two angles

2021-04-06T15:03:14Z

Sangman:

In this example code, we will validate that angle A does not exceed angle B by 512 units. If it does, RETURN is set to 1.
It assumes temp, temp2 and temp3 variables are declared.
The tricky part in this comparison is that angles wrap back around to 0 when reaching 2048, this must be taken into account when comparing angle difference.

<pre>
var MAX_ANGLE_DIFF 0 2
var ANGLE_A 0 2
var ANGLE_B
defstate check_max_angle_diff
set temp2 ANGLE_B
sub temp2 MAX_ANGLE_DIFF

set temp3 ANGLE_B
add temp3 MAX_ANGLE_DIFF

ifl temp2 0
add temp2 2048

ifge temp3 2048
sub temp3 2048

set temp 0
set RETURN 0
ifl temp3 temp2
{
// we wrapped around the 0/2048 line, either case is enough
ifl ANGLE_A temp3
set temp 1
else ifg ANGLE_A temp2
set temp 1
}
else
{
// we didn't wrap around so needs to be inbetween [temp2-temp3]
ifge ANGLE_A temp2
ifle ANGLE_A temp3
set temp 1
}

ife temp 1
set RETURN 0
else
set RETURN 1
ends
</pre>

The state can be called like this
<pre>
// determine some angles, store in ANGLE_A and ANGLE_B
set MAX_ANGLE_DIFF 512
state check_max_angle_diff
// Return 0 means we're within 512 angle units
ife RETURN 0
{
// do stuff
}
// or if we're outside the range
else
{
// do other stuff
}
</pre>

[[Category: Tutorials]]

Validate maximum difference between two angles

2021-04-06T15:01:11Z

Sangman: Added tutorial for something that was doing my head in last night

Tutorials

2021-04-06T14:56:16Z

Sangman:

These are a few basic tutorials which show off some things made possible by EDuke32's enhanced [[scripting]] system. Want more examples? Download one of the many existing EDuke32 mods, open up the CON files and dig in!

If you're completely new to CON and are unfamiliar with scripting in general, we recommend reading [[Confaq42]] first followed by reading the basics in [[Scripting]], then tinkering with Duke3D's GAME.CON based on what you've learned.

==Table of Tutorials==
<table width=80% class=wikitable>
<tr>
<th rowspan=1>Name</th>
<th colspan=5>Difficulty Level 1 - 4</th>
</tr>
<tr align=center>
<td>[[Artificial_Intelligence_101|Artificial Intelligence 101]]</td>
<td></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_Change_the_Loading_Screen_Background|Change the loading screen background]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Value_controlled_rain_code|Control rain on a fine scale]]</td>
<td>*</td>
<td>*</td>
<td>*</td>
<td>*</td>
</tr>
<tr align=center>
<td>[[Breakable Actor|Create Breakable Actors]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_display_negative_numbers_with_the_digital_font|Display negative numbers with the digital font]]</td>
<td>*</td>
<td>*</td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Eliminate_Shrunk_Enemies_Attacking_Bug|Eliminate the "shrunk enemies attacking" bug]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_manually_reload|How to code a manual reload for the pistol]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Improve_The_Third_Person_View_with_Zoom|Improve the third person view with zoom]]</td>
<td>*</td>
<td>*</td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Limit_the_height_of_the_player's_jump|Limit/extend the player's jumping height]]</td>
<td>*</td>
<td>*</td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_make_a_health_bar|Make a health bar]]</td>
<td>*</td>
<td>*</td>
<td>*</td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_make_a_clock|Make a in-game clock]]</td>
<td>*</td>
<td>*</td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_make_a_sprint_key|Make a sprint key]]</td>
<td>*</td>
<td>*</td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_Make_a_Working_Keypad|Make a working keypad]]</td>
<td>*</td>
<td>*</td>
<td>*</td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_Shoot_Different_Kinds_of_RPGs|Make actors shoot different types of RPGs]]</td>
<td>*</td>
<td>*</td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Make_actor_aim_vertical|Make an actor aim vertically at another]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_Make_Controllable_Security_Cameras|Make controllable security cameras]]</td>
<td>*</td>
<td>*</td>
<td>*</td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_Make_Models_Pitch|Make models pitch on sloped surfaces]]</td>
<td>*</td>
<td>*</td>
<td>*</td>
<td>*</td>
</tr>
<tr align=center>
<td>[[Make_one_actor_face_another|Make one actor face another]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Validate_maximum_difference_between_two_angles|Validate maximum difference between two angles]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Make_Nightvision_light_rooms|Make the night vision goggles light up darkened areas]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_Make_the_Player_Swim_Like_Modern_FPS|Make the player swim like in a modern FPS]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[How_to_Make_the_Screen_Tilt_While_Using_Jetpack|Make the screen tilt while using jetpack]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Prevent_fall_damage_or_falling_death|Prevent damage/death from long falls]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Eliminate_player_self-damage|Prevent players/actors from inflicting self-damage]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
<tr align=center>
<td>[[Play a movie file when starting an episode]]</td>
<td>*</td>
<td></td>
<td></td>
<td></td>
</tr>
</table>
</noinclude>

[[Category: Tutorials]]

Floorbunch

2021-03-26T00:16:13Z

Sangman: Created page with "Returns the bunch number of a TROR layer, if any. Returns -1 if the floor is not part of a bunch. See Room Over Room. Category:Sector structure members"

Returns the bunch number of a TROR layer, if any. Returns -1 if the floor is not part of a bunch.

See [[Room Over Room]].

[[Category:Sector structure members]]

Ceilingbunch

2021-03-26T00:16:05Z

Sangman: Created page with "Returns the bunch number of a TROR layer, if any. Returns -1 if the ceiling is not part of a bunch. See Room Over Room. Category:Sector structure members"

Returns the bunch number of a TROR layer, if any. Returns -1 if the ceiling is not part of a bunch.

See [[Room Over Room]].

[[Category:Sector structure members]]

Checkactivatormotion

2021-03-25T20:35:52Z

Sangman: formatting

'''checkactivatormotion''' <lotag>

Checks to see if the activator with the lotag specified is in motion or not - if it is, than [[RETURN]] is set to 1.

==Detecting MasterSwitch motion==
'''checkactivatormotion''' only detects activator motions, but it won't return 1 if it's a delayed masterswitch that goes off.
Fortunately, there is a way to check for this. When a MasterSwitch starts moving, the sprite is deleted, meaning that we can catch it in EVENT_KILLIT and act appropriately.

One way to handle this:
<pre>
var MASTERSWITCH_SUBSCRIPTION 0 2
var MASTERSWITCH_RETURN 0 2
var temp 0 2
var temp2 0 2

appendevent EVENT_KILLIT
ifactor MASTERSWITCH
{
for temp sprofstat 1
{
getav[temp].MASTERSWITCH_SUBSCRIBE temp2

ife temp2 sprite[].lotag
setav[temp].MASTERSWITCH_RETURN 1
}
}
endevent

useractor notenemy MASTERSWITCHHANDLER // this actor has to do something if it detects the masterswitch is moving
set MASTERSWITCH_SUBSCRIPTION <lotag to check>
ife MASTERSWITCH_RETURN 1
{
// do stuff
set MASTERSWITCH_RETURN 0 // remember to reset this or whatever code will keep triggering
}
enda
</pre>

[[Category:EDuke32 specific commands]]

Checkactivatormotion

2021-03-25T20:35:40Z

Sangman: formatting

'''checkactivatormotion''' <lotag>

Checks to see if the activator with the lotag specified is in motion or not - if it is, than [[RETURN]] is set to 1.

==Detecting MasterSwitch motion==
'''checkactivatormotion''' only detects activator motions, but it won't return 1 if it's a delayed masterswitch that goes off.
Fortunately, there is a way to check for this. When a MasterSwitch starts moving, the sprite is deleted, meaning that we can catch it in EVENT_KILLIT and act appropriately.

One way to handle this:
<pre>
var MASTERSWITCH_SUBSCRIPTION 0 2
var MASTERSWITCH_RETURN 0 2
var temp 0 2
var temp2 0 2

appendevent EVENT_KILLIT
ifactor MASTERSWITCH
{
for temp sprofstat 1
{
getav[temp].MASTERSWITCH_SUBSCRIBE temp2

ife temp2 sprite[].lotag
setav[temp].MASTERSWITCH_RETURN 1
}
}
endevent

useractor notenemy MASTERSWITCHHANDLER // this actor has to do something if it detects the masterswitch is moving
set MASTERSWITCH_SUBSCRIPTION <lotag to check>
ife MASTERSWITCH_RETURN 1
{
// do stuff
set MASTERSWITCH_RETURN 0 // remember to reset this or whatever code will keep triggering
}
enda
</pre>

[[Category:EDuke32 specific commands]]

Checkactivatormotion

2021-03-25T20:34:55Z

Sangman: Described how to calculate the same thing for masterswitches

'''checkactivatormotion''' <lotag>

Checks to see if the activator with the lotag specified is in motion or not - if it is, than [[RETURN]] is set to 1.

==Detecting MasterSwitch motion==
'''checkactivatormotion''' only detects activator motions, but it won't return 1 if it's a delayed masterswitch that goes off.
Fortunately, there is a way to check for this. When a MasterSwitch starts moving, the sprite is deleted, meaning that we can catch it in EVENT_KILLIT and act appropriately.

One way to handle this:
<pre>
var MASTERSWITCH_SUBSCRIPTION 0 2
var MASTERSWITCH_RETURN 0 2
var temp 0 2
var temp2 0 2

appendevent EVENT_KILLIT
ifactor MASTERSWITCH
{
for temp sprofstat 1
{
getav[temp].MASTERSWITCH_SUBSCRIBE temp2

ife temp2 sprite[].lotag
setav[temp].MASTERSWITCH_RETURN 1
}
}
endevent

useractor notenemy MASTERSWITCHHANDLER // this actor has to do something if it detects the masterswitch is moving
set MASTERSWITCH_SUBSCRIPTION <lotag to check>
ife MASTERSWITCH_RETURN 1
{
// do stuff
set MASTERSWITCH_RETURN 0 // remember to reset this or whatever code will keep triggering
}
enda
</pre>

[[Category:EDuke32 specific commands]]

Movesprite

2020-12-04T00:53:44Z

Sangman: Velocity calculation example

'''movesprite''' <[[sprite id]]> <xvel> <yvel> <zvel> <[[clipmask]]> <returnvar>

''This page is incomplete. Please help us by filling in additional information.''

movesprite gives the capability to move an [[actor]] along an arbitrary x, y, or z velocity and adjust the [[clipmask]] used, thereby changing what the actor will collide with. The variable <returnvar> will equal [[htmovflag]], which will be either 0 or the id of what was hit. This is sectioned by different areas of the struct. <s>Add 16384 to <returnvar> to get the result of the sprite structure member that may have been hit for example.</s>

'''Critical notes:''' It is possible that <zvel> will be non-functional unless "fall" is called immediately before movesprite. Also movesprite and [[move]] commands do not mix well. You are likely to get unintended results.

===Calculating appropriate velocity values===
With the regular move command we can simply pass in a horizontal speed value, but for movesprite we need to separate this into velocities on the x and y axis.
Here's one method of doing this:

<pre>
defstate movesprite_state
geta[].ang angvar
cos my_cos angvar
sin my_sin angvar

// divide or multiply the cos and sin values to change the speed.
// default result is already quite fast so you probably want to divide (shiftr)
shiftr my_cos 4
shiftr my_sin 4

movesprite THISACTOR my_cos my_sin zvel CLIPMASK0 RETURN
ends
</pre>

[[Category:EDuke32 specific commands]]
[[Category:Sprite manipulation]]

Move

2020-12-04T00:49:48Z

Sangman: Link to movesprite

A move command is used to give velocity to an [[actor]].

Define outside an actor as so:

'''move''' <name> <horizontal> <vertical>

<name> is the name of the move command.

Warning: You '''cannot''' use the same name from a [[define]], or the game will crash.

<horizontal> is the horizontal velocity of the [[actor]]. Negative values reverse direction.

<vertical> is the vertical veloctity of the [[actor]]. Negative values cause upward motion.

Used inside an [[actor]], a move command is written as:

'''move''' <name> <moveflags...>

<moveflags...> is a (possibly empty) sequence of parameters that specify certain hardcoded movement behavior.

You '''cannot''' substitute <name> for a number, define, or gamevar. It has to be predefined with the first definition of move.

If your case requires the actor moving clips through sprites and/or walls, you need to pass in a custom clipmask. This command does not support that, see [[movesprite]].

==moveflags==

Values for each <moveflag> (defined in DEFS.CON) are:

{| {{prettytable}}
!moveflag!!description!!internal value!!
|-
|faceplayer
|[[actor]] faces the player.
|align="right"|'''1'''
|-
|geth
|use horizontal velocity.
|align="right"|'''2'''
|-
|getv
|use vertical velocity.
|align="right"|'''4'''
|-
|randomangle
|[[actor]] will face random direction.
|align="right"|'''8'''
|-
|faceplayerslow
|same as faceplayer, but done gradually.
|align="right"|'''16'''
|-
|spin
|spin in a clockwise circle.
|align="right"|'''32'''
|-
|faceplayersmart
|same as faceplayer, but with a slight "lead" on position.
|align="right"|'''64'''
|-
|fleeenemy
|[[actor]] faces away from the player.
|align="right"|'''128'''
|-
|jumptoplayer
|[[actor]] will move vertically and then fall as if jumping.
|align="right"|'''257'''*
|-
|seekplayer
|[[actor]] will try to find the best path to the nearest player.
|align="right"|'''512'''
|-
|furthestdir
|[[actor]] faces the furthest distance from the closest player.
|align="right"|'''1024'''
|-
|dodgebullet
|[[actor]] attempts to avoid all shots directed at him. The [[actor]] will not avoid GROWSPARK.
|align="right"|'''4096'''
|}

==Making a Useractor move==
A [[useractor]] can be made to move as part of a given [[action]]. The type of the useractor (ie. Enemy/Notenemy) has an impact on how this functions.
Typically one might expect that we can apply the move on each tic of the action but it doesn't work that way for type Enemy. For that type, a move is started with a "momentum". If it is applied on each tic, the actor will not move at all. On each tic it must be checked if the actor is already moving, and only call the move if they aren't.

This behaviour does not occur for a Notenemy useractor type.

In other words, for a Notenemy, this is sufficient:
<pre>
ifaction MYACTION
{
move mymove // and apply whatever other flags, e.g. geth
}
</pre>

For an Enemy, use this:
<pre>
ifaction MYACTION
{
ifmove mymove {} // alternatively: ifmove mymove nullop
else
move mymove
}
</pre>

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

Getzrange

2020-12-04T00:45:32Z

Sangman: spritebridge example

'''getzrange''' <x> <y> <z> <sector> ''<ceilingz>'' ''<ceilinghit>'' ''<floorz>'' ''<floorhit>'' <walldist> <clipmask>

Given a starting point and its containing sector, calculate (1) the z coordinates of (2) the objects that would be first hit by a quadratic, floor-aligned sprite pointing parallel to the grid and having side length 2*<walldist>, when travelling in a straight line up- and downwards (respectively for <ceiling...> and <floor...>). The <clipmask> is specified in the same fashion as in [[hitscan]].

''<ceilinghit>'' and ''<floorhit>'' can take the following values:<br>
* 16384 + sectnum, if a ceiling or floor was hit first<br>
* 49152 + spritenum, if a sprite was hit first<br>

The behaviour in corner cases (sectnum invalid, x/y/z not in sectnum, etc.) should not be relied upon.

===Example: Checking for spritebridges===
The state below checks if the current actor is on a spritebridge, and if so, "returns" the id of that sprite.

// assumption: relevant variables are declared
defstate check_spritebridge
geta[].x my_x
geta[].y my_y
geta[].z my_z
geta[].sectnum sectnum

getzrange my_x my_y my_z sectnum
ceilingz
ceilinghit
floorz
floorhit
256
CLIPMASK0

set outputSpriteId -1
ifge floorhit 49152
{
sub floorhit 49152

ifvarand sprite[floorhit].cstat 32
set outputSpriteId floorhit
}

// outputSpriteId now contains either -1 if no spritebridge is detected, or the id of the spritebridge if there is
ends

Spritebridge

2020-12-04T00:37:24Z

Sangman: link to getzrange for non-player actor

This has a value of 1 if the player is standing on a floor sprite (such as the bridge in Duke3D's E1L1; from r1450 onwards, also if standing on a wall sprite). Otherwise, the value is 0. See [[sbs]].

Non-player actors do not have a spritebridge property, but the equivalent information for them can be calculated using [[getzrange]].

[[Category:Player structure members]]

Abs

2020-12-04T00:35:56Z

Sangman: Created page with "'''abs''' ''<value>'' Calculates the absolute value of <value> and stores it back into <value>. Category:Gamevar manipulation"

'''abs''' ''<value>''

Calculates the absolute value of <value> and stores it back into <value>.

[[Category:Gamevar manipulation]]

Hitscan

2020-11-17T22:43:44Z

Sangman: Bit more explanation (probably a bit too much heh) on hitwall/hitsprite

'''hitscan''' <x1> <y1> <z1> <sect1> <cos of ang> <sin of ang> <zvel> <hit sector return var> <hit wall return var> <hit sprite return var> <hit x return var> <hit y return var> <hit z return var> <clip mask>

Hitscan returns the values of what would be hit if one travelled in a straight line from a set of coordinates in a specified direction.

All parameters are [[gamevar | gamevars]]. The first three are the coordinates from which the hitscan occurs, followed by the scanning sector. The [[cos]], then the [[sin]] of an angle (typically the [[ang]] of the actor performing the scan) come next, followed by the z angle, which must be calculated before the hitscan. The six return gamevars hold the values of what the hitscan hits. The value of [[clipmask]] tells hitscan which sorts of things it can hit. A [[clipmask]] of 4294901808 is useful for most purposes.

HITWALL and HITSPRITE's default value is -1. They will be filled up with the wall id or sprite id that is hit. In other words, if running hitscan against an actor and HITWALL's value is not -1, that means the target actor is not hit. If it is hit, HITSPRITE will be set to the id of the actor.

Example of hitscan originating from the player:
<pre>
// This state will return the sector, wall, and sprite(id, x ,y, and z data)currently under the crosshair.

state checkhitscan
getplayer[THISACTOR].posx MY_X
getplayer[THISACTOR].posy MY_Y
getplayer[THISACTOR].posz MY_Z
getplayer[THISACTOR].cursectnum MY_SECTOR
getplayer[THISACTOR].ang MY_ANGLE
getplayer[THISACTOR].horiz MY_ZDIST
subvar MY_ZDIST 100
mulvar MY_ZDIST -2048
cos MY_COS MY_ANGLE
sin MY_SIN MY_ANGLE

hitscan MY_X MY_Y MY_Z MY_SECTOR MY_COS MY_SIN MY_ZDIST HITSECTOR HITWALL HITSPRITE HITX HITY HITZ 4294901808
ends
</pre>

If the hitscan does not originate from the player but from another actor, the code is a bit different:
* Ensure the hitscan cstat bit is set on the target actor
* The angle needs to be calculated
* The zdist calculation is different
* If appropriate, the "my_z" coordinate needs to be shifted up to the "eye level" of the actor. You should be able to get away with using a constant value around 4096-8192 for most cases, but it depends on the exact height of the actor.
<pre>
state checkhitscan
geta[].x MY_X
geta[].y MY_Y
geta[].z MY_Z
geta[].sectnum MY_SECTOR

geta[otheractor].x OTHER_X
geta[otheractor].y OTHER_Y
geta[otheractor].y OTHER_Z
geta[otheractor].cstat CSTAT_BACKUP
seta[otheractor].cstat 256 // enable hitscan bit is set or the sprite will not be detected

// Calculate angle
sub OTHER_X MY_X
sub OTHER_Y MY_Y
getangle MY_ANGLE OTHER_X OTHER_Y
cos MY_COS MY_ANGLE
sin MY_SIN MY_ANGLE

// Calculate zdist
set MY_ZDIST OTHER_Z
sub MY_ZDIST MY_Z
shiftvarl MY_ZDIST 14
ldist xydist THISACTOR otheractor
ife xydist 0 set xydist 1
divvarvar MY_ZDIST xydist

// Bring Z position to "eye level", exact value needed here depends on height of the sprite
// This could maybe also be calculated using ysize
sub MY_Z 8192

hitscan MY_X MY_Y MY_Z MY_SECTOR MY_COS MY_SIN MY_ZDIST HITSECTOR HITWALL HITSPRITE HITX HITY HITZ 4294901808

// reinstate original cstat (useful in case the sprite you're checking against is a non-blocking effect sprite for instance)
seta[otheractor].cstat CSTAT_BACKUP
ends
</pre>

[[Category:EDuke32 specific commands]]
[[Category:Gamevar manipulation]]

Hitscan

2020-11-17T22:39:51Z

Sangman: some text changes

'''hitscan''' <x1> <y1> <z1> <sect1> <cos of ang> <sin of ang> <zvel> <hit sector return var> <hit wall return var> <hit sprite return var> <hit x return var> <hit y return var> <hit z return var> <clip mask>

Hitscan returns the values of what would be hit if one travelled in a straight line from a set of coordinates in a specified direction.

All parameters are [[gamevar | gamevars]]. The first three are the coordinates from which the hitscan occurs, followed by the scanning sector. The [[cos]], then the [[sin]] of an angle (typically the [[ang]] of the actor performing the scan) come next, followed by the z angle, which must be calculated before the hitscan. The six return gamevars hold the values of what the hitscan hits. The value of [[clipmask]] tells hitscan which sorts of things it can hit. A [[clipmask]] of 4294901808 is useful for most purposes.

Example of hitscan originating from the player:
<pre>
// This state will return the sector, wall, and sprite(id, x ,y, and z data)currently under the crosshair.

state checkhitscan
getplayer[THISACTOR].posx MY_X
getplayer[THISACTOR].posy MY_Y
getplayer[THISACTOR].posz MY_Z
getplayer[THISACTOR].cursectnum MY_SECTOR
getplayer[THISACTOR].ang MY_ANGLE
getplayer[THISACTOR].horiz MY_ZDIST
subvar MY_ZDIST 100
mulvar MY_ZDIST -2048
cos MY_COS MY_ANGLE
sin MY_SIN MY_ANGLE

hitscan MY_X MY_Y MY_Z MY_SECTOR MY_COS MY_SIN MY_ZDIST HITSECTOR HITWALL HITSPRITE HITX HITY HITZ 4294901808
ends
</pre>

If the hitscan does not originate from the player but from another actor, the code is a bit different:
* Ensure the hitscan cstat bit is set on the target actor
* The angle needs to be calculated
* The zdist calculation is different
* If appropriate, the "my_z" coordinate needs to be shifted up to the "eye level" of the actor. You should be able to get away with using a constant value around 4096-8192 for most cases, but it depends on the exact height of the actor.
<pre>
state checkhitscan
geta[].x MY_X
geta[].y MY_Y
geta[].z MY_Z
geta[].sectnum MY_SECTOR

geta[otheractor].x OTHER_X
geta[otheractor].y OTHER_Y
geta[otheractor].y OTHER_Z
geta[otheractor].cstat CSTAT_BACKUP
seta[otheractor].cstat 256 // enable hitscan bit is set or the sprite will not be detected

// Calculate angle
sub OTHER_X MY_X
sub OTHER_Y MY_Y
getangle MY_ANGLE OTHER_X OTHER_Y
cos MY_COS MY_ANGLE
sin MY_SIN MY_ANGLE

// Calculate zdist
set MY_ZDIST OTHER_Z
sub MY_ZDIST MY_Z
shiftvarl MY_ZDIST 14
ldist xydist THISACTOR otheractor
ife xydist 0 set xydist 1
divvarvar MY_ZDIST xydist

// Bring Z position to "eye level", exact value needed here depends on height of the sprite
// This could maybe also be calculated using ysize
sub MY_Z 8192

hitscan MY_X MY_Y MY_Z MY_SECTOR MY_COS MY_SIN MY_ZDIST HITSECTOR HITWALL HITSPRITE HITX HITY HITZ 4294901808

// reinstate original cstat (useful in case the sprite you're checking against is a non-blocking effect sprite for instance)
seta[otheractor].cstat CSTAT_BACKUP
ends
</pre>

[[Category:EDuke32 specific commands]]
[[Category:Gamevar manipulation]]

Hitscan

2020-11-17T22:39:03Z

Sangman: unordered list fix

'''hitscan''' <x1> <y1> <z1> <sect1> <cos of ang> <sin of ang> <zvel> <hit sector return var> <hit wall return var> <hit sprite return var> <hit x return var> <hit y return var> <hit z return var> <clip mask>

Hitscan returns the values of what would be hit if one travelled in a straight line from a set of coordinates in a specified direction.

All parameters are [[gamevar | gamevars]]. The first three are the coordinates from which the hitscan occurs, followed by the scanning sector. The [[cos]], then the [[sin]] of an angle (typically the [[ang]] of the actor performing the scan) come next, followed by the z angle, which must be calculated before the hitscan. The six return gamevars hold the values of what the hitscan hits. The value of [[clipmask]] tells hitscan which sorts of things it can hit. A [[clipmask]] of 4294901808 is useful for most purposes.

Example of hitscan:
<pre>
// This state will return the sector, wall, and sprite(id, x ,y, and z data)currently under the crosshair.

state checkhitscan
getplayer[THISACTOR].posx MY_X
getplayer[THISACTOR].posy MY_Y
getplayer[THISACTOR].posz MY_Z
getplayer[THISACTOR].cursectnum MY_SECTOR
getplayer[THISACTOR].ang MY_ANGLE
getplayer[THISACTOR].horiz MY_ZDIST
subvar MY_ZDIST 100
mulvar MY_ZDIST -2048
cos MY_COS MY_ANGLE
sin MY_SIN MY_ANGLE

hitscan MY_X MY_Y MY_Z MY_SECTOR MY_COS MY_SIN MY_ZDIST HITSECTOR HITWALL HITSPRITE HITX HITY HITZ 4294901808
ends
</pre>

If the hitscan is between two actors, the code is a bit different:
* Ensure the hitscan cstat bit is set on the target actor
* The angle needs to be calculated
* The zdist calculation is different
* If appropriate, the "my_z" coordinate needs to be shifted up to the "eye level" of the actor. You should be able to get away with using a constant value around 4096-8192 for most cases, but it depends on the exact height of the actor.
<pre>
state checkhitscan
geta[].x MY_X
geta[].y MY_Y
geta[].z MY_Z
geta[].sectnum MY_SECTOR

geta[otheractor].x OTHER_X
geta[otheractor].y OTHER_Y
geta[otheractor].y OTHER_Z
geta[otheractor].cstat CSTAT_BACKUP
seta[otheractor].cstat 256 // enable hitscan bit is set or the sprite will not be detected

// Calculate angle
sub OTHER_X MY_X
sub OTHER_Y MY_Y
getangle MY_ANGLE OTHER_X OTHER_Y
cos MY_COS MY_ANGLE
sin MY_SIN MY_ANGLE

// Calculate zdist
set MY_ZDIST OTHER_Z
sub MY_ZDIST MY_Z
shiftvarl MY_ZDIST 14
ldist xydist THISACTOR otheractor
ife xydist 0 set xydist 1
divvarvar MY_ZDIST xydist

// Bring Z position to "eye level", exact value needed here depends on height of the sprite
// This could maybe also be calculated using ysize
sub MY_Z 8192

hitscan MY_X MY_Y MY_Z MY_SECTOR MY_COS MY_SIN MY_ZDIST HITSECTOR HITWALL HITSPRITE HITX HITY HITZ 4294901808

// reinstate original cstat (useful in case the sprite you're checking against is a non-blocking effect sprite for instance)
seta[otheractor].cstat CSTAT_BACKUP
ends
</pre>

[[Category:EDuke32 specific commands]]
[[Category:Gamevar manipulation]]

Hitscan

2020-11-17T22:36:30Z

Sangman: Description of hitscan between two actors

'''hitscan''' <x1> <y1> <z1> <sect1> <cos of ang> <sin of ang> <zvel> <hit sector return var> <hit wall return var> <hit sprite return var> <hit x return var> <hit y return var> <hit z return var> <clip mask>

Hitscan returns the values of what would be hit if one travelled in a straight line from a set of coordinates in a specified direction.

All parameters are [[gamevar | gamevars]]. The first three are the coordinates from which the hitscan occurs, followed by the scanning sector. The [[cos]], then the [[sin]] of an angle (typically the [[ang]] of the actor performing the scan) come next, followed by the z angle, which must be calculated before the hitscan. The six return gamevars hold the values of what the hitscan hits. The value of [[clipmask]] tells hitscan which sorts of things it can hit. A [[clipmask]] of 4294901808 is useful for most purposes.

Example of hitscan:
<pre>
// This state will return the sector, wall, and sprite(id, x ,y, and z data)currently under the crosshair.

state checkhitscan
getplayer[THISACTOR].posx MY_X
getplayer[THISACTOR].posy MY_Y
getplayer[THISACTOR].posz MY_Z
getplayer[THISACTOR].cursectnum MY_SECTOR
getplayer[THISACTOR].ang MY_ANGLE
getplayer[THISACTOR].horiz MY_ZDIST
subvar MY_ZDIST 100
mulvar MY_ZDIST -2048
cos MY_COS MY_ANGLE
sin MY_SIN MY_ANGLE

hitscan MY_X MY_Y MY_Z MY_SECTOR MY_COS MY_SIN MY_ZDIST HITSECTOR HITWALL HITSPRITE HITX HITY HITZ 4294901808
ends
</pre>

If the hitscan is between two actors, the code is a bit different:
- Ensure the hitscan cstat bit is set on the target actor
- The angle needs to be calculated
- The zdist calculation is different
- If appropriate, the "my_z" coordinate needs to be shifted up to the "eye level" of the actor. You should be able to get away with using a constant value around 4096-8192 for most cases, but it depends on the exact height of the actor.
<pre>
state checkhitscan
geta[].x MY_X
geta[].y MY_Y
geta[].z MY_Z
geta[].sectnum MY_SECTOR

geta[otheractor].x OTHER_X
geta[otheractor].y OTHER_Y
geta[otheractor].y OTHER_Z
geta[otheractor].cstat CSTAT_BACKUP
seta[otheractor].cstat 256 // enable hitscan bit is set or the sprite will not be detected

// Calculate angle
sub OTHER_X MY_X
sub OTHER_Y MY_Y
getangle MY_ANGLE OTHER_X OTHER_Y
cos MY_COS MY_ANGLE
sin MY_SIN MY_ANGLE

// Calculate zdist
set MY_ZDIST OTHER_Z
sub MY_ZDIST MY_Z
shiftvarl MY_ZDIST 14
ldist xydist THISACTOR otheractor
ife xydist 0 set xydist 1
divvarvar MY_ZDIST xydist

// Bring Z position to "eye level", exact value needed here depends on height of the sprite
// This could maybe also be calculated using ysize
sub MY_Z 8192

hitscan MY_X MY_Y MY_Z MY_SECTOR MY_COS MY_SIN MY_ZDIST HITSECTOR HITWALL HITSPRITE HITX HITY HITZ 4294901808

// reinstate original cstat (useful in case the sprite you're checking against is a non-blocking effect sprite for instance)
seta[otheractor].cstat CSTAT_BACKUP
ends
</pre>

[[Category:EDuke32 specific commands]]
[[Category:Gamevar manipulation]]

Move

2020-02-22T22:06:56Z

Sangman:

A move command is used to give velocity to an [[actor]].

Define outside an actor as so:

'''move''' <name> <horizontal> <vertical>

<name> is the name of the move command.

Warning: You '''cannot''' use the same name from a [[define]], or the game will crash.

<horizontal> is the horizontal velocity of the [[actor]]. Negative values reverse direction.

<vertical> is the vertical veloctity of the [[actor]]. Negative values cause upward motion.

Used inside an [[actor]], a move command is written as:

'''move''' <name> <moveflags...>

<moveflags...> is a (possibly empty) sequence of parameters that specify certain hardcoded movement behavior.

You '''cannot''' substitute <name> for a number, define, or gamevar. It has to be predefined with the first definition of move.

==moveflags==

Values for each <moveflag> (defined in DEFS.CON) are:

{| {{prettytable}}
!moveflag!!description!!internal value!!
|-
|faceplayer
|[[actor]] faces the player.
|align="right"|'''1'''
|-
|geth
|use horizontal velocity.
|align="right"|'''2'''
|-
|getv
|use vertical velocity.
|align="right"|'''4'''
|-
|randomangle
|[[actor]] will face random direction.
|align="right"|'''8'''
|-
|faceplayerslow
|same as faceplayer, but done gradually.
|align="right"|'''16'''
|-
|spin
|spin in a clockwise circle.
|align="right"|'''32'''
|-
|faceplayersmart
|same as faceplayer, but with a slight "lead" on position.
|align="right"|'''64'''
|-
|fleeenemy
|[[actor]] faces away from the player.
|align="right"|'''128'''
|-
|jumptoplayer
|[[actor]] will move vertically and then fall as if jumping.
|align="right"|'''257'''*
|-
|seekplayer
|[[actor]] will try to find the best path to the nearest player.
|align="right"|'''512'''
|-
|furthestdir
|[[actor]] faces the furthest distance from the closest player.
|align="right"|'''1024'''
|-
|dodgebullet
|[[actor]] attempts to avoid all shots directed at him. The [[actor]] will not avoid GROWSPARK.
|align="right"|'''4096'''
|}

==Making a Useractor move==
A [[useractor]] can be made to move as part of a given [[action]]. The type of the useractor (ie. Enemy/Notenemy) has an impact on how this functions.
Typically one might expect that we can apply the move on each tic of the action but it doesn't work that way for type Enemy. For that type, a move is started with a "momentum". If it is applied on each tic, the actor will not move at all. On each tic it must be checked if the actor is already moving, and only call the move if they aren't.

This behaviour does not occur for a Notenemy useractor type.

In other words, for a Notenemy, this is sufficient:
<pre>
ifaction MYACTION
{
move mymove // and apply whatever other flags, e.g. geth
}
</pre>

For an Enemy, use this:
<pre>
ifaction MYACTION
{
ifmove mymove {} // alternatively: ifmove mymove nullop
else
move mymove
}
</pre>

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

Move

2020-02-22T22:02:35Z

Sangman: Describe difference of move handling between Enemy/Notenemy

A move command is used to give velocity to an [[actor]].

Define outside an actor as so:

'''move''' <name> <horizontal> <vertical>

<name> is the name of the move command.

Warning: You '''cannot''' use the same name from a [[define]], or the game will crash.

<horizontal> is the horizontal velocity of the [[actor]]. Negative values reverse direction.

<vertical> is the vertical veloctity of the [[actor]]. Negative values cause upward motion.

Used inside an [[actor]], a move command is written as:

'''move''' <name> <moveflags...>

<moveflags...> is a (possibly empty) sequence of parameters that specify certain hardcoded movement behavior.

You '''cannot''' substitute <name> for a number, define, or gamevar. It has to be predefined with the first definition of move.

==moveflags==

Values for each <moveflag> (defined in DEFS.CON) are:

{| {{prettytable}}
!moveflag!!description!!internal value!!
|-
|faceplayer
|[[actor]] faces the player.
|align="right"|'''1'''
|-
|geth
|use horizontal velocity.
|align="right"|'''2'''
|-
|getv
|use vertical velocity.
|align="right"|'''4'''
|-
|randomangle
|[[actor]] will face random direction.
|align="right"|'''8'''
|-
|faceplayerslow
|same as faceplayer, but done gradually.
|align="right"|'''16'''
|-
|spin
|spin in a clockwise circle.
|align="right"|'''32'''
|-
|faceplayersmart
|same as faceplayer, but with a slight "lead" on position.
|align="right"|'''64'''
|-
|fleeenemy
|[[actor]] faces away from the player.
|align="right"|'''128'''
|-
|jumptoplayer
|[[actor]] will move vertically and then fall as if jumping.
|align="right"|'''257'''*
|-
|seekplayer
|[[actor]] will try to find the best path to the nearest player.
|align="right"|'''512'''
|-
|furthestdir
|[[actor]] faces the furthest distance from the closest player.
|align="right"|'''1024'''
|-
|dodgebullet
|[[actor]] attempts to avoid all shots directed at him. The [[actor]] will not avoid GROWSPARK.
|align="right"|'''4096'''
|}

==Making a Useractor move==
A [[useractor]] can be made to move as part of a given [[action]]. The type of the useractor (ie. Enemy/Notenemy) has an impact on how this functions.
Typically one might expect that we can apply the move on each tic of the action but it doesn't work that way for type Enemy. For that type, a move is started with a "momentum". If it is applied on each tic, the actor will not move at all. On each tic it must be checked if the actor is already moving, and only call the move if they aren't.

This behaviour does not occur for a Notenemy useractor type.

In other words, for a Notenemy, this is sufficient:
<pre>
ifaction MYACTION
{
move mymove // and apply whatever other flags, e.g. geth
}
</pre>

For an Enemy, use this:
<pre>
ifaction MYACTION
{
ifmove mymove {}
else
move mymove
}
</pre>

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

Make actor aim vertical

2019-09-06T19:51:44Z

Sangman: New way to do this based on Hendricks' suggestion

In this example, the [[actor]] will find the closest LIZTROOP actor within 2048 units and calculate the vertical angle it needs to aim at. This code is an example of how to use the [[zshoot]] command to create friendly bots and other similar effects. The following does not contain the [[gamevar]] definitions, which must be placed outside of the actor code.

<pre>
findnearactor LIZTROOP 2048 ACTOR2
ifvarn ACTOR2 -1
{
ldist TEMP THISACTOR ACTOR2
getprojectile[SHOTSPARK1].vel PROJECTILE_VEL

ifn PROJECTILE_VEL 0
div TEMP PROJECTILE_VEL // distance / projectile velocity = the amount of tics it would take for the projectile to reach the player's position (regardless of Z coordinate)

getactor[THISACTOR].z TEMP2
getactor[ACTOR2].z TEMP3
sub TEMP3 TEMP2

ifn TEMP 0
div TEMP3 TEMP

zshoot TEMP3 SHOTSPARK1
}
</pre>

[[Category: Tutorials]]