GMODIFY(Builder)

From CoffeeMud Wiki
Revision as of 13:19, 29 August 2019 by Loki (talk | contribs) (→‎Notes)
Jump to navigation Jump to search
CoffeeMUD
Administrator                                                  Builder                                                              Player
=CoffeeMUD Builder Information=
Basics Praetor     Player Support     Commands     Zapper Masks Advanced Races     Classes     Abilities     Socials     Scripting    
Building Behaviors     Properties     Areas     Rooms     Exits     Items     Mobs Systems Achievements     Crafting     Help Info     Ships     Planes of Existence     Quests     Triumphs    
===GMODIFY===
Usage: GMODIFY (AREA/ROOM/WORLD) "FIELD=VAL"(&&/!!"...") (CHANGE="FIELD=VAL")
Examples: gmodify area class=genmob&&name=the cityguard change=name=the guard

gmodify world class=[cs]GenMob&&name=[ss]city change=name=[ss] gmodify world class=[cs]GenItem&&name=a rusty sword change=destroy=true gmodify ?

Shorts:
Description: A command to select objects in a given area, room, or the whole world based on the specified field values, and optionally change some of those specified fields.


Searching the entire world is implied, but the first parameter may be the word AREA or ROOM to narrow the search. You may also enter WORLD to make the world search explicit.


The next parameter is the search criteria. The key phrase WHEN= may optionally precede it to make explicit that you are specifying the search criteria. The search criteria fields may be separated by && strings to specify that all of the preceding criteria AND the next single criteria must be true. The criteria fields may also be separated by !! strings to specify that all of the preceding criteria OR the next single criteria may be true. One of those strings must be present when specifying more than one criteria.


Each field in the search criteria must be of the form FIELD=VALUE, FIELD!=VALUE, FIELD$VALUE, FIELD)VALUE, FIELD(VALUE, FIELD)=VALUE, or FIELD(=VALUE. Where FIELD must be a valid search field. Enter GMODIFY ? for a complete list of all valid fields. Not all fields will apply to all object types, so take this into account especially when using ( or != operators. The operators are all normal except for the new one, $, which means that the value is really a regular expression. The VALUE portion of the criteria may be prefixed with modifiers, which include:

(ss) to specify that the value refers to a substring of the fields whole value.

(cs) to specify that the search is case sensitive (case insensitive is implied).


The last parameter is the optional change specifications. These specifications must be prefixed with the key phrase CHANGE=. If these specifications are not included, GMODIFY will display the results of the search. The change specifications are similar to the search criteria in that they consist of groupings of FIELD=VALUE separated by && strings. Unlike search criteria, however, operators other than =, and strings other than !! have no special meaning. The fields, like in the search criteria, must be valid fields for the options selected by the search criteria. A special field name "DESTROY", when set to true, will obliterate the item in question. Otherwise, the ordinary fields on the object will be changed to the specified value UNLESS the following conditions are met: the VALUE portion of a field is prefixed with the modifier (ss), and the VALUE portion of an identical field in the search criteria was also prefixed with the modifier (ss). Under those special conditions, instead of substituting the entire field value on the object with the new value, ONLY the portion of the string selected in the search criteria will be substituted.


  • Be very careful with this command! It is wise to try the command WITHOUT change= ... first, to make sure you are matching Exactly what you expect, before doing a change pass.

Field Names

CLASS LEVEL ABILITY TEXT RACE NAME DISPLAY DESCRIPTION MONEY ALIGNMENT DISPOSITION SENSES ARMOR DAMAGE ATTACK SPEED AFFBEHAV ABLES INVENTORY TATTS EXPS IMG FACTIONS VARMONEY WHATISELL PREJUDICE AUCHOUSE LIVEPRICE TIMEPRICE TIMEPCT LIVECUT TIMECUT MAXADAYS MINADAYS IGNOREMASK PRICEMASKS ITEMMASK BANKCHAIN COININT ITEMINT LOANINT RIDEBASIS MOBSHELD PUTSTR MOUNTSTR DISMOUNTSTR STATESTR STATESUBJSTR RIDERSTR QUENCHED LIQUIDHELD LIQUIDTYPE CLERREQ CLERRIT WORREQ WORRIT SVCRIT LIBRCHAIN LIBROVERCHG LIBRDAYCHG LIBROVERPCT LIBDAYPCT LIBMINDAYS LIBMAXDAYS LIBMAXBORROW LIBCMASK POSTCHAIN POSTMIN POSTLBS POSTHOLD POSTNEW POSTHELD BUDGET DEVALRATE INVRESETRATE USES SECRET PROPERWORN WORNAND BASEGOLD ISREADABLE ISGETTABLE ISDROPPABLE ISREMOVABLE MATERIAL WEIGHT READABLETEXT DIRECTION RADIUS COORDINATES HASLOCK HASLID CAPACITY CONTAINTYPES RESETTIME DEFCLOSED DEFLOCKED MAXPAGES MAXCHARSPAGE NUMCOINS CURRENCY DENOM NOURISHMENT BITE DOMAINSRC RSUBTYPE WORNLOC BPARTCD EXITNAME CLOSEDTEXT CLOSEWORD OPENWORD SMELLLST SKILLID RECIPES NUMRECIPES AREA OWNER PRICE MINRANGE MAXRANGE WEAPONTYPE WEAPONCLASS AMMOTYPE AMMOCAPACITY LAYER LAYERATTRIB CLANID CITYPE POWERCAP ACTIVATED POWERREM MANUFACTURER TECHLEVEL GENAMTPER INSTFACT RECHRATE CONSUMEDTYPES PANTYPE MAXTHRUST SPECIMPL FUELEFF MINTHRUST ISCONST AVAILPORTS SWARNUMPORTS SWARPORTS SWARMTYPES COORDS ROLL FACING CLASSTYPE ADDABILITY DELABILITY ADDBEHAVIOR DELBEHAVIOR ADDAFFECT DELAFFECT REJUV GENDER DESTROY RESOURCE MATERIALTYPE

Notes

  • Use READABLETEXT field for GenKey Assigned Key Code.
  • Due to the nature of this command (you can really mess up the database), GMODIFY is an Archon-only command.
  • When using gender as a parameter, use M, F, or N for Male, Female and Neuter settings.
    • While MALE and FEMALE are recognized as valid settings, NEUTER is not.