Update for 3.6.2

[ivan-mogilko]

List of things that has to be documented for 3.6.2 update:

For the Editor help:

• - Script module selection for linked events. I suppose that this has to be added to Tutorials with the new screenshots which display the module selection where it is available (e.g. Characters).
• - New naming rule for the voice clips, updated info in "Voice speech" article.
• - In General Settings added "Use old-style voice clip naming rule".
• - "WrapText", "TextPaddingHorizontal", "TextPaddingVertical" properties to GUI Button.
• - Mention "Null Font" in GUI article?
• - Removed obsolete "Copy walkable area mask to regions" command from the Room editor. -- Was this toolbutton mentioned anywhere?
• - Added "/maketemplate" command-line option.

Script API:

• - Length for Dynamic Arrays
  Document Length property for Dynamic Arrays #281
• - Expanded on_mouse_click callback, now supports two more parameters: click x,y coordinates.
  Document on_mouse_click extra parameters #275
• - Expanded dialog_options_mouse_click callback, now it supports click x and y coordinates
  Document dialog_options_mouse_click extra parameters #276

Engine Plugin API:

• - IAGSEngine.Log()

Mention change in behavior (Version compatibility notes?):

• - Assigning InventoryItem.Graphic will no longer reassign CursorGraphic too even if they were identical previously

Config and setup program, engine command line:

• - Added new accessibility config settings in "access" section: "speechskip" and "textskip".
  These let player to override game's skipping style for character speech and text messages
  respectively.
• - Added "max_save" config option in "override" section: this lets to enforce an arbitrary number
  of saves displayed in a standard save/restore dialogs in game.
• - Added "--no-plugins" command-line argument that denies loading any plugins;
  also added respective config option "noplugins" in "override" section.

DONE:

Mention change in behavior (Version compatibility notes?):

• - Calling DeleteSaveSlot() on a slot within 0-50 range will no longer secretly move a save with the topmost number (within the same range) to fill the emptied slot.
  Document Copy/MoveSaveSlot(), new DeleteSaveSlot() behavior #268

Script API:

• - on_event: eEventDialogStart/Stop, eEventDialogRun, eEventDialogOptionsOpen/Close
  Document added global events #256
• - File.Copy() and File.Rename().
  Document new File functions (Copy, Rename, GetFileTime, Read/WriteRawFloat, Read/WriteBytes) #262
• - File.GetFileTime() , returns modification time.
  Document new File functions (Copy, Rename, GetFileTime, Read/WriteRawFloat, Read/WriteBytes) #262
• - System.GetEngineInteger() and System.GetEngineString()
  Document added System entries (GetEngineInteger and GetEngineString) #260
• - option OPT_SAVEGAMESCREENSHOTLAYER sets render layers in game save screenshot
  Document OPT_SAVEGAMESCREENSHOTLAYER in Globalfunctions_General #261
• - Added CopySaveSlot() and MoveSaveSlot()
  Document Copy/MoveSaveSlot(), new DeleteSaveSlot() behavior #268
• - "layers" parameter to DynamicSprite.CreateFromScreenShot(),
  Document DynamicSprite CreateFromScreenShot render layer parameters #258
• - Added Game.GetSaveSlotTime() that returns a time this save slot was last written.
  Document Game.GetSaveSlotTime added #271
• - ListBox FillSaveGameList and FillSaveGameList update
  Document ListBox updated APIs #266
• - FileSortStyle, SaveGameSortStyle and SortDirection enum
  add new enums: RenderLayer, EngineValueID, eNullFont, FileSortStyle and SortDirection  #259
• - EngineValueID enum.
  add new enums: RenderLayer, EngineValueID, eNullFont, FileSortStyle and SortDirection  #259
• - RenderLayer enum
  add new enums: RenderLayer, EngineValueID, eNullFont, FileSortStyle and SortDirection  #259
• - eNullFont
  add new enums: RenderLayer, EngineValueID, eNullFont, FileSortStyle and SortDirection  #259
• - System.DisplayFPS
  Document System.DisplayFPS #279
• - Added GetTimerPos() that returns timer's position (remaining time), in ticks.
  Document GetTimerPos in Globalfunctions_General #269
• - Character.Following
  Document Character.Following  #280
• - Button.WrapText, TextPaddingHorizontal, TextPaddingVertical.
  Document Button WrapText, TextPaddingHorizontal and TextPaddingVertical #263
• - Label.TextAlignment has now type Alignment, rather than HorizontalAlignment
  Adjust Label.TextAlignement type and compatibility note #273
• - Added optional "sprite" parameter to SaveGameSlot(), that lets to pass a number of an arbitrary sprite to write into this save instead of a standard "screenshot".
  Document SaveGameSlot option "sprite" parameter #274
• - Added DateTime.CreateFromDate() and CreateFromRawTime().
  Document DateTime.CreateFromDate/RawTime #272
• - Character.TurnWhenFacing property.
  Document character TurnWhenFacing and other API changes #257
• - Character.MoveStraight() complementing WalkStraight().
  Document character TurnWhenFacing and other API changes #257
• - static Dialog.CurrentDialog and non-static ExecutedOption and AreOptionsDisplayed properties
  Document new Dialog CurrentDialog, ExecutedOption and AreOptionsDisplayed #264
• - RestoreGameDialog() and SaveGameDialog()
  Document Restore/SaveGameDialog in Globalfunctions_General #267
• - Added Overlay.SetPosition() and SetSize()
  Document Overlay.SetPosition() and SetSize() api added #270
• - Speech.SpeakingCharacter
  Document Speech.SpeakingCharacter #265
• - Character.Speaking returns true when a speech is playing even if the character has no speech view
  Document character TurnWhenFacing and other API changes #257

[ericoporto]

Created an individual issue for a bunch of things - not all yet. I will be looking into this soon, probably during the weekend.

Going through the script API specifically, it's mostly lots things that are quite useful in the day-to-day agsing, helpful things that makes life easier with the already existing systems in ags.

[ericoporto]

I added a bunch of things more to the manual. Need to recheck if something is missing in the above list and also create any missing issues.

I believe a Upgrading to 3.6.2 page would be useful too to pick the highlights of this version to add too.

[ivan-mogilko]

Wrote an initial variant of "Upgrade to 3.6.2": https://github.com/adventuregamestudio/ags-manual/wiki/UpgradeTo362
explained loading old saves in summary, since that's the most complicated thing in this update.

[ericoporto]

That is a great writing! I thought about a few things that would be just small notes. Not super sure on those, but just thought they will end up being mentioned in sections that people visit less often.

• the new voice clip naming rules
• the event handlers being supported in any script module
• editor warning about probably "unlinked" functions and warning about handlers that are "linked" in editor but not available in script (perhaps in the same section as above?)
• maybe also the Length property in Dynamic Arrays?

[ivan-mogilko]

Added few things for now; but i think that we need to add links to particular articles when these are ready (like "validate_restored_save" and "Game.ScanSaveSlots").

[ivan-mogilko]

Added a number of things recently that were not in original list:

• System.GetEngineInteger and GetEngineString
• File.GetFiles
• Game.GetSaveSlots
• Game.ScanSaveSlots
• validate_restored_save, in a whole new page here: https://github.com/adventuregamestudio/ags-manual/wiki/ValidateRestoredSave

added new enums:

• RestoredSaveResult
• SaveComponentSelection

[ericoporto]

Thanks, I did a quick check of those and fixed links and a few small format things and put in a release, to also update the web manual.

[ivan-mogilko]

Added a page for RestoredSaveInfo:
https://github.com/adventuregamestudio/ags-manual/wiki/RestoredSaveInfo

While writing it, i realized that it may make sense to also add "ModuleNames[]" to it, if someone wants to check which of these are present in case of smaller number (since modules are allowed to be loaded in any order now).