Protected_ReadonlyaltProtectedmateriaProtectedmateriaProtectedsheetGet the class/job stats for the sheet's class/job.
All custom food items in this sheet.
All custom items in this sheet.
The description of the sheet.
Food items which are relevant and pass the filter. Custom foods will be displayed regardless of filtering.
Whether this sheet is in view-only mode.
The item display settings. Uses a proxy which automatically calls gearDisplaySettingsUpdateLater after any fields are modified.
Get all items which are relevant, and are not filtered out by display settings. Custom items are always displayed regardless of filtering.
The materia autofill controller for this sheet.
This only has a real implementation in GearPlanSheetGui, since materia autofilling is a gui-only feature.
Get the current party bonus amount.
Get the currently-selected race's stats.
Relevant food for the meld/food solver. Will return all of the highest level food with two valid stats and all custom food.
Get materia which are relevant to this sheet.
Get sims which might be relevant to this sheet.
The key under which this sheet should be saved in LocalStorage.
Get all sets on this sheet.
Whether setup/loading is done.
The name of the sheet.
Whether to show advanced stats.
Get all sims on this sheet.
Get the consolidated level/ilevel sync info.
Add any sims which are considered to be "default" sims for this class and level.
Add a new gear set.
The set to add.
Optionalindex: numberThe index at which to insert the set. If omitted, it is added to the end.
Clones the given gear set and adds it as a new gear set.
This will add it prior to the next separator, since separators are typically used to delineate categories of sets.
ProtectedclonedProtectedDetermine the placement index for a cloned set. Helper method of cloneAndAddGearSet.
The set being cloned.
Delete the given custom food item, first asking for confirmation if the item is equipped on any set.
The food item to delete
A callback to be called to confirm the deletion of an item which is currently equipped. Receives the names of sets as the first parameter.
Delete the given custom item, first asking for confirmation if the item is equipped on any set.
The item to delete.
A callback to be called to confirm the deletion of an item which is currently equipped. Receives the names of sets as the first parameter.
Export the sheet to serialized form.
Options for the export.
Return a food item from the DataManager by its ID. Returns undefined if the item could not be found.
The item ID. For custom items, use the custom item's fake ID.
Delete a custom item without confirmation. Will unequip the item from any sets which currently use it.
The item to delete.
Overridable hook for when gear display settings are updated.
Get the best possible materia for a particular slot of the given stat.
Retrieve a particular materia by its item ID. Returns undefined if the materia does not exist.
Get materia which are relevant within a specific slot. On top of needing to be class-relevant, it must fit in the slot.
Return the highest ilvl of non-custom items in a particular slot
Returns the highest
Convert a SetExport back to a CharacterGearSet.
This does not add the set to the sheet or do anything other than conversion.
Import a sim from a sim export. Does not add it to the simulations - you still need to do that if you would like the sim to appear on the sheet (see addSim).
The data to import.
Determine whether a stat can naturally appear on gear. Like isStatRelevant, but returns false if the stat does not appear on gear for this class. e.g. returns false for DH on tanks and healers.
Determine whether a stat is relevant to this sheet based on its job.
Relevant means:
Determine whether a stat should be shown by default on the custom item UI. Same as isStatPossibleOnGear.
The stat
Return an item from the DataManager by its ID. Returns undefined if the item could not be found.
The item ID. For custom items, use the custom item's fake ID.
If true, searches for an NQ version of an otherwise-HQ item.
Load the sheet data fully. Create a DataManager internally.
Load the sheet data from a DataManager. The DataManager must already be loaded before calling this method. This can be used for things like meld solving, where a worker can load a DM once and then re-use it.
The DataManager to use.
Returns the starting set of data for a new custom food.
Returns the starting set of data for a new custom item.
The slot for which to make the custom item.
Force a full recalc of every set. For example, this should be called after a custom item is edited, or after a race/party size change.
Recompute custom item stats, and force a recalc of sets.
This should be called after custom items are modified.
Move a gear set to a new index.
The set to move.
The index to which the gearset should be re-ordered.
Request a save to be completed asynchronously. The actual save is only performed once no more requestSave() calls have happened for a certain timeout, thus allowing multiple modifications to be coalesced into a single save operation.
Copy this sheet to a new save slot.
New name. Leave unspecified/undefined to keep existing name.
New job. Leave unspecified/undefined to keep existing job.
New level. Leave unspecified/undefined to keep existing level.
New ilvl sync. Leave unspecified or use special value 'keep' to keep existing ilvl sync.
Whether to create the new sheet as a multi-job sheet or not.
The saveKey of the new sheet.
Save data for this sheet now.
Enable view-only mode. Cannot be disabled once enabled.
Get the class/job stats for a different class/job.
Base class for a sheet. For graphical usage, see GearPlanSheetGui.