FIELD

Usage: FIELD <field> <command> [<parameters>]

The field commands allow you to define additional fields that will become a part of a user's information. An example of a field is the Oper field. This field is set automatically when someone opers and it shows that they are a network operator. But other fields can display personal information such as a user's age, job, interests, or whatever you want to set up for them.

ADD - Add a field name.

DEL - Delete a field name.

LIST - List a field name configuration.

SET - Set additional configurations on field.

Examples:
 
/as help field <command>

List will show all of the attributes you have set for that field.

Usage: FIELD <field> ADD

This command will create a field for whatever name you select.

Example:

/as field Comment add

This starts the profile for a field by the name of Comment. You will then need to set up what type of field Comment is.

Usage: FIELD <field> DEL

This deletes the field.

Example:

/as field Comment del

Once a field is deleted you will have to start over if you decide you want to use it again.

Usage: FIELD <field> LIST
This command will display all of the settings associated with the field.

Example:

/as field Comment list

This is a useful command for checking how a field is configured.

Usage: FIELD <field> SET <command> on|off
The set commands are used to configure a field. A field is an area where customized information may be displayed. Additional fields allow users to display more information either publicly or only so that opers may see it.

BUDDY - Field value is sent to anyone that is currently online and on your buddy list.

LIMIT - Sets the maximum amount of text that can be set in any field.

ONCHANGE - Field value is sent if changed when two people share a room.

ONJOIN - Field value is sent when two people first share a room.

ONCE - Value may only be set one time, may not be changed.

OPER - Only opers can set/view it.

PRIVATE - Other users cannot see your value.

REMOTE - Value is propagated over the network (otherwise it is local only).

TYPE - Sets the type of data for a specific field.

WATCH - People WATCHing you can see this field if it changes.

WHOIS - Value shows in a WHOIS.

Example:

/as help field set <command>

ConferenceRooms offers the unique ability to create custom fields or modify fields that users have online. This allows you to extend the information to include either public or private fields that can be used for anything from suppport problems to general information that you want others to view. 

Multiple field settings can work together. Each setting defines some aspect of how a field works. For example, you can set both onjoin and onchange on. Then people will see changes when either criterion is met.

Usage: FIELD <field> SET BUDDY [on|off]

When set on people will see changes to the field for everyone in their buddy list regardless of whether they are currently sharing any rooms. 

Example:

/as field set buddy on

This is similar to FIELD SET WATCH except it works for the buddy list.

Usage: FIELD <field> SET LIMIT <field>

Defines the maximum length the specified field can be.

Example:

/as field Comment set limit 256

Usage: FIELD <field> SET ONCE [on|off]

Once set the field cannot be changed during that chat session. Network operators will still be able to change their fields as often as they would like.

Example:

/as field Comment set once on

This can be used to encourage people to use fields for descriptive purposes and not to just play with them. In theory someone could try to flood people with their field changes, but set once would prevent this. It does, however, force people to settle for fields with any mistakes they may have made upon initial setting.

Usage: FIELD <field> SET ONCHANGE [on|off]

When set on people will see the field whenever they share a room and the field value changes.

Example:

/as field Comment set onchange on

By automatically seeing the field when it changes people do not need to check the field value to know what it is. They can look at the initial value and then know they will be informed if it changes.

Usage: FIELD <field> SET ONJOIN [on|off]

People will see the field whenever they both share a room. So upon entering a room you will see this field for all the users and they will see yours.

Example:

/as field Comment set onjoin on

This is often a good setting for fields that provide descriptive material. It allows you to learn a little bit about each person in the room.

Usage: FIELD <field> SET OPER [on|off]

This setting limits the field to network operators. 

Example:

/as field Comment set oper on

Many fields are nice to allow to all users, such as a space for them to put their age or job. But fields that are restricted to network operators make them easier for normal users to identify and harder for normal users to trick other people into thinking they are an operator.

Usage: FIELD <field> SET PRIVATE [on|off]

When private is set on then only network operators can set or view the field.

Example:

/as field Comment set private on

This command creates fields that will work normally except be completely invisible to normal users.

Usage: FIELD <field> SET REMOTE [on|off]

This setting allows a field to be viewable from anywhere on the network. When it is off then fields are only shared between people on the same server.

Example:

/as field Comment set remote on

Whether you wish fields to be local or global will depend primarily on the nature of your network.

Usage: FIELD <field> SET TYPE [string|number|blog]

Allows you to define the data type that will go into this field.

Example:

/as field Comment set type text

Usage: FIELD <field> SET WATCH [on|off]

When set on people will see changes to the field for everyone in their watch lists regardless of whether they are currently sharing any rooms. 

Example:

/as field Comment set watch on

This can be used to send messages to people you are friends with. For example, you could create an away field that would notify everyone on your watch list when you switch it to away or back to here.

Usage: FIELD <field> SET WHOIS [on|off]

This setting causes the field information to show in a /whois command.

Example:

/as field Comment set whois on

A few additional fields in the whois would allow for a full description that is only sent to users who ask for it.