forked from teamnwah/openmw-tes3coop
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
348 lines
12 KiB
C
348 lines
12 KiB
C
#ifndef OPENMW_WORLDSTATEAPI_HPP
|
|
#define OPENMW_WORLDSTATEAPI_HPP
|
|
|
|
#ifdef _HOST
|
|
#include <components/openmw-mp/Base/BaseWorldstate.hpp>
|
|
#endif
|
|
#include "../api.h"
|
|
|
|
NAMESPACE_BEGIN(WorldstateFunctions)
|
|
#ifdef _HOST
|
|
API_FUNCTION mwmp::BaseWorldstate CDECL *readWorldstate;
|
|
API_FUNCTION mwmp::BaseWorldstate CDECL writeWorldstate;
|
|
#endif
|
|
/**
|
|
* \brief Use the last worldstate received by the server as the one being read.
|
|
*
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL ReadReceivedWorldstate() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Take the contents of the read-only worldstate last received by the
|
|
* server from a player and move its contents to the stored worldstate
|
|
* that can be sent by the server.
|
|
*
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL CopyReceivedWorldstateToStore() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Clear the map changes for the write-only worldstate.
|
|
*
|
|
* This is used to initialize the sending of new WorldMap packets.
|
|
*
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL ClearMapChanges() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Get the number of indexes in the read worldstate's map changes.
|
|
*
|
|
* \return The number of indexes.
|
|
*/
|
|
API_FUNCTION unsigned int CDECL GetMapChangesSize() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Get the weather region in the read worldstate.
|
|
*
|
|
* \return The weather region.
|
|
*/
|
|
API_FUNCTION const char *CDECL GetWeatherRegion() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Get the current weather in the read worldstate.
|
|
*
|
|
* \return The current weather.
|
|
*/
|
|
API_FUNCTION int CDECL GetWeatherCurrent() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Get the next weather in the read worldstate.
|
|
*
|
|
* \return The next weather.
|
|
*/
|
|
API_FUNCTION int CDECL GetWeatherNext() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Get the queued weather in the read worldstate.
|
|
*
|
|
* \return The queued weather.
|
|
*/
|
|
API_FUNCTION int CDECL GetWeatherQueued() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Get the transition factor of the weather in the read worldstate.
|
|
*
|
|
* \return The transition factor of the weather.
|
|
*/
|
|
API_FUNCTION double CDECL GetWeatherTransitionFactor() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Get the X coordinate of the cell corresponding to the map tile at a certain index in
|
|
* the read worldstate's map tiles.
|
|
*
|
|
* \param index The index of the map tile.
|
|
* \return The X coordinate of the cell.
|
|
*/
|
|
API_FUNCTION int CDECL GetMapTileCellX(unsigned int index) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Get the Y coordinate of the cell corresponding to the map tile at a certain index in
|
|
* the read worldstate's map tiles.
|
|
*
|
|
* \param index The index of the map tile.
|
|
* \return The Y coordinate of the cell.
|
|
*/
|
|
API_FUNCTION int CDECL GetMapTileCellY(unsigned int index) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the region affected by the next WorldRegionAuthority packet sent.
|
|
*
|
|
* \param region The region.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetAuthorityRegion(const char* authorityRegion) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the weather region in the write-only worldstate stored on the server.
|
|
*
|
|
* \param region The region.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetWeatherRegion(const char* region) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the weather forcing state in the write-only worldstate stored on the server.
|
|
*
|
|
* Players who receive a packet with forced weather will switch to that weather immediately.
|
|
*
|
|
* \param forceState The weather forcing state.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetWeatherForceState(bool forceState) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the current weather in the write-only worldstate stored on the server.
|
|
*
|
|
* \param currentWeather The current weather.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetWeatherCurrent(int currentWeather) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the next weather in the write-only worldstate stored on the server.
|
|
*
|
|
* \param nextWeather The next weather.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetWeatherNext(int nextWeather) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the queued weather in the write-only worldstate stored on the server.
|
|
*
|
|
* \param queuedWeather The queued weather.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetWeatherQueued(int queuedWeather) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the transition factor for the weather in the write-only worldstate stored on the server.
|
|
*
|
|
* \param transitionFactor The transition factor.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetWeatherTransitionFactor(double transitionFactor) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the world's hour in the write-only worldstate stored on the server.
|
|
*
|
|
* \param hour The hour.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetHour(double hour) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the world's day in the write-only worldstate stored on the server.
|
|
*
|
|
* \param day The day.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetDay(int day) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the world's month in the write-only worldstate stored on the server.
|
|
*
|
|
* \param month The month.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetMonth(int month) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the world's year in the write-only worldstate stored on the server.
|
|
*
|
|
* \param year The year.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetYear(int year) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the world's days passed in the write-only worldstate stored on the server.
|
|
*
|
|
* \param daysPassed The days passed.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetDaysPassed(int daysPassed) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the world's time scale in the write-only worldstate stored on the server.
|
|
*
|
|
* \param pid The player ID.
|
|
* \param timeScale The time scale.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetTimeScale(double timeScale) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the collision state for other players in the write-only worldstate stored
|
|
* on the server.
|
|
*
|
|
* \param state The collision state.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetPlayerCollisionState(bool state) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the collision state for actors in the write-only worldstate stored on the
|
|
* server.
|
|
*
|
|
* \param state The collision state.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetActorCollisionState(bool state) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Set the collision state for placed objects in the write-only worldstate stored
|
|
* on the server.
|
|
*
|
|
* \param state The collision state.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SetPlacedObjectCollisionState(bool state) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Whether placed objects with collision turned on should use actor collision, i.e.
|
|
* whether they should be slippery and prevent players from standing on them.
|
|
*
|
|
* \param useActorCollision Whether to use actor collision.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL UseActorCollisionForPlacedObjects(bool useActorCollision) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Add a refId to the list of refIds for which collision should be enforced
|
|
* irrespective of other settings.
|
|
*
|
|
* \param refId The refId.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL AddEnforcedCollisionRefId(const char* refId) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Clear the list of refIdsd for which collision should be enforced irrespective
|
|
* of other settings.
|
|
*
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL ClearEnforcedCollisionRefIds() NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Save the .png image data of the map tile at a certain index in the read worldstate's
|
|
* map changes.
|
|
*
|
|
* \param index The index of the map tile.
|
|
* \param filePath The file path of the resulting file.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SaveMapTileImageFile(unsigned int index, const char *filePath) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Load a .png file as the image data for a map tile and add it to the write-only worldstate
|
|
* stored on the server.
|
|
*
|
|
* \param cellX The X coordinate of the cell corresponding to the map tile.
|
|
* \param cellY The Y coordinate of the cell corresponding to the map tile.
|
|
* \param filePath The file path of the loaded file.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL LoadMapTileImageFile(int cellX, int cellY, const char* filePath) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Send a WorldRegionAuthority packet establishing a certain player as the only one who
|
|
* should process certain region-specific events (such as weather changes).
|
|
*
|
|
* It is always sent to all players.
|
|
*
|
|
* \param pid The player ID attached to the packet.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SendWorldRegionAuthority(PlayerId pid) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Send a WorldMap packet with the current set of map changes in the write-only
|
|
* worldstate.
|
|
*
|
|
* \param pid The player ID attached to the packet.
|
|
* \param broadcast Whether this packet should be sent only to the attached player
|
|
* or to all players on the server.
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SendWorldMap(PlayerId pid, bool sendToOtherPlayers, bool skipAttachedPlayer) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Send a WorldTime packet with the current time and time scale in the write-only
|
|
* worldstate.
|
|
*
|
|
* \param pid The player ID attached to the packet.
|
|
* \param sendToOtherPlayers Whether this packet should be sent to players other than the
|
|
* player attached to the packet (false by default).
|
|
* \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
|
|
* to the packet (false by default).
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SendWorldTime(PlayerId pid, bool sendToOtherPlayers, bool skipAttachedPlayer) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Send a WorldWeather packet with the current weather in the write-only worldstate.
|
|
*
|
|
* \param pid The player ID attached to the packet.
|
|
* \param sendToOtherPlayers Whether this packet should be sent to players other than the
|
|
* player attached to the packet (false by default).
|
|
* \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
|
|
* to the packet (false by default).
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SendWorldWeather(PlayerId pid, bool sendToOtherPlayers, bool skipAttachedPlayer) NOEXCEPT;
|
|
|
|
/**
|
|
* \brief Send a WorldCollisionOverride packet with the current collision overrides in
|
|
* the write-only worldstate.
|
|
*
|
|
* \param pid The player ID attached to the packet.
|
|
* \param sendToOtherPlayers Whether this packet should be sent to players other than the
|
|
* player attached to the packet (false by default).
|
|
* \param skipAttachedPlayer Whether the packet should skip being sent to the player attached
|
|
* to the packet (false by default).
|
|
* \return void
|
|
*/
|
|
API_FUNCTION void CDECL SendWorldCollisionOverride(PlayerId pid, bool sendToOtherPlayers, bool skipAttachedPlayer) NOEXCEPT;
|
|
|
|
|
|
// All methods below are deprecated versions of methods from above
|
|
|
|
API_FUNCTION void CDECL ReadLastWorldstate() NOEXCEPT;
|
|
API_FUNCTION void CDECL CopyLastWorldstateToStore() NOEXCEPT;
|
|
NAMESPACE_END()
|
|
|
|
#endif //OPENMW_WORLDSTATEAPI_HPP
|