Skip to content

Latest commit

 

History

History
233 lines (216 loc) · 40.6 KB

API-Reference.md

File metadata and controls

233 lines (216 loc) · 40.6 KB

API reference

Every function, property id, hook and map event CMF offers to mods (API version 19). The signatures are read from cmfCore.ws, and the list of calls from the pack tool, which refuses any other CMF... call. "Since" is the API version that added it: check it with CMFRequireVersion, or ask CMFHasProperty or CMFHasAbility first. "Explained on" names the pages that use it.

Functions

Function Since What it does Explained on
CMFGetVersion() : int 1 CMFRegisterIcon, CMFRegisterIconForTag | image path | unused (0) | 40 with this id at the same slot Writing your script, Getting started
CMFHasProperty(propertyId : int) : bool 1 true when the installed CMF understands that property id. Writing your script, Animated pictures, Legend rows and filter tabs
CMFRegister(provider : string, propertyId : int, target : name, mapContext : name, text : string, number : int) : bool 1 One claim for a pin type (a map area for property 4). Writing your script, Pin size, labels and the info box, Animated pictures
CMFRegisterBackground(provider : string, area : name, imageRoot : string) 1 Replaces the map image of one area, such as 'AN_NMLandNovigrad' (Velen and Novigrad). Writing your script
CMFRegisterDisabled(provider : string, pinType : name, mapContext : name, disable : bool) 1 Draws every pin of that type greyed (grey art at reduced opacity, tint skipped). Writing your script, Greying pins, Settings file keys
CMFRegisterDisabledForTag(provider : string, pinTag : name, mapContext : name, disable : bool) 1 The same for one pin by its tag; it beats type-level claims on that pin. Writing your script, Greying pins
CMFRegisterForTag(provider : string, propertyId : int, pinTag : name, mapContext : name, text : string, number : int) : bool 1 The same for one pin by its tag; accepts properties 1, 5, 9, (API version 4) 10 to 13 and 15, (API version 5) 17, (API version 6) 16, 20, 21 and 22, (API version 10) 28 and (API version 11) 3, 14, 18, 19, 29 and 30 (reason=level otherwise). Changing one pin, Writing your script, Porting a map mod
CMFRegisterIcon(provider : string, pinType : name, url : string) 1 Replaces the art of every pin of that type, and its legend row art unless you register a legend icon too. Writing your script, Getting started, Check and build
CMFRegisterIconForTag(provider : string, pinTag : name, url : string) 1 Replaces the art of one pin, identified by its map pin tag. Writing your script, Choosing pin types
CMFRegisterLegendIcon(provider : string, pinType : name, url : string) 1 Sets only the legend row art for that type. Writing your script, Choosing pin types, Check and build
CMFRegisterTint(provider : string, pinType : name, rgb : int) 1 Multiplies the type's pin art by a colour. Writing your script, Check and build, Porting a map mod
CMFReleaseProvider(provider : string) 1 Withdraws everything your pack registered. Writing your script, Shipping your mod, Greying pins
CMFRequireVersion(provider : string, minVersion : int) : bool 1 Returns false and logs a line when the installed CMF is older than minVersion. Writing your script, Players' choices: who wins each feature, Install and test
CMFPropertyBackground() : int 1 Returns property id 4. Writing your script
CMFPropertyDisabled() : int 1 Returns property id 5. Writing your script
CMFPropertyIcon() : int 1 Returns property id 1. Writing your script
CMFPropertyLegendIcon() : int 1 Returns property id 2. Writing your script
CMFPropertyTint() : int 1 Returns property id 3. Writing your script
CMFRegisterLegendCategory(provider : string, category : name, label : string, priority : int) 2 Declares a filter tab after the vanilla tabs. Writing your script, Legend rows and filter tabs
CMFRegisterLegendLabel(provider : string, filteredType : name, label : string) 2 Names a legend row. Writing your script, Legend rows and filter tabs, Adapter: All Quest Objectives
CMFRegisterLegendRow(provider : string, filteredType : name, category : name, priority : int) 2 Places a legend row in a filter tab; see Legend rows and filter tabs. Writing your script, Legend rows and filter tabs, Adapter: All Quest Objectives
CMFStylePin(provider : string, dataObject : CScriptedFlashObject, propertyId : int, text : string, number : int) : bool 2 Styles one pin object for this map opening; properties 1, 3 and 9, (API version 4) 10 to 13 and 15, (API version 5) 17, (API version 6) 16, 20, 21 and 22, (API version 10) 28 and (API version 11) 14, 18, 19, 29 and 30. Writing your script, Pin size, labels and the info box, Styling one pin
CMFStylePinIcon(provider : string, dataObject : CScriptedFlashObject, url : string) : bool 2 CMFStylePin with property 1. Writing your script, Styling one pin, Adapter: Map Quest Insight
CMFStylePinTint(provider : string, dataObject : CScriptedFlashObject, rgb : int) : bool 2 CMFStylePin with property 3. Styling one pin, Writing your script, Adapter: Map Quest Insight
CMFPropertyLegendCategory() : int 2 Returns property id 8. Writing your script
CMFPropertyLegendLabel() : int 2 Returns property id 7. Writing your script
CMFPropertyLegendRow() : int 2 Returns property id 6. Writing your script, Pins other mods add
CMFHidePin(provider : string, dataObject : CScriptedFlashObject) : bool 3 Hides one pin object for this map opening; CMFStylePin with property 9. Writing your script, Hiding pins, The pin hook: OnPinReady
CMFRegisterHidden(provider : string, pinType : name, mapContext : name, exemptions : string, hide : bool) 3 Hides every pin of a type or filteredType ('' for every pin) in one map context ('' for every context); hide false withdraws. Writing your script, Hiding pins, For players: installing CMF, icon packs and other map mods
CMFRegisterHiddenForTag(provider : string, pinTag : name, mapContext : name, exemptions : string, hide : bool) 3 The same for one pin by its tag. Writing your script, Hiding pins, For players: installing CMF, icon packs and other map mods
CMFPropertyHidden() : int 3 Returns property id 9. Writing your script, Hiding pins
CMFLabelHideCrosshair() : int 4 The two label flags (1, 2). Writing your script, Pin size, labels and the info box
CMFLabelHidePin() : int 4 The two label flags (1, 2). Writing your script, Pin size, labels and the info box
CMFLevelLabel(level : int, difficulty : int) : string 4 A quest level label in the journal's colours, to pass to CMFStylePinLabel. Pin size, labels and the info box, Writing your script, Adapter: Ink and Iron
CMFStylePinLabel(provider : string, dataObject : CScriptedFlashObject, html : string) : bool 4 CMFStylePin with property 12. Pin size, labels and the info box, Writing your script, Styling one pin
CMFStylePinScale(provider : string, dataObject : CScriptedFlashObject, percent : int) : bool 4 CMFStylePin with property 10. Writing your script, Pin size, labels and the info box, Styling one pin
CMFPropertyInfoBoxHeight() : int 4 Returns property id 14. Writing your script, Pin size, labels and the info box, Adapter: Map Quest Insight
CMFPropertyLabelHide() : int 4 Returns property id 13. Pin size, labels and the info box, Writing your script, Adapter: Map Quest Insight
CMFPropertyLabelPlace() : int 4 Returns property id 11. Pin size, labels and the info box, Writing your script, Adapter: Map Quest Insight
CMFPropertyLabelText() : int 4 Returns property id 12. Writing your script, Pin size, labels and the info box
CMFPropertyPinScale() : int 4 Returns property id 10. Writing your script, Pin size, labels and the info box, Adapter: Botanist
CMFPropertyTabHide() : int 4 Returns property id 15. Writing your script, Pin size, labels and the info box, Adapter: Map Quest Insight
CMFDraw(provider : string, anchor : name, id : name, kind : name) : bool 5 Makes a drawing with your own id, tied to a part or to any drawing any mod made. Drawing on the map itself, Map theme parts and keys, The map theme
CMFDrawSet(provider : string, id : name, key : name, text : string, number : float) : bool 5 Sets one key of your drawing: its place, paint, glow, layer and conditions. The map theme, Drawing on the map itself, Map theme parts and keys
CMFHasAbility(part : name, key : name) : bool 5 Asks whether this CMF knows a part, layer or kind (key '') or a key, before you use it. Map theme parts and keys, Drawing on the map itself, Writing your script
CMFStylePart(provider : string, part : name, key : name, text : string, number : float) : bool 5 Sets one style key of a part of the map: fonts, colours, glows, the game's own plates to hide, or a map behaviour. Smooth map movement, The map theme, Spreading stacked pins
CMFPropertyLabelColor() : int 5 Returns property id 17. The map theme, Adapter: Ink and Iron
CMFDrawSetList(provider : string, id : name, key : name, values : array<float>) : bool 6 Lists are set with CMFDrawSetList(provider, id, key, values) (at most 100000 values; an empty array withdraws the key). Drawing on the map itself, Map theme parts and keys, Adapter: Witcher's Path
CMFMapRefresh() : bool 6 When your drawings change while the map stays open, CMFMapRefresh() runs OnMapReady again and redraws every drawing without rebuilding the pins, so the selected tab, pan and zoom stay. Keeping pins over a grid, refreshing and one-pin updates, Drawing on the map itself, Adapter: Witcher's Path
CMFRegisterCategoryNoDefault(provider : string, category : name, noDefault : bool) 6 Keeps the rows of your tab out of Default (true), or lists them there again (false). Writing your script, Legend rows and filter tabs, Adapter: Botanist
CMFPropertyCategoryNoDefault() : int 6 Returns property id 23. Writing your script
CMFPropertyHoverName() : int 6 Returns property id 28. Names only on hover, Writing your script
CMFPropertyIconCompleted() : int 6 Returns property id 30. Writing your script
CMFPropertyIconUndiscovered() : int 6 Returns property id 29. Writing your script
CMFPropertyInfoText() : int 6 Returns property id 19. Writing your script
CMFPropertyInfoTitle() : int 6 Returns property id 18. Writing your script
CMFPropertyPinClick() : int 6 Returns property id 16. Pin clicks, Writing your script, Adapter: Map Pin Teleport
CMFPropertyPinClickButton() : int 6 Returns property id 21. Pin clicks, Writing your script, Adapter: Map Pin Teleport
CMFPropertyPinClickHint() : int 6 Returns property id 20. Pin clicks, Writing your script, Adapter: Map Pin Teleport
CMFPropertyPinScaleFactor() : int 6 Returns property id 51. Writing your script, Player settings and size multipliers
CMFPropertyPinScaleStandard() : int 6 Returns property id 53. Writing your script, Player settings and size multipliers
CMFPropertyPlayerSetting() : int 6 Returns property id 50. Writing your script, Player settings and size multipliers
CMFPropertySelectedScaleFactor() : int 6 Returns property id 52. Writing your script
CMFPropertySpreadRank() : int 6 Returns property id 22. Spreading stacked pins, Writing your script, Adapter: Map Quest Insight
CMFPropertyTabHidden() : int 6 Returns property id 37. Writing your script
CMFChoicesChanged() 8 Tells CMF that a player's choice changed, so it prepares its winners again before the next lookup. Writing your script, Players' choices: who wins each feature
CMFSetProviderName(provider : string, displayName : string) : bool 8 The name CMF's in-game menu shows for your mod, for example "Acme Icons"; without it the menu shows your folder name tidied. Players' choices: who wins each feature, Writing your script, Adapter: Ink and Iron
CMFRegisterButtonPicture(provider : string, family : name, button : string, url : string) : bool 9 Your picture for one controller button of one family on the map. Writing your script, Controller button pictures, Adapter: Ink and Iron
CMFRegisterChoiceOnly(provider : string, choiceKey : string) : bool 9 Your claims for that feature or piece apply only when the player picks your mod for it. Choice-only claims, Writing your script, Install and test
CMFRegisterWorldCrest(provider : string, region : name, url : string) : bool 9 Your picture for one region's crest on the world overview. Writing your script, World overview pictures, Choice-only claims
CMFRegisterWorldMarker(provider : string, marker : name, url : string) : bool 9 Your picture for the overview's 'player' or 'quest' marker. Writing your script, World overview pictures
CMFRegisterWorldPainting(provider : string, url : string) : bool 9 Your picture for the world overview's painting. Writing your script, World overview pictures, Adapter: Ink and Iron
CMFRegisterWorldPaintingTiles(provider : string, url : string, columns : int, rows : int) : bool 9 The painting as columns x rows tiles, each 1 to 8; the path holds {x} and {y}. Writing your script, World overview pictures
CMFSetOpeningView(provider : string, area : name, x : float, y : float, zoom : float, keepPlace : bool) : bool 9 The view a region map opens with, called from an OnMapOpening wrapper. The map's view, Writing your script, Adapter: Annoying Map
CMFSetOpeningWorld(provider : string, area : name, worldX : float, worldY : float, zoom : float) : bool 9 As CMFSetOpeningView, with the place given in world coordinates (for example Geralt's position): the region map opens centred there. The map's view, Writing your script
CMFPropertyButtonPicture() : int 9 Returns property id 26. Writing your script
CMFPropertyWorldCrest() : int 9 Returns property id 25. Writing your script, World overview pictures
CMFPropertyWorldMarker() : int 9 Returns property id 27. Writing your script, World overview pictures
CMFPropertyWorldPainting() : int 9 Returns property id 24. Writing your script, World overview pictures
CMFScreenHeight() : float 10 API version 10. Writing your script, Wide and tall screens
CMFScreenWidth() : float 10 API version 10. Writing your script, Wide and tall screens
CMFDeclareProvider(provider : string) : bool 11 Call CMFDeclareProvider("modAcmeIcons") once from your OnGameStarted wrapper to tell CMF that your mod supplies CMF support. Writing your script
CMFInfoAdd() : int 11 The same holds for every named constant: CMFInfoReplace(), CMFInfoAdd(), CMFLevelPlace(), CMFPlaceRadius(), CMFLabelHidePin(), CMFLabelHideCrosshair() and the other small functions that only return a number. Writing your script, Changing one pin
CMFInfoReplace() : int 11 The same holds for every named constant: CMFInfoReplace(), CMFInfoAdd(), CMFLevelPlace(), CMFPlaceRadius(), CMFLabelHidePin(), CMFLabelHideCrosshair() and the other small functions that only return a number. Writing your script, Changing one pin
CMFLevelPlace() : int 11 The same holds for every named constant: CMFInfoReplace(), CMFInfoAdd(), CMFLevelPlace(), CMFPlaceRadius(), CMFLabelHidePin(), CMFLabelHideCrosshair() and the other small functions that only return a number. Writing your script, Changing one pin
CMFPlaceRadius() : float 11 The same holds for every named constant: CMFInfoReplace(), CMFInfoAdd(), CMFLevelPlace(), CMFPlaceRadius(), CMFLabelHidePin(), CMFLabelHideCrosshair() and the other small functions that only return a number. Writing your script
CMFProviderPresent(provider : string) : bool 11 CMFProviderPresent(provider : string) : bool asks whether a nonempty provider has submitted anything this session, ignoring case; asking never declares it. Writing your script
CMFRegisterForPlace(provider : string, propertyId : int, pinType : name, x : float, y : float, text : string, number : int) : bool 11 API version 11. Changing one pin, Writing your script, Animated pictures
CMFSetLogPins(on : bool) 11 API version 11. Writing your script, Changing one pin
CMFPropertyPresent() : int 11 Returns property id 38. Writing your script
CMFAddPin(provider : string, tag : name, pinType : name, area : name, x : float, y : float, label : string, description : string) : bool 13 API version 13. Writing your script, Pins other mods add, Key hints and filter tab reports
CMFClickInputHold() : int 13 Pin clicks
CMFDeclareTag(provider : string, tag : name) : bool 13 API version 13. Map theme parts and keys, Key hints and filter tab reports, Writing your script
CMFRemovePin(provider : string, tag : name) : bool 13 API version 13. Writing your script
CMFStyle(provider : string, part : name, target : name, key : name, text : string, number : float) : bool 13 API version 13. Map theme parts and keys, Writing your script, Key hints and filter tab reports
CMFDrawSetBits(provider : string, id : name, idx : array<int>, words : array<int>) : bool 14 Then send the cells to leave clear with CMFDrawSetBits(provider, id, idx, words): bit b (0 to 29) of word k is cell k * 30 + b, counted row by row from the north-west corner. Drawing on the map itself, Map theme parts and keys
CMFGridKeepPin(provider : string, dataObject : CScriptedFlashObject) : bool 14 grid (API version 14, mapSpace only) darkens a square of the map cell by cell, such as a fog over unexplored land: n cells per side (1 to 2048), the square's north-west corner left, top and side span in world metres, fill and alpha for the mask, soft (0 to 32 cells) for a soft edge, steps (1 to 16) for that edge's detail (CMF draws 8 layers per step, so the edge reads as a smooth gradient), and hidePins (0 or 1): 1 hides every pin standing on a covered cell, except the player marker, user pins and the pins any provider keeps with CMFGridKeepPin(provider, pin) from a pin wrapper before CMF's late pass (for example the ones your own filter decided to show). Keeping pins over a grid, refreshing and one-pin updates, Pins other mods add, Map theme parts and keys
CMFPropertyFrameOffset() : int 14 Returns property id 47. Writing your script, Animated pictures
CMFPropertyIconFrames() : int 14 Returns property id 45. Writing your script, Animated pictures
CMFPropertyIconUnderFrames() : int 14 Returns property id 46. Writing your script, Animated pictures
CMFPropertyPictureFit() : int 14 Returns property id 48. Pin size, labels and the info box, Writing your script
CMFMapRefreshPins() : bool 17 CMFMapRefreshPins() (API 17; CMFHasAbility('map', 'refreshPins') says it exists) runs the game's full pin build again on the open map, for a mod whose settings change which markers show; it returns false when no map is open. Keeping pins over a grid, refreshing and one-pin updates, Your own movie on the screen, Writing your script
CMFAddedPinMods(out mods : array<string>) : int 18 Pins other mods add
CMFAddedPinTypes(mod : string, out types : array<string>, out rows : array<string>, out counts : array<int>) : int 18 Pins other mods add
CMFDeclareAddedPinType(provider : string, pinType : name, filteredType : name) : bool 18 Pins other mods add
CMFGridUnkeepPin(provider : string, dataObject : CScriptedFlashObject) : bool 18 Keeping pins over a grid, refreshing and one-pin updates, Map theme parts and keys
CMFPropertyGridKeepEpoch() : int 18 Keeping pins over a grid, refreshing and one-pin updates

Property ids

The generic calls CMFRegister, CMFRegisterForTag and CMFStylePin take one of these ids. Write an id newer than the CMF you require as its number, behind CMFHasProperty. Ids 18 and 19 replace or add info-box text; id 39 sets the info-box content width (200..1920 logical pixels, 0 withdraws).

Id Function Since Explained on
1 CMFPropertyIcon() 1 Writing your script
2 CMFPropertyLegendIcon() 1 Writing your script
3 CMFPropertyTint() 1 Writing your script
4 CMFPropertyBackground() 1 Writing your script
5 CMFPropertyDisabled() 1 Writing your script
6 CMFPropertyLegendRow() 2 Writing your script, Pins other mods add
7 CMFPropertyLegendLabel() 2 Writing your script
8 CMFPropertyLegendCategory() 2 Writing your script
9 CMFPropertyHidden() 3 Writing your script, Hiding pins
10 CMFPropertyPinScale() 4 Writing your script, Pin size, labels and the info box, Adapter: Botanist
11 CMFPropertyLabelPlace() 4 Pin size, labels and the info box, Writing your script, Adapter: Map Quest Insight
12 CMFPropertyLabelText() 4 Writing your script, Pin size, labels and the info box
13 CMFPropertyLabelHide() 4 Pin size, labels and the info box, Writing your script, Adapter: Map Quest Insight
14 CMFPropertyInfoBoxHeight() 4 Writing your script, Pin size, labels and the info box, Adapter: Map Quest Insight
15 CMFPropertyTabHide() 4 Writing your script, Pin size, labels and the info box, Adapter: Map Quest Insight
16 CMFPropertyPinClick() 6 Pin clicks, Writing your script, Adapter: Map Pin Teleport
17 CMFPropertyLabelColor() 5 The map theme, Adapter: Ink and Iron
18 CMFPropertyInfoTitle() 6 Writing your script
19 CMFPropertyInfoText() 6 Writing your script
20 CMFPropertyPinClickHint() 6 Pin clicks, Writing your script, Adapter: Map Pin Teleport
21 CMFPropertyPinClickButton() 6 Pin clicks, Writing your script, Adapter: Map Pin Teleport
22 CMFPropertySpreadRank() 6 Spreading stacked pins, Writing your script, Adapter: Map Quest Insight
23 CMFPropertyCategoryNoDefault() 6 Writing your script
24 CMFPropertyWorldPainting() 9 Writing your script, World overview pictures
25 CMFPropertyWorldCrest() 9 Writing your script, World overview pictures
26 CMFPropertyButtonPicture() 9 Writing your script
27 CMFPropertyWorldMarker() 9 Writing your script, World overview pictures
28 CMFPropertyHoverName() 6 Names only on hover, Writing your script
29 CMFPropertyIconUndiscovered() 6 Writing your script
30 CMFPropertyIconCompleted() 6 Writing your script
37 CMFPropertyTabHidden() 6 Writing your script
38 CMFPropertyPresent() 11 Writing your script
45 CMFPropertyIconFrames() 14 Writing your script, Animated pictures
46 CMFPropertyIconUnderFrames() 14 Writing your script, Animated pictures
47 CMFPropertyFrameOffset() 14 Writing your script, Animated pictures
48 CMFPropertyPictureFit() 14 Pin size, labels and the info box, Writing your script
50 CMFPropertyPlayerSetting() 6 Writing your script, Player settings and size multipliers
51 CMFPropertyPinScaleFactor() 6 Writing your script, Player settings and size multipliers
52 CMFPropertySelectedScaleFactor() 6 Writing your script
53 CMFPropertyPinScaleStandard() 6 Writing your script, Player settings and size multipliers
31 IconSelected (numeric id; no helper) 13 Property values
32 SelectedScale (numeric id; no helper) 13 Property values
33 PinAlpha (numeric id; no helper) 13 Property values
34 PinOrder (numeric id; no helper) 13 Property values
35 PinOffset (numeric id; no helper) 13 Property values
36 PinZoom (numeric id; no helper) 13 Property values
39 InfoBoxWidth (numeric id; no helper) 13 Property values
40 Withdraw (numeric id; no helper) 13 Property values
41 LegendRowTint (numeric id; no helper) 13 Property values
42 IconUnder (numeric id; no helper) 13 Property values
43 IconUnderTint (numeric id; no helper) 13 Property values
44 PictureScale (numeric id; no helper) 13 Property values
48 PictureFit (numeric id; no helper) 13 Property values

Hooks

Wrap these methods of CMFCore with @wrapMethod(CMFCore) and always call wrappedMethod so other mods' wrappers run too. A click hook acts only when provider is your own folder name and passes every other call on.

Hook Since Explained on
OnPinReady(dataObject : CScriptedFlashObject, mapContext : name) 4 The pin hook: OnPinReady, Porting a map mod, Writing your script
OnMapReady(menuFlash : CScriptedFlashSprite) 4 The pin hook: OnPinReady, Drawing on the map itself, Keeping pins over a grid, refreshing and one-pin updates
OnPinClicked(menu : CR4MapMenu, provider : string, pinTag : name, pinId : int, pinType : string, input : string, value : int) : bool 6 Pin clicks, Drawing on the map itself, Adapter: All Quest Objectives
OnDrawingClicked(menu : CR4MapMenu, provider : string, id : name, input : string, value : int) : bool 6 Map theme parts and keys, Drawing on the map itself, Adapter: Witcher's Path
OnMapListening(menu : CR4MapMenu, keys : string) 6 Drawing on the map itself, Adapter: Witcher's Path
OnMapView(menu : CR4MapMenu, area : name, x : float, y : float, worldX : float, worldY : float, zoom : float, reason : name) 9 The map's view, Adapter: Annoying Map
OnMapOpening(menu : CR4MapMenu, area : name, mapContext : name) 9 The map's view, Writing your script, Adapter: Annoying Map
OnMapTab(menu : CR4MapMenu, category : string) 13 Key hints and filter tab reports
OnMapHints(menu : CR4MapMenu, owner : string) 13 Key hints and filter tab reports, Map theme parts and keys
OnInfoFold(menu : CR4MapMenu, provider : string, open : bool) 13 Shipping your mod, Map theme parts and keys
OnMovieEvent(menu : CR4MapMenu, provider : string, id : string, eventName : string, value : string) : bool 13 Shipping your mod, Your own movie on the screen
OnMapAreaReady(menu : CR4MapMenu, area : name) 13 Your own movie on the screen, Shipping your mod

Map events

CMF's map calls these events on CR4MapMenu. New events are core-owned; wrap their hooks. Legacy events remain adapter-owned and must not be declared twice.

Event Since When Explained on
OnCMFMapTab(category : string) 13 core-owned; forwards to OnMapTab Shipping your mod, Map theme parts and keys, Key hints and filter tab reports
OnCMFMapHints() 13 core-owned; forwards to the selected OnMapHints owner Shipping your mod, Map theme parts and keys, Key hints and filter tab reports
OnCMFMapFilter(category : string) 4 legacy, adapter-owned; do not declare twice Shipping your mod, Key hints and filter tab reports, Adapter: Gwent Players Map
OnCMFMapHintsReady() 4 legacy, adapter-owned; do not declare twice Shipping your mod, Key hints and filter tab reports, Adapter: Ink and Iron

What each API version added

  • 1: CMFGetVersion, CMFHasProperty, CMFPropertyBackground, CMFPropertyDisabled, CMFPropertyIcon, CMFPropertyLegendIcon, CMFPropertyTint, CMFRegister, CMFRegisterBackground, CMFRegisterDisabled, CMFRegisterDisabledForTag, CMFRegisterForTag, CMFRegisterIcon, CMFRegisterIconForTag, CMFRegisterLegendIcon, CMFRegisterTint, CMFReleaseProvider, CMFRequireVersion
  • 2: CMFPropertyLegendCategory, CMFPropertyLegendLabel, CMFPropertyLegendRow, CMFRegisterLegendCategory, CMFRegisterLegendLabel, CMFRegisterLegendRow, CMFStylePin, CMFStylePinIcon, CMFStylePinTint
  • 3: CMFHidePin, CMFPropertyHidden, CMFRegisterHidden, CMFRegisterHiddenForTag
  • 4: CMFLabelHideCrosshair, CMFLabelHidePin, CMFLevelLabel, CMFPropertyInfoBoxHeight, CMFPropertyLabelHide, CMFPropertyLabelPlace, CMFPropertyLabelText, CMFPropertyPinScale, CMFPropertyTabHide, CMFStylePinLabel, CMFStylePinScale, hook OnPinReady, hook OnMapReady
  • 5: CMFDraw, CMFDrawSet, CMFHasAbility, CMFPropertyLabelColor, CMFStylePart
  • 6: CMFDrawSetList, CMFMapRefresh, CMFPropertyCategoryNoDefault, CMFPropertyHoverName, CMFPropertyIconCompleted, CMFPropertyIconUndiscovered, CMFPropertyInfoText, CMFPropertyInfoTitle, CMFPropertyPinClick, CMFPropertyPinClickButton, CMFPropertyPinClickHint, CMFPropertyPinScaleFactor, CMFPropertyPinScaleStandard, CMFPropertyPlayerSetting, CMFPropertySelectedScaleFactor, CMFPropertySpreadRank, CMFPropertyTabHidden, CMFRegisterCategoryNoDefault, hook OnPinClicked, hook OnDrawingClicked, hook OnMapListening
  • 7: no new calls (new keys or abilities only)
  • 8: CMFChoicesChanged, CMFSetProviderName
  • 9: CMFPropertyButtonPicture, CMFPropertyWorldCrest, CMFPropertyWorldMarker, CMFPropertyWorldPainting, CMFRegisterButtonPicture, CMFRegisterChoiceOnly, CMFRegisterWorldCrest, CMFRegisterWorldMarker, CMFRegisterWorldPainting, CMFRegisterWorldPaintingTiles, CMFSetOpeningView, CMFSetOpeningWorld, hook OnMapView, hook OnMapOpening
  • 10: CMFScreenHeight, CMFScreenWidth
  • 11: CMFDeclareProvider, CMFInfoAdd, CMFInfoReplace, CMFLevelPlace, CMFPlaceRadius, CMFPropertyPresent, CMFProviderPresent, CMFRegisterForPlace, CMFSetLogPins
  • 12: no new calls (new keys or abilities only)
  • 13: CMFAddPin, CMFClickInputHold, CMFDeclareTag, CMFRemovePin, CMFStyle, hook OnMapTab, hook OnMapHints, hook OnInfoFold, hook OnMovieEvent, hook OnMapAreaReady
  • 14: CMFDrawSetBits, CMFGridKeepPin, CMFPropertyFrameOffset, CMFPropertyIconFrames, CMFPropertyIconUnderFrames, CMFPropertyPictureFit
  • 15: no new calls (new keys or abilities only)
  • 16: movie facade map.hidePanels, the tracker glow keys
  • 17: CMFMapRefreshPins, CMFHasAbility('screen', 'button'), movie facade map.cmfMakeButton, CMFMapRefreshPins(), CMFHasAbility('map', 'refreshPins'), CMFHasAbility('screen', 'keyDecline'): a focused screen movie's handleInput can return false to decline a key, CMFHasAbility('map', 'partialUpdate'): a full pin update (a quest tracked, a filter changed) that draws the same pins again reuses their clips instead of making new ones; nothing to call
  • 18: CMFAddedPinMods, CMFAddedPinTypes, CMFDeclareAddedPinType, CMFGridUnkeepPin, CMFPropertyGridKeepEpoch
  • 19: no new calls (new keys or abilities only)

Previous: Adapter: Annoying Map · Contents · Next: Pin types for icon packs