A class for converting the relevant data in scrying workshop links and dragon profile pages into indices in the arrays of module:FRjs/data, and for converting those indices into a functioning scrying workshop link. See the DragonTraits class' documentation for more details. See the tutorial for usage examples.
Constructs a formal DragonTraits object from a generic object containing indices in FRjs/data arrays for any/all of a single dragon's traits. Calling the constructor directly is useful for converting traits into scrying workshop links, and for quickly getting the actual data objects for all traits.
\nAny traits that are left undefined, or which are invalid, will be set to a default value; index 0 for most traits, and for genes the index of Basic.
"},{"title":"module:FRjs/convert.DragonTraits.fromProfile","link":"fromProfile","description":"Returns a {@link module:FRjs/convert.DragonTraits DragonTraits} object containing all traits defined in the contents of the given dragon profile. Note: gender is not present in text on dragon profiles, and will be the default of Male.
"},{"title":"module:FRjs/convert.DragonTraits.fromScrylink","link":"fromScrylink","description":"Returns a {@link module:FRjs/convert.DragonTraits DragonTraits} object containing all the traits defined in the given scrying workshop link.
"},{"title":"module:FRjs/convert.DragonTraits#indices","link":"indices","description":"Object containing all traits as indices in the applicable array from {@link module:FRjs/data FRjs/data}.
\nThe structure of the object is:
\n{\n\tbreed: number,\n\teye: number,\n\telement: number,\n\tgender: number,\n\tage: number,\n\tcolour: {\n\t\tprimary: number,\n\t\tsecondary: number,\n\t\ttertiary: number\n\t},\n\tgene: {\n\t\tprimary: number,\n\t\tsecondary: number,\n\t\ttertiary: number\n\t}\n}\nA link to the scrying workshop for a dragon with all defined traits.
"},{"title":"module:FRjs/convert.DragonTraits#values","link":"values","description":"An object containing all traits as data objects from {@link module:FRjs/data FRjs/data}.
\nThe structure of the object is:
\n{\n\tbreed: FR.Breed,\n\teye: FR.EyeType,\n\telement: FR.BasicTrait,\n\tgender: FR.BasicTrait,\n\tage: FR.BasicTrait,\n\tcolour: {\n\t\tprimary: FR.Colour,\n\t\tsecondary: FR.Colour,\n\t\ttertiary: FR.Colour\n\t},\n\tgene: {\n\t\tprimary: FR.Gene,\n\t\tsecondary: FR.Gene,\n\t\ttertiary: FR.Gene\n\t}\n}\nData about Flight Rising's dragon traits and breeding mechanics, and utility functions to streamline working with that data.
"},{"title":"module:FRjs/data.AGES","link":"AGES","description":"The two possible dragon ages in Flight Rising. Ordered as they are in-game.
"},{"title":"module:FRjs/data.areBreedsCompatible","link":"areBreedsCompatible","description":"Returns true if the two given breeds are compatible for breeding -- meaning either they're both modern breeds, or they're the same ancient breed -- and false if they aren't. If either parameter is not an index in {@link module:FRjs/data.BREEDS BREEDS}, returns undefined.
All available breeds in Flight Rising. Sorted by name (ascending). [Data Source]{@link https://www1.flightrising.com/wiki/wiki}
"},{"title":"module:FRjs/data.BreedType","link":"BreedType","description":"Enum for breed types. This effects which genes are available on a breed, and which breed(s) it can be paired with.
"},{"title":"module:FRjs/data.calcRarityProb","link":"calcRarityProb","description":"Compares two objects with rarities from the given array, and returns the probability of the given target outcome occurring. If the indexes aren't in the array, or the array members don't have rarities, returns undefined.
Yields indices on {@link module:FRjs/data.COLOURS COLOURS} of all colours in the shortest range between the two given colours. If either parameter is not an index in COLOURS, yields nothing.
Calculates the length of the shortest range between two colours. If either parameter is not an index in {@link module:FRjs/data.COLOURS COLOURS}, returns undefined.
All available colours in Flight Rising. Ordered as they are in-game. This should be treated as a circular array.
"},{"title":"module:FRjs/data.ELEMENTS","link":"ELEMENTS","description":"All possible elements (flights) in Flight Rising. Ordered as they are in-game.
"},{"title":"module:FRjs/data.EYES","link":"EYES","description":"All possible eye types in Flight Rising. Sorted by probability (descending). [Data Source (retrieved 2024-04-09 at 12:07 PM EST)]{@link https://docs.google.com/spreadsheets/d/1VOh1gwr-cCNMltfIFG8XHM-kEsBJLgVRg19HgiJ89ZA/edit#gid=0}
"},{"title":"module:FRjs/data.GENDERS","link":"GENDERS","description":"The two possible dragon genders in Flight Rising. Ordered as they are in-game.
"},{"title":"module:FRjs/data.GENES","link":"GENES","description":"All available genes, organized into primary, secondary, and tertiary slots. Each slot is sorted by name (ascending). [Data Source]{@link https://www1.flightrising.com/forums/gde/3109561}
\nThis object has the following structure:
\n{\n\tprimary: Gene[],\n\tsecondary: Gene[],\n\ttertiary: Gene[]\n}\nYields indices on {@link module:FRjs/data.GENES GENES} of all genes available to a breed in a specific slot. If no breed id or an invalid breed id is provided, ignores restrictions and yields all genes for this slot. If the slot is invalid, yields nothing.
"},{"title":"module:FRjs/data.isColourInRange","link":"isColourInRange","description":"Returns true if the target colour is in the shortest range between two given colours, and false if it isn't. If any parameter is not an index in {@link module:FRjs/data.COLOURS COLOURS}, returns undefined. Range includes both end colours.
Returns true if the colour range from target1 to target2 is a sub-range of the colour range from range1 to range2, and false if not. If any parameter is not an index in {@link module:FRjs/data.COLOURS COLOURS}, returns undefined. Both ranges include both their end colours.
Returns an array containing possible nest sizes and their probabilities if dragons of the two given breeds are nested. If the given breeds are incompatible, or if either parameter is not an index in {@link module:FRjs/data.BREEDS BREEDS}, returns undefined.
Enum for rarities. Every breed and gene has a rarity which affects it's probability of occurring through breeding.
"},{"title":"module:FRjs/data.rarityTableLookup","link":"rarityTableLookup","description":"Given two rarities to compare, returns an array containing, in order, the probability that rarity1 occurs and the probability that rarity2 occurs. If invalid rarities are given, returns undefined.
Defines extensions of the native HTML <select> element which self-populate with different kinds of Flight Rising data. Available elements are registered as fr-eyes, fr-colours, fr-breeds, fr-genes, fr-ages, fr-genders, and fr-elements. See the tutorials for usage.
Customized Built-in Elements are not natively supported in Safari, but the custom dropdowns should work in Safari anyway because the module loads a polyfill if CBIE support is not detected.
"},{"title":"module:FRjs/forms~AgeSelect","link":"AgeSelect"},{"title":"module:FRjs/forms~BreedSelect","link":"BreedSelect"},{"title":"module:FRjs/forms~ColourSelect","link":"ColourSelect"},{"title":"module:FRjs/forms~ElementSelect","link":"ElementSelect"},{"title":"module:FRjs/forms~EyeSelect","link":"EyeSelect"},{"title":"module:FRjs/forms~GenderSelect","link":"GenderSelect"},{"title":"module:FRjs/forms~GeneSelect","link":"GeneSelect"},{"title":"module:FRjs/forms~PubSub#checkMessage","link":"checkMessage","description":"Check the last message sent to a given channel.
"},{"title":"module:FRjs/forms~PubSub#sendMessage","link":"sendMessage","description":"Send a message to everyone subscribed to the given channel.
"},{"title":"module:FRjs/forms~PubSub#subscribe","link":"subscribe","description":"Subscribe to messages sent to a specific channel, and also receive the last message sent to the channel if there is one.
"}]}