AGS 4: Script API: convert Walk-areas and Walkbehinds API to OO-style

[ivan-mogilko]

Converting walkable areas and walk-behinds script api to OO-style, in compliance with existing Hotspot, Regions etc api.

This adds two managed structs, and array properties in the Room struct for getting these.

builtin managed struct WalkableArea {
  /// Gets the walkable area at the specified position on the screen.
  import static WalkableArea* GetAtScreenXY(int x, int y);
  /// Returns the walkable area at the specified position within this room.
  import static WalkableArea* GetAtRoomXY(int x, int y);
  /// Gets the drawing surface for the 8-bit walkable mask
  import static DrawingSurface* GetDrawingSurface();
  /// Changes this walkable area's scaling level.
  import void SetScaling(int min, int max);
  /// Gets the ID number for this area.
  import readonly attribute int ID;
  /// Gets/sets whether this walkable area is enabled.
  import attribute bool Enabled;
  /// Gets/sets this walkable area's minimal scaling level.
  import readonly attribute int ScalingMin;
  /// Gets/sets this walkable area's maximal scaling level.
  import readonly attribute int ScalingMax;
};

builtin managed struct Walkbehind {
  /// Gets the walk-behind at the specified position on the screen.
  import static WalkableArea* GetAtScreenXY(int x, int y);
  /// Returns the walk-behind at the specified position within this room.
  import static WalkableArea* GetAtRoomXY(int x, int y);
  /// Gets the drawing surface for the 8-bit walk-behind mask
  import static DrawingSurface* GetDrawingSurface();
  /// Gets the ID number for this walk-behind.
  import readonly attribute int ID;
  /// Gets/sets this walk-behind's baseline.
  import attribute int Baseline;
};

Added 2 global arrays of pointers to match existing ones, since they are still in use:

import readonly WalkableArea *walkarea[AGS_MAX_WALKABLE_AREAS];
import readonly Walkbehind *walkbehind[AGS_MAX_WALKBEHINDS];

But also added Room properties that return room's elements, as a suggestion for future use:

  /// Accesses the Hotspots in the current room.
  import static readonly attribute Hotspot *Hotspots[];
  /// Accesses the Objects in the current room.
  import static readonly attribute Object *Objects[];
  /// Accesses the Regions in the current room.
  import static readonly attribute Region *Regions[];
  /// Accesses the Walkable areas in the current room.
  import static readonly attribute WalkableArea *WalkableAreas[];
  /// Accesses the Walk-behinds in the current room.
  import static readonly attribute Walkbehind *Walkbehinds[];

[ericoporto]

Hey, the build failures are because the new files need to be added to Engine/CMakeLists.txt.

array properties in the Room struct for getting these

Not sure if I am missing this somewhere, but the Room struct in the Script API could also have an ObjectsCount property - perhaps the same to others, or not if they are a fixed number.

[ivan-mogilko]

Not sure if I am missing this somewhere, but the Room struct in the Script API could also have an ObjectsCount property

There's is one already.

[ivan-mogilko]

I added two global pointer arrays in addition to existing ones, since these are still in use:

import readonly WalkableArea *walkarea[AGS_MAX_WALKABLE_AREAS];
import readonly Walkbehind *walkbehind[AGS_MAX_WALKBEHINDS];

But also room properties for getting everything, as an alternative:

  /// Accesses the Hotspots in the current room.
  import static readonly attribute Hotspot *Hotspots[];
  /// Accesses the Objects in the current room.
  import static readonly attribute Object *Objects[];
  /// Accesses the Regions in the current room.
  import static readonly attribute Region *Regions[];
  /// Accesses the Walkable areas in the current room.
  import static readonly attribute WalkableArea *WalkableAreas[];
  /// Accesses the Walk-behinds in the current room.
  import static readonly attribute Walkbehind *Walkbehinds[];

[ericoporto]

Gets/sets in the comment should just be Gets for ScalingMin and ScalingMax

[ericoporto]

Should this be WalkableArea ?

[ericoporto]

This should be a Walkbehind pointer - and the next one too.