Skip to content

Latest commit

 

History

History
233 lines (120 loc) · 6.74 KB

README.md

File metadata and controls

233 lines (120 loc) · 6.74 KB

Todo

  • Fix ScreenAdjust for radar

HUDs

InterfaceController starts and controls a number of replacement UIs.

Chat

Inventory

Nav

Network

Property Editor

Radar

Components

An IComp (avoiding MS stuff) is a building blocks for HUDs. All have:

  • _id automatically generated using a static field
  • Styling options handled internally
  • Check which renders the component and returns true if it was interacted with
    • DrawBody, called inside of Check which draws elements specific to the component
    • Changed is set to false at the start and set to true on interaction
  • Different data needs handled by the state of the subclass, used when they've been interacted with in a style similar to ImGui
  • Init/Dispose

Picker

A IPicker<T> draws the elements needed to select something, such as value(s) from an Enum

  • Has a T Selection for the last element interacted with
  • ICollectionPicker<T> adds
    • T[] Choices and loops through them in DrawBody
    • DrawItem(T item, int index) renders each item
  • IPagedPicker<T> adds
    • DrawPageControls to the start of DrawBody
    • Number of items PerPage and the CurrentPage are used to display only part of the choices
  • TexturedPicker

Filter

A IFilter<T> draws some filtering criteria

  • It has a predicate for T used for
    • IEnumerable<T> GetFiltered(IEnumerable<T> input)
    • bool IsFiltered(T item)

An IOptionalFilter<T>

  • Adds in a DrawToggle which controls the Active state of the filter
  • That may be used to skip rendering the rest of the filter

Types of filters:

  • RegexFilter filters based on text for a provided object and a Func<T, string> method
  • Todo?
    • ValueComparisonFilter has a CompareType combo and a double input that is compares to a Func<T, double?> method
    • BoolFilter for a list of boolean values

Modal

A Modal is a centered popup for complex inputs

  • Keeps track of whether it is _open or the negation of that, Finished
    • Not drawn if the modal is closed
    • Returns true when the modal is closed
    • Changed indicates whether the component was interacted with
  • Name kept unique using _id
  • MinSize/MaxSize used to set constraints
  • Open/Close for related behavior
  • Optionally renders as a popup with IsPopup
  • PickerModal<T> displays a Picker and closes if an item is selected.
  • May use a manager/static default version for modals that will only exist one place at a time so a local copy isn't needed

Helpers

Enum Map

Map (Prop, value) to Enum type

  • PropId.TryGetEnum(PropType value) maps values of a property to their enum, if there is one
  • Used to find names / valid values

ComputedProperty

A ComputedProperty is a desired property that doesn't directly exist

  • Min damage from variance
  • Calculated resistance of armor
  • etc.

Descriptions

  • wo.Describe returns a description of a given WorldObject by routing it to the relevant collections of descriptions

    • wo.TryDescribe fails if the property was missing
    • List of PropType - key?
    • Ignored if empty string / null

  • wo.Describe(PropId key, bool formatted) exist for each type of property you may want to know about

  • CompoundProperty is used to handle descriptions that involve more than one property

    • All types of resistance

  • Dictionaries of format strings exist for each type of property, and if format=true that value will be returned instead

    • Possibly make use of params for props with more than one input

  • Prop.Friendly(value) will return a friendly name for a property value

    • Based on ACE's GetValueEnumName in Property<Type>Extensions
    • Enum values->names
    • Percent conversions like on attack skill
    • etc.

  • Prop.Label() returns a label for a property

    • Returns a descriptive label for the property like "Ammunition" for IntId.AmmoType

    • Defaults to the name of the property (or number, if not defined in the enum)

Example Usage

  • wo.Describe(game.World.Selected)

  • wo.Describe(IntId.AmmoType)

    • Starts by finding the value: wo.TryGet(IntId.AmmoType)
      • Returns null if missing
    • Then finds the friendly name: wo.Friendly(IntId.AmmoType, value)
      • Finds the value on the WorldObject and returns "" if missing
      • If available it calls Friendly on the prop with the found value:
        • IntId.AmmoType.Friendly(4) ->"Dart"
        • If missing returns null?
    • Format is found
      • "Uses {0}s as ammunition." ->
      • "Uses Darts as ammunition"
    • Format not found
      • "Darts"

Misc

Drag/Drop

The SetDragDropPayload function allows you to attach data to the drag and drop operation, and it requires specifying the payload type, data pointer, and data size.

Operations on pointers are:

Pointer declarations look like:

type* identifier;
void* identifier; //allowed but not recommended

Reference: