Skip to content

Commit

Permalink
Add descriptions to functions in WorldMapSector scripting docs
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
Vankata453 authored Jul 31, 2024
1 parent 0f8af76 commit c8a80f9
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions src/worldmap/worldmap_sector.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -110,46 +110,46 @@ class WorldMapSector final : public Base::Sector

/**
* @scripting
* Returns Tux's X position on the worldmap.
* @description Returns Tux's X position on the worldmap.
*/
float get_tux_x() const;
/**
* @scripting
* Returns Tux's Y position on the worldmap.
* @description Returns Tux's Y position on the worldmap.
*/
float get_tux_y() const;

/**
* @scripting
* Changes the current sector of the worldmap to a specified new sector.
* @description Changes the current sector of the worldmap to a specified new sector.
* @param string $sector
*/
void set_sector(const std::string& sector);
/**
* @scripting
* Changes the current sector of the worldmap to a specified new sector,
moving Tux to the specified spawnpoint.
* @description Changes the current sector of the worldmap to a specified new sector,
moving Tux to the specified spawnpoint.
* @param string $sector
* @param string $spawnpoint
*/
void spawn(const std::string& sector, const std::string& spawnpoint);
/**
* @scripting
* Moves Tux to the specified spawnpoint.
* @description Moves Tux to the specified spawnpoint.
* @param string $spawnpoint
*/
void move_to_spawnpoint(const std::string& spawnpoint);
void move_to_spawnpoint(const std::string& spawnpoint, bool pan);

/**
* @scripting
* Gets the path to the worldmap file. Useful for saving worldmap-specific data.
* @description Gets the path to the worldmap file. Useful for saving worldmap-specific data.
*/
std::string get_filename() const;
/**
* @scripting
* Overrides the "Title Screen Level" property for the world with ""filename"".
The newly set level will be used for the title screen, after exiting the world.
* @description Overrides the "Title Screen Level" property for the world with ""filename"".
The newly set level will be used for the title screen, after exiting the world.
* @param string $filename
*/
void set_title_level(const std::string& filename);
Expand Down

0 comments on commit c8a80f9

Please sign in to comment.