Skip to content
Permalink
Browse files

add some basic object type meta docs

  • Loading branch information...
mcmonkey4eva committed Apr 13, 2019
1 parent ee222fa commit f728c5f1795c7ce446e5237e2938d7f5c4f44f26
@@ -15,6 +15,26 @@

public class CustomObject implements dObject, dObject.ObjectAttributable, Adjustable {

// <--[language]
// @name Custom Objects
// @group Object System
// @description
// Custom objects are custom object types. They use a script basis to create an object
// similar to the base object types (dLists, dPlayers, etc).
//
// Usage of these should generally be avoided, as they can be considered 'over-engineering'...
// That is, using a very complicated solution to solve a problem that can be solved much more simply.
//
// -->

// <--[language]
// @name custom@
// @group Object Fetcher System
// @description
// custom@ refers to the 'object identifier' of a Custom Object. The 'custom@' is notation for Denizen's Object
// Fetcher. The constructor for an Custom Object is the name of the custom script, with any relevant properties specified.
// -->

@Fetchable("custom")
public static CustomObject valueOf(String string, TagContext context) {
Matcher m;
@@ -68,6 +68,19 @@ public static Element valueOf(String string) {
return valueOf(string, null);
}

// <--[language]
// @name el@
// @group Object Fetcher System
// @description
// el@ refers to the 'object identifier' of an Element. The 'el@' is notation for Denizen's Object
// Fetcher. The constructor for an Element is just any text.
//
// For example 'el@hello' forms an element with text 'hello'.
//
// Elements do not output with 'el@' visible. The 'el@' is only for use as a shorthanded constructor.
// If you need an element constructor, consider using the '<element[text here]>' tag base instead.
// -->

/**
* @param string the string or dScript argument String
* @return a dScript dList
@@ -21,6 +21,29 @@

public class dList extends ArrayList<String> implements dObject, dObject.ObjectAttributable {

// <--[language]
// @name dList
// @group Object System
// @description
// A dList is a list of any data. It can hold any number of objects in any order.
// The objects can be of any basic Denizen object type, including another list
// (escaping sub-lists is strongly recommended).
//
// -->

// <--[language]
// @name li@
// @group Object Fetcher System
// @description
// li@ refers to the 'object identifier' of a dList. The 'li@' is notation for Denizen's Object
// Fetcher. The constructor for a dList is the content items of a list separated by a pipe '|' symbol.
// For example, if I had a list of 'taco', 'potatoes', and 'cheese', I would use
// 'li@taco|potatoes|cheese'
//
// A list with zero items in it is simply 'li@'
// and a list with one item is just the one item and no pipes.
// -->

public final ArrayList<dObject> objectForms;

@Override

0 comments on commit f728c5f

Please sign in to comment.
You can’t perform that action at this time.