ScriptUO

Official ScriptUO EasyUO Scripts => Scripting Tutorials => Topic started by: Gaderian on January 22, 2020, 09:41:55 PM

Title: EasyUO Documentation Updates
Post by: Gaderian on January 22, 2020, 09:41:55 PM

Here are changes to Easyuo that are not readily documented as of Easyuo 1.6.334 January 23, 2020.
Obsolete Commands
 event sleep
 menu image pixline - was rarely used, but can be accomplished with a subroutine
 menu hideeuo

Modified Commands
 event macro

Category/Skill	Parm1	Parm2	Parm3	Cast	Notes/Power Words
Gump Control
	8	20		Open Mysticism Book
	8	21		Open Racial Abilities Book
	8	23		Open Global Chat
	9	18		Close Spellweaving Book
	9	20		Close Mysticism Book
	9	21		Close Racial Abilities Book
	9	23		Close Global Chat
	10	18		Minimize Spellweaving Book
	10	20		Minimize Mysticism Book
	10	21		Minimize Racial Abilities Book
	10	23		Minimize Global Chat
	11	18		Maximize Spellweaving Book
	11	20		Maximize Mysticism Book
	11	21		Maximize Racial Abilities Book
	11	23		Maximize Global Chat
Dress and Arm macros
	61	0 to ??		Save Dress	Parm2 is a number to reference a saved dress (official doc shows 0-4, but I have used numbers from 0 up to 100)
	62	0 to ??		Undress	Parm2 value to reference a saved dress
	63	0 to ??		Dress	Parm2 value to reference a saved dress
	64	0 to ??		Save Armed Items	Parm2 value to reference a saved armed weapons/shields/books
	65	0 to ??		Disarm	Parm2 value to reference a saved armed configuration
	66	0 to ??		Arm	Parm2 value to reference a saved armed configuration
Use Object
	67	parm1		Parm1 is a value from 1 to 14
	67	1		Use Healing Potion	confirmed
	67	2		Use Cure Potion	confirmed:cure, lesser cure and greater cure in backpack - greater cure consumed
	67	3		Use Refresh Potion	Needs Confirmation
	67	4		Use Strength Potion	Needs Confirmation
	67	5		Use Agility Potion	Needs Confirmation
	67	6		Use Explosion Potion	Needs Confirmation
	67	7		Use Conflagration Potion	Needs Confirmation
	67	8		Use Enchanted Apple	Needs Confirmation
	67	9		Use Petals of Trinsic	confirmed
	67	10		Use Orange Petals	confirmed
	67	11		Use Trapped Box	Needs Confirmation
	67	12		Use Smoke Bomb	Needs Confirmation
	67	13		Use Healing Stone	confirmed
	67	14		Use Spell Trigger	confirmed
Masteries					Credit to Endless Night for these mastery definitions and showing how to find more
Provocation	15	701		Inspire	Uus_Por
	15	702		Invigorate	An_Zu
Peacemaking	15	703		Resilience	Kal_Mani_Tym
	15	704		Perseverance	Uus_Jux_Sanct
Discordance	15	705		Tribulation	In_Jux_Hur_Rel
	15	706		Despair	Kal_Des_Mani_Tym
Magery	15	707		Death Ray	In_Grav_Corp
	15	708		Ethereal Burst	Uus_Ort_Grav
Mysticism	15	709		Nether Blast	In_Vas_Xen_Por
	15	710		Mystic Weapon	Vas_Ylem_Wis
Necromancy	15	711		Command Undead	In_Corp_Xen_Por
	15	712		Conduit	Uus_Corp_Grav
Spellweaving	15	713		Mana Shield	Faerkulggen
	15	714		Summon Reaper	Lartarisstree
Passive:Magery, Mysticism, Necromancy, Spellweaving	15	715		Enchanted Summoning	- passive
Bushido	15	716		Anticipate Hit	- passive
	15	717		Warcry
Passive:Bushido, Chivalry, Ninjitsu	15	718		Intuition	- passive
Chivalry	15	719		Rejuvenate
	15	720		Holy Fist
Ninjitsu	15	721		Shadow
	15	722		White Tiger Form
Archery	15	723		Flaming Shot
	15	724		Playing the Odds
Fencing	15	725		Thrust
	15	726		Pierce
Mace Fighting	15	727		Stagger
	15	728		Toughness
Swordsmanship	15	729		Onslaught
	15	730		Focused Eye
Throwing	15	731		Elemental Fury
	15	732		Called Shot
Passive:Archery, Fencing, Mace Fighting, Swordsmanship, Throwing	15	733		Warrior's Gifts	- passive
Parrying	15	734		Shield Bash
	15	735		Bodyguard
	15	736		Heighten Senses
Poisoning	15	737		Tolerance
	15	738		Injected Strike
	15	739		Potency	- passive
Wrestling	15	740		Rampage
	15	741		Fists of Fury
	15	742		Knockout	- passive
Animal Taming	15	743		Whispering
	15	744		Combat Training
	15	745		Boarding	- passive
Virtues
	49	5		Honesty	(not activated this way)      npc merchant discount (return lost items/lost+found boxes  banks/forensic:2x@town,4x@npc, more in fel)
	49	6		Humility
	49	8		Spirituality

 exevent popup [id] {x offset} {y offset} - X and Y pixel offset must be used - can't use an ordinal offset
 menu delete [element unique name]
      All elements below the chosen element are deleted as well.
      All elements on a form are deleted when the form is deleted.
      All elements with a panel as it's parent are deleted.
 menu Shape {name} {left} {top} {width} {height} {shapetype} {linetype} {linewidth} {linecolor} {filltype} {fillcolor}
      No more rounded corners or line effects. See the post about updating menu code for more information.

These menu commands only form0 (form name for classic menu window):
 menu clear
       [all child forms are deleted and #menubutton uninitialized (used to be initialized to N/A]
 menu font align { left|center|right }
 menu font bgcolor [color-descriptor]
 menu font color [color-descriptor]
 menu font name  [font-name]
 menu font size  {point-size}
 menu font style {b|i|u|s}
 menu font transparent [ #true|#false ]
 menu show
 menu window color  {color-descriptor}
 menu window transparent [ opacity percentile ]
 menu Window Size {width} {height}

New Commands
 exevent equip id id id ... ; instant dress
    This is a very fast way to equip items. It will replace items in that slot. It works with gargoyle items (exevent droppd doesn't work with gargoyle items)

 event statbar #charid
    Brings up the health bar for the character, npc, follower or monster. A maximimum of 9 status bars can be active at any one time.
    Once successful these will be set:
    #CONTNAME = status_gump
    #CONTID = ID of mobile
    #CONTTYPE = TYPE of mobile
    #CONTHP = percent of health

 menu form [form unique name] left top width height [text]

Note:
• menu setprop [form unique name] visible #true is required to make it viewable.
• Values are not inherited from the default, so menu setprop [form unique name] color $BBGGRR is needed to set the form color.

 menu getdef [option name: will be returned in #menures]
 menu panel [panel unique name] left top height width
   A panel is a container for menu elements. Each menu element has a parent - which is either a form or a panel.
   When an menu element is created, whatever the current default parent is inherited, but can be reassigned using menu setprop [element unique name] parent [parent element name].
 menu popdef
   This restores all menu setdef settings to the values prior to menu pushdef command.
 menu pushdef
   This can be used to protect any current default settings for a temporary setting. The primary goal is for library routines to be able to protect their settings from interfering with the calling script's settings. It serves as a protection for the menu default settings similar to how namespace commands do not interfere with script/library variables.
 menu radio [radio_unique_name] left top width height [checked: #true/#false] [labeled text...]
   Radio buttons limit only one in the parent form or panel to have a #true value.
   This behavior matches a listbox, while typically taking up more screen space for a quicker and more direct user interaction.
 menu setdef [alignment|color|fontcolor|fontname|fontsize|fontstyle|parent] [value]
    setdef and getdef are used for the DEFAULT options that may be inherited by subsequent menu commands
 menu setprop [element's unique name] [option #spc value pair]
Parameters for GETDEF, SETDEF (the 7 listed below applying to "DEFAULT") and SETPROP (all listed options)

Option

Values

These

can be

applied

to the

following

menu

elements

alignment

[0=left|1=right|2=center]

TEXT

RADIO

CHECK

DEFAULT

color

[hexadecimal $BBGGRR blue, green, red (Pascal format)] *See notes for menu form above.

FORM

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

DEFAULT

checked

[#true|#false]

RADIO

CHECK

enabled

[#true|#false]

FORM

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

IMAGE

fontcolor

[hexadecimal $BBGGRR blue, green, red (Pascal format)]

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

DEFAULT

fontname

[name of font]

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

DEFAULT

fontsize

[font size number]

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

DEFAULT

fontstyle

{sum of style attributes} ; 1=bold, 2=italic, 4=underline, 8=strikeout

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

DEFAULT

height

[# of pixels]

FORM

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

IMAGE

left

[# of pixels]

FORM

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

IMAGE

parent

[form or panel name where the element resides]

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

IMAGE

DEFAULT

text

[text]

FORM

TEXT

BUTTON

EDIT

RADIO

CHECK

tooltip

[text description used as tool tip when mouse hovers over element]

FORM

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

IMAGE

top

[# of pixels]

FORM

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

IMAGE

visible

[#true|#false]

FORM

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

IMAGE

width

[# of pixels]

FORM

PANEL

TEXT

BUTTON

EDIT

RADIO

CHECK

COMBO

LIST

IMAGE

 ignorecont [#contid|#contype|#contname|reset]
    Ignorecont is used to ignore gumps. It is restricted to a single definition at a time, so each definition will have its own ignorecont statement.
    It can ignore by #contid or #conttype or #contname.
    Issuing "ignorecont reset" will remove all ignored gumps. The example routine "resetgumps" will restore the default ignored gumps at EUO startup.
[/list]

Code: easyuo

1. sub resetgumps
2.  ignorecont reset
3.  ignorecont BARK_GUMP
4.  ignorecont DAMAGENUMBERS_GUMP
5.  ignorecont DUMB_GUMP
6.  ignorecont GAMEAREAEDGEGUMP
7.  ignorecont MAP_GUMP
8.  ignorecont MENUBAR
9.  ignorecont MISSILE_GUMP
10.  ignorecont NEW_ITEM_PROP_GUMP
11.  ignorecont RETICLE_GUMP
12.  ignorecont TARGET_GUMP
13.  ignorecont UNICODE_BARK_GUMP
14. return

 event conttop [number]
    Event conttop will cycle through gumps. The number is simply an index for the command it has nothing to do with a number tied to any particular gump.
    When the command is issued, the gump will become the most recent gump in the access order. Running the same routine will reverse the order of gumps.

Code: easyuo

1. for %i 0 100
2.  {
3.  event conttop %i
4.  if #contname <> %lcontname || #conttype <> %lconttype || #contid <> %lcontid || #contsize <> %lcontsize || #contposx <> %lcontposx || #contposy <> %lcontposy
5.   {
6.   set %lcontname #contname
7.   set %lconttype #conttype
8.   set %lcontid #contid
9.   set %lcontsize #contsize
10.   set %lcontposx #contposx
11.   set %lcontposy #contposy
12.   }
13.  else
14.   break
15.  }
16. display ok How many gumps found: %i ; %i is 0 based so final value is the count

Some notes about the dress/arm macros
Event macro 61 and 64 (saved dress/arm respectively) uses a number to keep track of the dress. I ran it repeatedly to > 50 and it continued to swap my armed items.
Maybe there is an upper limit (255 might seem logical), but somewhere before 50 I run out of various outfits I can carry.

For my sampire, I use:
1) my PVM outfit
2) post resurrectiion high LRC, high MR, high LMC +skill (meditation, necromancy, focus) suit
3) 2 handed weapon (double axe) - double strike weapon, whirlwind
4) 2 handed weapon (bladed staff) - armor ignore
5) 1 handed weapon (radiant scimitar) - whirlwind allowing potions
I do have some setups with a variety of weapons for various hit spell (hit fireball, hit lightning, hit dispel) depending on the situation.
I also will engage various slayer type weapons.
I do not happen to, but could include a high luck suit for the kill moment.

I am still well short of 50+ configurations. While the client seems to indicate 4 saved slots, I am pushing it beyond that.

It needs at least a wait 15-16 (.75-.8 second) between each action as a cool down for my cable internet connection. Since about 1 second is the standard cool down for most "actions" - that gets my best recommendation unless you have a very slow connection. You just won't switch outfits/weapons that often that a .25 second difference will be that dramatic. That cool down may apply to 'USE" actions that immediately follow (event macro 17, etc.).

While exevent equip is also practically instant, these macros have the fast save and fast unequip options. If you have all 18 slots with something equipped, it will take many seconds to undress your former outfit with the forced cool down between drag/drop steps. The event macro 62 can strip 16 of the slots (non-hand slots) in < 1 second including cool down.

I only use the 62 (undress) and 65 (disarm) macros for specific things. 62 is excellent for removing a talisman (slayer) to avoid extra damage from opposing slayer group. 65 is excellent for swapping weapons/shield to prepare for anti-bloodoath and ready for potion drinking.

Title: Re: EasyUO Documentation Updates
Post by: Gaderian on January 22, 2020, 09:42:25 PM

Reserved for more examples.

Title: Re: EasyUO Documentation Updates
Post by: manwinc on January 24, 2020, 03:36:30 PM

event conttop [number]

Oh baby,

Title: Re: EasyUO Documentation Updates
Post by: Endless Night on January 27, 2020, 06:41:03 AM

Quote from: manwinc on January 24, 2020, 03:36:30 PM

event conttop [number]

Oh baby,

See my gump subs for some examples of usage:  http://www.scriptuo.com/index.php?topic=15545.0     

Title: Re: EasyUO Documentation Updates
Post by: Gaderian on March 19, 2020, 05:24:27 PM

I updated this to reflect correct values for menu setdef/setprop alignment to allow left (0), right (1) and center (2) for text.

I also updated the code example for event conttop to show using 0 as a value. This allows a script to get the most recently activated gump. The former example showed starting with a value of 1 which will miss what was the current gump with focus. It probably doesn't trip someone up in most cases, but if a script actually wants to run through all the gumps, an event conttop 0 command must be processed.

Gaderian

Title: Re: EasyUO Documentation Updates
Post by: Gaderian on March 20, 2020, 11:39:52 PM

Again more updates:
This time some gump control (I suspect several are still missing from this category).
More importantly are the dress/undress and use object macros.

Some of the "use object" macros I have tested, but others need confirmation.

Gaderian

Title: Re: EasyUO Documentation Updates
Post by: Gaderian on March 23, 2020, 09:40:48 PM

Well, this month I am basically stuck home under COVID-19 community isolation, so I expanded the list a little more.

Still to be confirmed are the various details of event macro 67 and I am suspicious of the event macro 8-11 to have a parameter 22, but I have not been able to isolate it.

The event macro 67 works without doing a finditem and setting variables to issue the event macro 17. Not certain there is a time savings of more than a few ms, but the code would look simpler.

If anyone wants to poke at some of those that need confirmation, post it and I will include it above. Especially are the descriptions/numbers matching accurately on the ones I did not mention as "confirmed" yet.

Gaderian