EZ script: Difference between revisions

The official GemStone IV encyclopedia.
Jump to navigation Jump to search
m (Added alteration guideline help.)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''EZ scripts''' (formerly custom scripts) are a part of the [[Long-term Benefits|Premium benefits]] allowing you to add a personal touch to your items. They are also often available as [[festival]] wins. You can tell if an item is EZ scripted by using the [[ANALYZE (verb)|analyze verb]].
'''EZ scripts''' (formerly custom scripts) are a part of the [[Long-term Benefits|Premium benefits]] allowing you to add a personal touch to your items. They are also often available as [[festival]] wins. You can tell if an item is EZ scripted by using the [[ANALYZE (verb)|analyze verb]].

In October 2024, EZScripts were converted to [[:Category:Flourishes|Flourishes]]. The terminology is still EZScript.


Each initial EZ script costs 1200 [[premium point]]s. Additional scripts cost 600 premium points. If your item already has the EZ script on it, say, from a festival win, each additional script will cost 600 points and you can disregard the initial 1200 point cost. If your item currently has any other script, it cannot also take the EZ script.
Each initial EZ script costs 1200 [[premium point]]s. Additional scripts cost 600 premium points. If your item already has the EZ script on it, say, from a festival win, each additional script will cost 600 points and you can disregard the initial 1200 point cost. If your item currently has any other script, it cannot also take the EZ script.


Any alteration must be in line with what the item does, but it could take a long or a show, or both, or a custom loresong.
Any alteration must be in line with what the item does, but it could take a long or a show, or both, or a custom loresong, dependent on any requirements of the primary script.


==Analyze==
==Analyze==
Line 23: Line 25:


If there is a typo in the above messaging, please ASSIST and request a referral to speak to a GameMaster to fix it. DO NOT BUG or BUGITEM the ring!
If there is a typo in the above messaging, please ASSIST and request a referral to speak to a GameMaster to fix it. DO NOT BUG or BUGITEM the ring!
</pre>

==Verbs==
==Verbs==
You can choose the first person view, third person view, and for some verbs a message the room will get when you activate the item when hidden.
You can choose the first person view, third person view, and for some verbs a message the room will get when you activate the item when hidden.
Line 29: Line 31:
When planning the messaging, please keep in mind that the EZ script does not check for various statuses, so the messaging has to be fairly generic. For example, you cannot tilt your dagger and take a step forward, because the EZ script does not check to see if you are sitting first.
When planning the messaging, please keep in mind that the EZ script does not check for various statuses, so the messaging has to be fairly generic. For example, you cannot tilt your dagger and take a step forward, because the EZ script does not check to see if you are sitting first.


The full list of currently available verbs is clean, close, hug, kiss, open, pinch, poke, pull, push, raise, rub, tap, tickle, tilt, touch, toss, turn, wave, flip, remove, wear, lace, and smell. However, not all of these verbs may be available for your particular item or work the way you expect. Verb messaging cannot be targeted for persons or items.
The full list of currently available verbs is bounce, bow, clean, close, chortle, curtsy, flip, growl, hug, kiss, lace, lean, open, pinch, poke, prance, pull, purr, push, raise, roar, rub, smell, swoon, tap, tickle, tilt, touch, toss, turn, wave, remove, wear, whistle, and yell. However, not all of these verbs may be available for your particular item or work the way you expect. Verb messaging cannot be targeted for persons or items.


If your item is not wearable, you can disregard the held and worn categories below. If your item can be worn, there are some verb traps that will only work when worn. Wear and Remove will message appropriately if the item is wearable and can be customized with EZ script messaging. Open and close are available for containers only.
If your item is not wearable, you can disregard the held and worn categories below. If your item can be worn, there are some verb traps that will only work when worn, except for wearable weapons. Wear and Remove will message appropriately if the item is wearable and can be customized with EZ script messaging. Open and close are available for containers only.

*These verbs will check if the player is silenced: chortle, growl, purr, roar, whistle, yell
*These verbs will only work if the player is standing: bow, bounce, curtsy, lean, prance, swoon
*Open and close will only work on containers.
*Lace and wear will only work while held.
*Pinch, poke, tap, and tickle will work regardless of whether the item is held, worn, on the ground, in a backpack, etc.
*For other traps, if the item can be worn, the verb traps will only work while worn. Except for wearable weapons, which will only work while held.
*Not all verbs will allow hidden or invisible messaging. If the hidden messaging is important to you, please specify so the GM working with you can double check.


{| {{prettytable}}
{| {{prettytable}}
!VERB !! HELD !! WORN !! HIDDEN
!VERB !! HELD !! WORN !! HIDDEN !! SILENCE<br>CHECK !! STANDING<br>CHECK !! GROUND
|-
|-
| [[OPEN (verb)]] || X || X || X
| [[OPEN (verb)]] || X || X || X || || ||
|-
|-
| [[CLOSE (verb)]] || X || X || X
| [[CLOSE (verb)]] || X || X || X || || ||
|-
|-
| [[CLEAN (verb)]] || || X ||
| [[Verb:BOUNCE|BOUNCE]] || X || X || X || || X ||
|-
|-
| [[FLIP (verb)]] || || X ||
| [[Verb:BOW|BOW]] || X || X || X || || X ||
|-
|-
| [[HUG (verb)]] || || X || X
| [[Verb:CHORTLE|CHORTLE]] || X || X || X || X || ||
|-
|-
| [[KISS (verb)]] || || X || X
| [[CLEAN (verb)]] || || X || || ||
|-
|-
| [[LACE (verb)]] || X || ||
| [[Verb:CURTSY|CURTSY]] || X || X || X || || X ||
|-
|-
| [[PINCH (verb)]] || X || X || X
| [[Verb:GROWL|GROWL]] || X || X || X || X || ||
|-
|-
| [[POKE (verb)]] || X || X ||
| [[FLIP (verb)]] || || X || || || ||
|-
|-
| [[PULL (verb)]] || || X ||
| [[HUG (verb)]] || || X || X || || ||
|-
|-
| [[PUSH (verb)]] || || X ||
| [[KISS (verb)]] || || X || X || || ||
|-
|-
| [[RAISE (verb)]] || || X || X
| [[LACE (verb)]] || X || || || || ||
|-
|-
| [[RUB (verb)]] || || X || X
| [[Verb:LEAN|LEAN]] || X || X || X || || X ||
|-
| [[PINCH (verb)]] || X || X || X || || || X
|-
| [[POKE (verb)]] || X || X || || || || X
|-
| [[Verb:PRANCE|PRANCE]] || X || X || X || || X ||
|-
| [[PULL (verb)]] || || X || || || ||
|-
| [[PURR (verb)]] || X || X || X || X || ||
|-
| [[PUSH (verb)]] || || X || || || ||
|-
| [[RAISE (verb)]] || || X || X || || ||
|-
| [[ROAR (verb)]] || X || X || X || X || ||
|-
| [[RUB (verb)]] || || X || X || || ||
|-
|-
| [[SMELL (verb)]] || || X || X
| [[SMELL (verb)]] || || X || X || || ||
|-
|-
| [[TAP (verb)]] || X || X || X
| [[Verb:SWOON|SWOON]] || X || X || X || || X ||
|-
|-
| [[TICKLE (verb)]] || X || X || X
| [[TAP (verb)]] || X || X || X || || || X
|-
|-
| [[TILT (verb)]] || || X || X
| [[TICKLE (verb)]] || X || X || X || || || X
|-
|-
| [[TOSS (verb)]] || || X ||
| [[TILT (verb)]] || || X || X || || ||
|-
|-
| [[TOUCH (verb)]] || || X || X
| [[TOSS (verb)]] || || X || || || ||
|-
|-
| [[TURN (verb)]] || || X || X
| [[TOUCH (verb)]] || || X || X || || ||
|-
|-
| [[WAVE (verb)]] || || X ||
| [[TURN (verb)]] || || X || X || || ||
|-
|-
| [[REMOVE (verb)]] || || X || X
| [[WAVE (verb)]] || || X || || || ||
|-
|-
| [[WEAR (verb)]] || X || ||
| [[WHISTLE (verb)]] || X || X || X || X || ||
|-
| [[YELL (verb)]] || X || X || X || X || ||
|-
| [[REMOVE (verb)]] || || X || X || || ||
|-
| [[WEAR (verb)]] || X || || || || ||
|-
|-
|}
|}

==Messaging Character Limit==
==Messaging Character Limit==
Please note that each message (1st person, 3rd person, and hidden (if eligible)) has a character limit of 511 characters, including double spaces and punctuation.
Please note that each message (1st person, 3rd person, and hidden (if eligible)) has a character limit of 511 characters, including double spaces and punctuation.


==Messaging Restrictions==
==Messaging Restrictions==
While a final ruling will always be made through the QC process, your item's messaging should largely revolve around the item itself, and should not imply any sort of magical abilities or divine influences. Also note that no actions can include speech, and all actions must be able to be performed while sitting, standing, or prone (and cannot imply a change in any of those statuses - Nothing that makes you 'leap to your feet', for example.)
While a final ruling will always be made through the QC process, your item's messaging should largely revolve around the item itself, and should not imply any sort of magical abilities or divine influences. Also note that no actions can imply a change in statuses - Nothing that makes you 'leap to your feet', for example.

Items can't be made to glow, pulsate, vibrate, shake, rattle, squirm, giggle, shimmer, or emanate, unless there's a really good reason for such, based in the item's actual qualities. The item does not move independently, or do things without being activated. A non-magic item could not glow. It might glitter or scintillate if it's encrusted with gems, but it won't cast any light of its own. Avoid the words, "seems to" or "appears to". A "cloak that seems to have a life of its own" is one that tromps all over the rule of not making an item appear to have properties it does not have.

Scripts cannot:

*Cause magical-looking effects if they are not magical.
*Make an item sentient.
*Make you "vanish", "disappear", or move in any way.
*Change the normal properties of an item, cannot make a sword flare if it doesn't already.
*Transform into things, or interact with other items on your person.
*Do things you couldn't do, either with normal mechanics or even ACT. Such as, "Khaladon rubs his crystal ball and a fireball blooms into view and strikes beside you."
*Basically, the script add will let you lend "personality" or "flair" to an item, but it's not the same as a "scripted" item you get at a merchant as there is far less control and checking.

Here are a couple of good examples.

First person message: You rub your falchion, and it shines a bit brighter.

Third person: Khaladon rubs his falchion and it shines a bit brighter.

Hidden view, if applicable. If this field is not provided, then when hidden, only the first person message is displayed, same if you're in an invisible state.

==See Also==
* [[Announcement:EZScript Updates - Flourish Conversion and Additional Verb Traps]]


[[Category:Item Scripts]]
[[Category:Item Scripts]]
[[category:Merchant Services]]
[[category:Merchant Services]]
[[Category: Delayed Services]]
[[Category: Delayed Services]]
[[Category:Flourishes]]

Latest revision as of 09:49, 2 October 2024

EZ scripts (formerly custom scripts) are a part of the Premium benefits allowing you to add a personal touch to your items. They are also often available as festival wins. You can tell if an item is EZ scripted by using the analyze verb.

In October 2024, EZScripts were converted to Flourishes. The terminology is still EZScript.

Each initial EZ script costs 1200 premium points. Additional scripts cost 600 premium points. If your item already has the EZ script on it, say, from a festival win, each additional script will cost 600 points and you can disregard the initial 1200 point cost. If your item currently has any other script, it cannot also take the EZ script.

Any alteration must be in line with what the item does, but it could take a long or a show, or both, or a custom loresong, dependent on any requirements of the primary script.

Analyze

You analyze your jackal-headed ring and sense that the item is largely free from merchant alteration restrictions.

The creator has also provided the following information:

This is an EzScripted item.  Some alteration restrictions may apply.  It has the following messaging:

  wave
  1st Person: You wave your noisemaker wildly over your head, and the movement of air through the contraption creates a low-toned whistle.  A tiny flurry of white, azure, and gold confetti floats down around you.
  3rd Person: Vanah waves her noisemaker wildly over her head, and the movement of air through the contraption creates a low-toned whistle.  A tiny flurry of white, azure, and gold confetti floats down around her.

  tilt
  1st Person: Tilting your noisemaker upside down, you give it a little shake, but no confetti falls out.  Holding it up, you peer into the open end, and all of a sudden a cloud of violet and silver confetti hits you in the face!
  3rd Person: Tilting her noisemaker upside down, Vanah gives it a little shake, but no confetti falls out.  Holding it up, she peers into the open end, and all of a sudden a cloud of violet and silver confetti hits her in the face!
  Hidden:     A cloud of violet and silver confetti bursts forth and glitters down over the area.

If there is a typo in the above messaging, please ASSIST and request a referral to speak to a GameMaster to fix it.  DO NOT BUG or BUGITEM the ring!

Verbs

You can choose the first person view, third person view, and for some verbs a message the room will get when you activate the item when hidden.

When planning the messaging, please keep in mind that the EZ script does not check for various statuses, so the messaging has to be fairly generic. For example, you cannot tilt your dagger and take a step forward, because the EZ script does not check to see if you are sitting first.

The full list of currently available verbs is bounce, bow, clean, close, chortle, curtsy, flip, growl, hug, kiss, lace, lean, open, pinch, poke, prance, pull, purr, push, raise, roar, rub, smell, swoon, tap, tickle, tilt, touch, toss, turn, wave, remove, wear, whistle, and yell. However, not all of these verbs may be available for your particular item or work the way you expect. Verb messaging cannot be targeted for persons or items.

If your item is not wearable, you can disregard the held and worn categories below. If your item can be worn, there are some verb traps that will only work when worn, except for wearable weapons. Wear and Remove will message appropriately if the item is wearable and can be customized with EZ script messaging. Open and close are available for containers only.

  • These verbs will check if the player is silenced: chortle, growl, purr, roar, whistle, yell
  • These verbs will only work if the player is standing: bow, bounce, curtsy, lean, prance, swoon
  • Open and close will only work on containers.
  • Lace and wear will only work while held.
  • Pinch, poke, tap, and tickle will work regardless of whether the item is held, worn, on the ground, in a backpack, etc.
  • For other traps, if the item can be worn, the verb traps will only work while worn. Except for wearable weapons, which will only work while held.
  • Not all verbs will allow hidden or invisible messaging. If the hidden messaging is important to you, please specify so the GM working with you can double check.
VERB HELD WORN HIDDEN SILENCE
CHECK
STANDING
CHECK
GROUND
OPEN (verb) X X X
CLOSE (verb) X X X
BOUNCE X X X X
BOW X X X X
CHORTLE X X X X
CLEAN (verb) X
CURTSY X X X X
GROWL X X X X
FLIP (verb) X
HUG (verb) X X
KISS (verb) X X
LACE (verb) X
LEAN X X X X
PINCH (verb) X X X X
POKE (verb) X X X
PRANCE X X X X
PULL (verb) X
PURR (verb) X X X X
PUSH (verb) X
RAISE (verb) X X
ROAR (verb) X X X X
RUB (verb) X X
SMELL (verb) X X
SWOON X X X X
TAP (verb) X X X X
TICKLE (verb) X X X X
TILT (verb) X X
TOSS (verb) X
TOUCH (verb) X X
TURN (verb) X X
WAVE (verb) X
WHISTLE (verb) X X X X
YELL (verb) X X X X
REMOVE (verb) X X
WEAR (verb) X

Messaging Character Limit

Please note that each message (1st person, 3rd person, and hidden (if eligible)) has a character limit of 511 characters, including double spaces and punctuation.

Messaging Restrictions

While a final ruling will always be made through the QC process, your item's messaging should largely revolve around the item itself, and should not imply any sort of magical abilities or divine influences. Also note that no actions can imply a change in statuses - Nothing that makes you 'leap to your feet', for example.

Items can't be made to glow, pulsate, vibrate, shake, rattle, squirm, giggle, shimmer, or emanate, unless there's a really good reason for such, based in the item's actual qualities. The item does not move independently, or do things without being activated. A non-magic item could not glow. It might glitter or scintillate if it's encrusted with gems, but it won't cast any light of its own. Avoid the words, "seems to" or "appears to". A "cloak that seems to have a life of its own" is one that tromps all over the rule of not making an item appear to have properties it does not have.

Scripts cannot:

  • Cause magical-looking effects if they are not magical.
  • Make an item sentient.
  • Make you "vanish", "disappear", or move in any way.
  • Change the normal properties of an item, cannot make a sword flare if it doesn't already.
  • Transform into things, or interact with other items on your person.
  • Do things you couldn't do, either with normal mechanics or even ACT. Such as, "Khaladon rubs his crystal ball and a fireball blooms into view and strikes beside you."
  • Basically, the script add will let you lend "personality" or "flair" to an item, but it's not the same as a "scripted" item you get at a merchant as there is far less control and checking.

Here are a couple of good examples.

First person message: You rub your falchion, and it shines a bit brighter.

Third person: Khaladon rubs his falchion and it shines a bit brighter.

Hidden view, if applicable. If this field is not provided, then when hidden, only the first person message is displayed, same if you're in an invisible state.

See Also