Skip to content

Expressions

Statements & Loops

As found in the Razor macro system, you can use if, for, foreach, and while when writing a script to add some basic logic and flows.

if

Syntax:

1
2
3
4
5
6
7
if (expression)
    // commands to execute if this expression is true
elseif (expression)
    // commands to execute if the first expression was false, and this expression is true
else
    // commands to execute if both expressions above were false, default to running these
endif

Description: This selects a path to execute based on the value of a boolean expression. An if statement can be combined with else or elseif to choose two or more distinct paths based on the result of the boolean expression. All if statements must end with endif.

Example

1
2
3
if stam = 100
    overhead 'Stam at 100!'
endif

1
2
3
4
5
6
7
8
9
if stam = 100
    say 'Stamina full'
elseif stam < 20
    say 'Still a ways to go'
elseif stam < 60
    say 'Getting closer'
else
    say 'waiting'
endif

1
2
3
4
5
6
7
if stam = 100
    say 'Stamina full'
elseif stam < 20
    say 'Still a ways to go'
elseif stam < 60
    say 'Getting closer'
endif

1
2
3
if not stam = 100
    say 'Stamina is not full'    
endif

for

Syntax:

1
2
3
for ('number')
    // commmands to execute the number of times defined in the for statement
endfor

Description: This allows you to execute a block of commands a specific number of times. All for loops must end with endfor.

Tip

You can use the index variable to track your position in the for loop.

When using for or while you have access to the index variable. This can be used with overhead (for example) to indicate the current loop number.

Example

1
2
3
4
for 10
    say 'hello'
    wait 1000
endfor

1
2
3
4
for 10
    wait 1000
    overhead 'index'
endfor

foreach

Syntax:

1
2
3
foreach ('variable') in ('list')
    // commands to execute for each item that is in a list
endfor

Description: This allows you to iterate over a list containing values. All foreach loops must end with endfor.

Example

1
2
3
4
5
6
7
createlist 'mylist'
pushlist 'mylist' '0x1'
pushlist 'mylist' '0x2'

foreach 'item' in 'mylist'
   overhead 'item'
endfor

while

Syntax:

1
2
3
while ('expression')
    // commands to execute as long as the expression is remains true
endwhile

Description: This allows you execute a block of commands while a certain expression is true. All while loops must end with endwhile.

Example

1
2
3
4
while hits < 100
    say 'I need a heal!'
    wait 1000
endwhile

Expression Operators

When using the if or while conditions, you can access the following expressions in the statement.

The following operators are supported:

Operator Description
= Equal
== Equal
!= Not equal
< Less than
<= Less than or equal
> Greater than
>= Greater than or equal

Expressions

Expressions are combined with statements like if and while to alter the execution path of your script.

Below are the several different types of expressions you can use broken into categories.

List Expressions

inlist

  • inlist ('list name') ('list item')

Description: Used to check if a specific item is in a list

Example

1
2
3
if inlist 'my_list' 'item1'
    overhead 'found item!'
endif

list

  • list ('list name')

Description: Used to check how many items are in a specific list

Example

1
2
3
if list 'mylist' = 10
    overhead '10 items in your list'
endif

listexists

  • listexists ('list name')

Description: Used to check if a list exists with a specific name.

Example

1
2
3
if not listexists 'mylist'
    createlist 'mylist'
endif

poplist

  • poplist ('list name') ('list value'/'front'/'back')

Description: This command will remove (pop) an item from the list. You can either pass in the specific item, or use front or back to remove the item from the front or back of the list.

Example

1
2
3
if poplist 'mylist' back as 'item'
    overhead 'item'
endif

Misc Expressions

count/counter

  • count ('name of counter')
  • counter ('name of counter')
  • count ('name of item') [hue]
  • count (graphicID) [hue]

Description: Used to get the current amount of a specific item in player's backpack. Omitting the hue argument will result in count of all items of the specified type regardless of their hue. The expression can be used either directly by item type and hue, or by referencing a named counter manually set up in the Counters tab. More info

Example

1
2
3
if count 'garlic' < 5
    say 'getting low on garlic'
endif

1
2
3
if count 'spellbook' '1121' == 0
    say 'no runebooks found!'
endif

1
2
3
if count 'gold coin' > count 'gold coin' 0
    overhead 'woot woot fancy coins in the pack!'
endif

findtype

  • findtype ('name of item') [inrangecheck (true/false)/backpack] [hue] OR findtype (graphicID) [inrangecheck (true/false)/backpack] [hue]

Description: Used to check if a specific item name of graphic ID exists. Range check, if true, will check within 2 tiles.

The as keyword

If you use findtype along with as you can assign a temporary variable to use throughout the script. See example below.

In-Game Info Gump

Not sure what name to enter or graphic ID to enter? Type >info and click on any item or mobile for more information.

item-command

Click the blue dot next to the value you want to copy to the clipboard.

Example

1
2
3
if findtype 'saw'
    say 'found saw'
endif

1
2
3
if findtype '4148'
    say 'found saw'
endif

1
2
3
if findtype 'saw' true
    say 'found saw within 2 tiles'
endif

1
2
3
if findtype 'saw' backpack
    say 'found saw in my pack'
endif

1
2
3
4
if findtype 'dagger' as 'mydagger'
    overhead 'found dagger'
    dclick 'mydagger'
endif

1
2
3
4
if findtype 'dagger' backpack 45 as 'mydagger'
    overhead 'found dagger'
    dclick 'mydagger'
endif

insysmsg

  • insysmsg ('message to look for')
  • insysmessage ('message to look for')

Description: Used to check if certain text appears within the system message log.

System Message Queue

Not sure if a specific message is in Razor's system message queue? Type >sysmsgs to see what Razor can find.

Using clearsysmsg will clear out the queue completely.

Example

1
2
3
if insysmsg 'too far away'
    overhead 'You are too far away'
endif

itemcount

  • itemcount

Description: Used to return the current number of items you're carrying

Example

1
2
3
if itemcount < 125
    overhead 'I still have room!'
endif

queued

  • queued

Description: Used to check if your current queue is active (from restocking, organizing, etc)

Example

1
2
3
4
5
    if queued
        overhead 'Queue is active'
    else
        overhead 'No queue'
    endif

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
overhead 'Organizing'

organizer 1

while queued
    overhead 'Currently Organizing'
    wait 500 
endwhile

overhead 'Organized'

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
overhead 'Restocking'

restock 11
waitfortarget 
target 'self'

while queued
    overhead 'Currently restocking'
    wait 500 
endwhile

overhead 'Restocked'

targetexists

  • targetexists ['any'/'beneficial'/'harmful'/'neutral']

Description: Used to check if the client current has a target cursor up

Example

1
2
3
4
5
if targetexists 'beneficial'
    overhead 'Beneficial target found'
elseif targetexists 'harmful'
    overhead 'Harmful target found'
endif

varexist

  • varexist
  • varexists

Description: Used to check if a variable exists.

Example

1
2
3
4
5
6
7
8
if not varexist 'myrunebook'
    overhead 'Runebook variable not found -- select one'
    setvar 'myrunebook'
endif

dclick 'myrunebook'
waitforgump 'any'
gumpresponse 5

Player Attribute Expressions

diffhits

  • diffhits
  • diffhp

Description: Used to get the difference between you max hits and current hits.

Example

1
2
3
if diffhits > 40
    overhead 'I need a heal!'
endif

diffmana

  • diffmana

Description: Used to get the difference between you max mana and current mana.

Example

1
2
3
if diffmana > 40
    skill 'Meditation'
endif

diffstam

  • diffstam

Description: Used to get the difference between you max stamina and current stamina.

Example

1
2
3
 if diffstam > 30
    overhead 'Need stamina'
endif

diffweight

  • diffweight

Description: Used to get the difference between you max weight and current weight.

Example

1
2
3
if diffweight > 20
    overhead 'I can lift 20 more stone'
endif

followers

Description: Used to get the current number of followers.

Example

1
2
3
4
5
if followers = 0
    overhead 'No one following me!'
else
    overhead 'I have followers'
endif

1
2
3
4
5
if followers < maxfollowers
    overhead 'You can have more followers!'
else
    overhead 'You hit your followers limit'
endif

findbuff

  • findbuff 'name of buff/debuff

Description: Used to check if a specific buff/debuff is applied to you.

Example

1
2
3
4
5
6
7
if findbuff 'magic reflection'
    overhead 'Im set!'
else
    cast 'magic reflection'
    wft
    target 'self'
endif

hidden

  • hidden

Description: Used to check if you are hidden.

Example

1
2
3
if hidden
    overhead 'they cant see me'
endif

hp & maxhp

  • hp
  • maxhp
  • hits
  • maxhits

Description: Used to get your current or max hit points/health levels.

Example

1
2
3
4
while hp < 100
    say 'not at 100 yet'
    wait 5000
endwhile

1
2
3
if maxhp = 120
    say 'Full hp!'
endif

lhandempty

  • lhandempty

Description: Used to check if your left hand is empty

Example

1
2
3
if lhandempty
    hotkey 'empty right hand!'
endif

invuln

  • invuln
  • invul
  • blessed

Description: Used to get your invulnerable status

Example

1
2
3
if invuln
    overhead 'I feel.. so powerful.'
endif

mana & maxmana

  • mana
  • maxmana

Description: Used to get your current or max mana levels.

Example

1
2
3
4
while mana < maxmana
    skill 'meditation'
    wait 11000
endwhile

maxfollowers

Description: Used to get the maximum number of allowed followers.

Example

1
2
3
if followers = maxfollowers
    overhead 'You hit your limit'       
endif

1
2
3
4
5
if followers < maxfollowers
    overhead 'You can have more followers!'
else
    overhead 'You hit your followers limit'
endif

maxweight

  • maxweight

Description: Used to get your max allowed weight.

Example

1
2
3
if weight <= maxweight
    say 'I am overweight'
endif

mounted

  • mounted

Description: Used to check if you are currently on a mount

Example

1
2
3
4
5
if mounted
    say 'mounted'
else
    say 'not mounted'
endif

name

  • name

Description: Used to get your name of the currently logged in character

Example

1
2
3
if name = 'Quick'
    overhead 'thats me!'
endif

paralyzed

  • paralyzed

Description: Used to check if you are currently paralyzed.

Example

1
2
3
if paralyzed
    overhead 'I cannot move!'
endif

poisoned

  • poisoned

Description: Used to check if you are currently poisoned.

Example

1
2
3
if poisoned
    hotkey 'drink cure'
endif

position

  • position (x, y)
  • position (x, y, z)

Description: Used to check if your current position matches the provided.

Example

1
2
3
4
5
if position 2729 2133
    overhead 'You are currently in front of the Bucs Den teleporter'
elseif position 2728 2133 5
    overhead 'You are standing on the Bucs Den teleporter'
endif

rhandempty

  • rhandempty

Description: Used to check if your right hand is empty

Example

1
2
3
if rhandempty
    hotkey 'empty right hand!'
endif

skill

  • skill ('name')

Description: Used to get the current skill level for a given skill.

Supported skill names

Razor used to rely on a static list of names but now reads from your client's skills.mul file for the names of the skill.

Example

1
2
3
4
5
if skill 'magery' < 62.5
    cast 'invisibility'
    waitfortarget
    target 'self'
endif

stam & maxstam

  • stam
  • maxstam

Description: Used to get your current stamina or max stamina.

Example

1
2
3
if stam < 30
    say 'I need to rest'
endif

1
2
3
if maxstam = 120
    say 'I feel so powerful!'
endif

str, dex & int

  • str
  • dex
  • int

Description: Used to get your current strength, dexterity and intelligence.

Example

1
2
3
if str = 100
    say 'Strength does not come from physical capacity. It comes from an indomitable will.'
endif

1
2
3
if dex = 100
    say 'Dexterity comes by experience and practice.'
endif

1
2
3
if str = 100
    say 'The true sign of intelligence is not knowledge but imagination.'
endif

warmode

  • warmode

Description: Used to get your current combat/war status

Example

1
2
3
4
5
if warmode
    overhead 'Lets fight'
else
    overhead 'Peace to you'
endif

weight

  • weight

Description: Used to get your current weight.

Example

1
2
3
if weight = 300
    say 'I feel heavy'
endif

Timer Expressions

timer

  • timer ('name')

Description: Used to check how much time is left in an existing timer

Example

1
2
3
4
5
6
7
8
9
// Create a new timer
if not timerexists 'sample'
    createtimer 'sample'
endif

// Reset every 10 seconds
if timer 'sample' > 10000
    settimer 'sample' 0
endif

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Create a new timer
createtimer 'alert'

while not dead            

    // Reset every 10 seconds
    if timer 'alert' > 10000
        overhead 'ALERT TRIGGERED!'
        settimer 'alert' 0
    endif

endwhile

timerexists

  • timerexist ('name')

Description: Used to check if a timer exists

Example

1
2
3
4
5
6
7
8
9
// Create a new timer
if not timerexists 'sample'
    createtimer 'sample'
endif

// Reset every 10 seconds
if timer 'sample' > 10000
    settimer 'sample' 0
endif
Last update: March 25, 2023