Merge branch 'dev'
This commit is contained in:
@@ -1,81 +0,0 @@
|
||||
import sqg2o
|
||||
|
||||
def sendMessageToAll(r : int, g : int, b : int, text : str):
|
||||
"""
|
||||
This function will send a chat message to every connected player.
|
||||
Sending a message triggers client side event [onPlayerMessage](../../defaultEvents/player/onPlayerMessage.md) with playerid set as `-1`.
|
||||
Original: [sendMessageToAll](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/chat/sendMessageToAll/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def sendMessageToAll(r : int, g : int, b : int, text : str)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
* `int` **r**: the red color component in RGB model.
|
||||
* `int` **g**: the green color component in RGB model.
|
||||
* `int` **b**: the blue color component in RGB model.
|
||||
* `str` **text**: that will be send.
|
||||
"""
|
||||
return sqg2o.sendMessageToAll(r, g, b, text)
|
||||
|
||||
def sendMessageToPlayer(playerid : int, r : int, g : int, b : int, text : str):
|
||||
"""
|
||||
This function will send a chat message to specific player.
|
||||
Sending a message triggers client side event [onPlayerMessage](../../defaultEvents/player/onPlayerMessage.md) with playerid set as `-1`.
|
||||
Original: [sendMessageToPlayer](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/chat/sendMessageToPlayer/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def sendMessageToPlayer(playerid : int, r : int, g : int, b : int, text : str)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
* `int` **playerid**: the id of the player which will receive a message.
|
||||
* `int` **r**: the red color component in RGB model.
|
||||
* `int` **g**: the green color component in RGB model.
|
||||
* `int` **b**: the blue color component in RGB model.
|
||||
* `str` **text**: that will be send.
|
||||
"""
|
||||
return sqg2o.sendMessageToPlayer(playerid, r, g, b, text)
|
||||
|
||||
def sendPlayerMessageToAll(senderid : int, r : int, g : int, b : int, text : str):
|
||||
"""
|
||||
This function will send a chat message from one player to every player. Sending a message
|
||||
Sending a message triggers client side event [onPlayerMessage](../../defaultEvents/player/onPlayerMessage.md) with playerid set as **senderid**.
|
||||
Original: [sendPlayerMessageToAll](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/chat/sendPlayerMessageToAll/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def sendPlayerMessageToAll(senderid : int, r : int, g : int, b : int, text : str)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
* `int` **senderid**: the id of the player which will send a message.
|
||||
* `int` **r**: the red color component in RGB model.
|
||||
* `int` **g**: the green color component in RGB model.
|
||||
* `int` **b**: the blue color component in RGB model.
|
||||
* `str` **text**: that will be send.
|
||||
"""
|
||||
return sqg2o.sendPlayerMessageToAll(senderid, r, g, b, text)
|
||||
|
||||
def sendPlayerMessageToPlayer(senderid : int, receiverid : int, r : int, g : int, b : int, text : str):
|
||||
"""
|
||||
This function will send a chat message from one player to another player.
|
||||
Sending a message triggers client side event [onPlayerMessage](../../defaultEvents/player/onPlayerMessage.md) with playerid set as **senderid**.
|
||||
Original: [sendPlayerMessageToPlayer](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/chat/sendPlayerMessageToPlayer/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
sendPlayerMessageToPlayer(senderid : int, receiverid : int, r : int, g : int, b : int, text : str)
|
||||
```
|
||||
|
||||
## Parameters
|
||||
* `int` **senderid**: the id of the player which will send a message.
|
||||
* `int` **receiverid**: the id of the player which will receive a message.
|
||||
* `int` **r**: the red color component in RGB model.
|
||||
* `int` **g**: the green color component in RGB model.
|
||||
* `int` **b**: the blue color component in RGB model.
|
||||
* `str` **text**: that will be send.
|
||||
"""
|
||||
return sqg2o.sendPlayerMessageToAll(senderid, receiverid, r, g, b, text)
|
||||
@@ -1,239 +0,0 @@
|
||||
import sqg2o
|
||||
from g2o.exception import handle_exception
|
||||
|
||||
def getHostname() -> str:
|
||||
"""
|
||||
This function will get the hostname of the server.
|
||||
Original: [getHostname](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/game/getHostname/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getHostname() -> str
|
||||
```
|
||||
## Returns
|
||||
`str`: Server hostname.
|
||||
|
||||
## Usage
|
||||
```python
|
||||
import g2o
|
||||
|
||||
@g2o.event('onInit')
|
||||
def evtInit(**kwargs):
|
||||
print('Server hostname:', g2o.getHostname())
|
||||
```
|
||||
"""
|
||||
return sqg2o.getHostname()
|
||||
|
||||
def getMaxSlots() -> int:
|
||||
"""
|
||||
This function will get the max number of slots available on the server.
|
||||
Original: [getMaxSlots](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/game/getMaxSlots/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getMaxSlots() -> int
|
||||
```
|
||||
## Returns
|
||||
`int`: Max slots number on the server.
|
||||
|
||||
## Usage
|
||||
```python
|
||||
import g2o
|
||||
|
||||
@g2o.event('onInit')
|
||||
def evtInit(**kwargs):
|
||||
print('Server max slots:', g2o.getMaxSlots())
|
||||
```
|
||||
"""
|
||||
return sqg2o.getMaxSlots()
|
||||
|
||||
def getPlayersCount() -> int:
|
||||
"""
|
||||
This function will get the max number of slots available on the server.
|
||||
Original: [getPlayersCount](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/game/getPlayersCount/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getPlayersCount() -> int
|
||||
```
|
||||
## Returns
|
||||
`int`: Number of players on the server.
|
||||
|
||||
## Usage
|
||||
```python
|
||||
import g2o
|
||||
|
||||
@g2o.event('onInit')
|
||||
def evtInit(**kwargs):
|
||||
print('Players online:', g2o.getPlayersCount())
|
||||
```
|
||||
"""
|
||||
return sqg2o.getPlayersCount()
|
||||
|
||||
def exit(exitCode : int = 0):
|
||||
"""
|
||||
This function will close the server with specified exit code.
|
||||
Original: [exit](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/exit/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def exit(exitCode : int = 0)
|
||||
```
|
||||
## Parameters
|
||||
* `int` **exitCode**: exit status for g2o server.
|
||||
"""
|
||||
return sqg2o.exit(exitCode)
|
||||
|
||||
def getDayLength() -> float:
|
||||
"""
|
||||
The function is used to get the day length in miliseconds.
|
||||
Original: [getDayLength](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/getDayLength/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getDayLength() -> float
|
||||
```
|
||||
## Returns
|
||||
`float`: the current day length in miliseconds.
|
||||
"""
|
||||
return sqg2o.getDayLength()
|
||||
|
||||
def getServerDescription() -> str:
|
||||
"""
|
||||
This function will get the description of the server.
|
||||
Original: [getServerDescription](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/getServerDescription/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getServerDescription() -> str
|
||||
```
|
||||
## Returns
|
||||
`str`: Server description.
|
||||
"""
|
||||
return sqg2o.getServerDescription()
|
||||
|
||||
def getServerWorld() -> str:
|
||||
"""
|
||||
The function is used to get the path of the default world on the server.
|
||||
Original: [getServerWorld](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/getServerWorld/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getServerWorld() -> str
|
||||
```
|
||||
## Returns
|
||||
`str`: The world path name.
|
||||
"""
|
||||
return sqg2o.getServerWorld()
|
||||
|
||||
def getTime() -> dict:
|
||||
"""
|
||||
The function is used to get the path of the default world on the server.
|
||||
Original: [getTime](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/getTime/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getTime() -> dict
|
||||
```
|
||||
## Returns
|
||||
`dict {day, hour, min}`: The current time in the game.
|
||||
"""
|
||||
return sqg2o.getTime()
|
||||
|
||||
def serverLog(text : str):
|
||||
"""
|
||||
This function will log the text into server.log file.
|
||||
Original: [serverLog](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/serverLog/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def serverLog(text : str)
|
||||
```
|
||||
## Parameters
|
||||
`str` **text**: the text message that you want to append to server.log file.
|
||||
"""
|
||||
return sqg2o.serverLog(text)
|
||||
|
||||
def setDayLength(miliseconds : float):
|
||||
"""
|
||||
!!! note
|
||||
Day length can't be smaller than 10 000 miliseconds.
|
||||
|
||||
This function will set the day length in miliseconds.
|
||||
Original: [setDayLength](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/setDayLength/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def setDayLength(miliseconds : float)
|
||||
```
|
||||
## Parameters
|
||||
`float` **miliseconds**: day length in miliseconds.
|
||||
"""
|
||||
return sqg2o.setDayLength(miliseconds)
|
||||
|
||||
def setServerDescription(description : str):
|
||||
"""
|
||||
This function will set the description of the server.
|
||||
Original: [setServerDescription](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/setServerDescription/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def setServerDescription(description : str)
|
||||
```
|
||||
## Parameters
|
||||
`str` **description**: the server description.
|
||||
## Returns
|
||||
`bool`: `true` if server description was set successfully, otherwise `false`.
|
||||
"""
|
||||
return sqg2o.setServerDescription(description)
|
||||
|
||||
def setServerWorld(world : str):
|
||||
"""
|
||||
!!! note
|
||||
The server world limit is set to 32 characters.
|
||||
|
||||
!!! note
|
||||
If the target world path is written with backslashes instead of normal slashes, you need to escape it with another backslashes e.g. "NEWWORLD\\NEWWORLD.ZEN".
|
||||
|
||||
This function will change the default world to which players will enter after joining.
|
||||
Original: [setServerWorld](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/setServerWorld/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def setServerWorld(world : str)
|
||||
```
|
||||
## Parameters
|
||||
`str` **world**: the path to the target world.
|
||||
"""
|
||||
return sqg2o.setServerWorld(world)
|
||||
|
||||
@handle_exception
|
||||
def setTime(hour : int = None, mins : int = None, day : int = None):
|
||||
"""
|
||||
!!! note
|
||||
This functions supports ``pass_exception: bool`` optional argument for manual handling exceptions.
|
||||
This function will set the current time in the game to the given time, for all the players.
|
||||
Original: [setTime](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/game/setTime/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def setTime(hour : int = None, mins : int = None, day : int = None)
|
||||
```
|
||||
## Parameters
|
||||
`int` **hour**: the hour of new time (in the range between 0-23) or subtract value from hour (hour < 0).
|
||||
`int` **mins**: the minute of new time (in the range between 0-59) or subtract value from mins (mins < 0).
|
||||
`int` **day**: the day of new time or subtract value from day (day < 0).
|
||||
"""
|
||||
current_time = getTime()
|
||||
|
||||
# Check for provided arguments
|
||||
hour = current_time['hour'] if hour is None else hour
|
||||
mins = current_time['min'] if mins is None else mins
|
||||
day = current_time['day'] if day is None else day
|
||||
|
||||
# Check for negative arguments
|
||||
hour = current_time['hour'] + hour if hour < 0 else hour
|
||||
mins = current_time['min'] + mins if mins < 0 else mins
|
||||
day = current_time['day'] + day if day < 0 else day
|
||||
|
||||
return sqg2o.setTime(hour, mins, day)
|
||||
@@ -1,114 +0,0 @@
|
||||
import sqg2o
|
||||
from g2o.exception import handle_exception
|
||||
|
||||
@handle_exception
|
||||
def getDistance2d(
|
||||
x1: float = 0,
|
||||
y1: float = 0,
|
||||
x2: float = 0,
|
||||
y2 : float = 0,
|
||||
first: dict[str, float] = None,
|
||||
second: dict[str, float] = None
|
||||
) -> float:
|
||||
"""
|
||||
!!! note
|
||||
This functions supports ``pass_exception: bool`` optional argument for manual handling exceptions.
|
||||
This function will get the 2d distance between two points.
|
||||
Original: [getDistance2d](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/math/getDistance2d/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getDistance2d(x1 : float, y1: float, x2 : float, y2 : float) -> float
|
||||
```
|
||||
|
||||
## Parameters
|
||||
* `float` **x1**: the position on X axis of the first point.
|
||||
* `float` **y1**: the position on Y axis of the first point.
|
||||
* `float` **x2**: the position on X axis of the second point.
|
||||
* `float` **y2**: the position on Y axis of the second point.
|
||||
**OR**
|
||||
* `dict[str, float]` **first**: the poistion on XY axis of the first point.
|
||||
* `dict[str, float]` **second**: the position of XY axis of the second point.
|
||||
## Returns
|
||||
`float`: Returns the calculated 2d distance between two points as floating point number.
|
||||
"""
|
||||
if first is not None and second is not None:
|
||||
return sqg2o.getDistance2d(first['x'], first['y'], second['x'], second['y'])
|
||||
else:
|
||||
return sqg2o.getDistance2d(x1, y1, x2, y2)
|
||||
|
||||
@handle_exception
|
||||
def getDistance3d(
|
||||
x1 : float = 0,
|
||||
y1: float = 0,
|
||||
z1 : float = 0,
|
||||
x2 : float = 0,
|
||||
y2 : float = 0,
|
||||
z2 : float = 0,
|
||||
first: dict[str, float] = None,
|
||||
second: dict[str, float] = None
|
||||
) -> float:
|
||||
"""
|
||||
!!! note
|
||||
This functions supports ``pass_exception: bool`` optional argument for manual handling exceptions.
|
||||
This function will get the 3d distance between two points.
|
||||
Original: [getDistance3d](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/math/getDistance3d/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getDistance3d(x1 : float, y1: float, z1 : float, x2 : float, y2 : float, z2 : float) -> float
|
||||
```
|
||||
|
||||
## Parameters
|
||||
* `float` **x1**: the position on X axis of the first point.
|
||||
* `float` **y1**: the position on Y axis of the first point.
|
||||
* `float` **z1**: the position on Z axis of the first point.
|
||||
* `float` **x2**: the position on X axis of the second point.
|
||||
* `float` **y2**: the position on Y axis of the second point.
|
||||
* `float` **z2**: the position on Z axis of the second point.
|
||||
**OR**
|
||||
* `dict[str, float]` **first**: the position on XYZ axis of the first point.
|
||||
* `dict[str, float]` **second**: the position on XYZ axic of the second point.
|
||||
## Returns
|
||||
`float`: Returns the calculated 3d distance between two points as floating point number.
|
||||
"""
|
||||
if first is not None and second is not None:
|
||||
return sqg2o.getDistance3d(first['x'], first['y'], first['z'], second['x'], second['y'], second['z'])
|
||||
else:
|
||||
return sqg2o.getDistance3d(x1, y1, z1, x2, y2, z2)
|
||||
|
||||
@handle_exception
|
||||
def getVectorAngle(
|
||||
x1: float = 0,
|
||||
y1: float = 0,
|
||||
x2: float = 0,
|
||||
y2 : float = 0,
|
||||
first: dict[str, float] = None,
|
||||
second: dict[str, float] = None
|
||||
) -> float:
|
||||
"""
|
||||
!!! note
|
||||
This functions supports ``pass_exception: bool`` optional argument for manual handling exceptions.
|
||||
This function will get angle on Y axis directed towards the second point.
|
||||
Original: [getVectorAngle](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/math/getVectorAngle/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getVectorAngle(x1 : float, y1: float, x2 : float, y2 : float) -> float
|
||||
```
|
||||
|
||||
## Parameters
|
||||
* `float` **x1**: the position on X axis of the first point.
|
||||
* `float` **y1**: the position on Y axis of the first point.
|
||||
* `float` **x2**: the position on X axis of the second point.
|
||||
* `float` **y2**: the position on Y axis of the second point.
|
||||
**OR**
|
||||
* `dict[str, float]` **first**: the poistion on XY axis of the first point.
|
||||
* `dict[str, float]` **second**: the position of XY axis of the second point.
|
||||
## Returns
|
||||
`float`: Returns the angle on Y axis directed towards the second point.
|
||||
"""
|
||||
if first is not None and second is not None:
|
||||
return sqg2o.getVectorAngle(first['x'], first['y'], second['x'], second['y'])
|
||||
else:
|
||||
return sqg2o.getVectorAngle(x1, y1, x2, y2)
|
||||
@@ -1,247 +0,0 @@
|
||||
import sqg2o
|
||||
|
||||
def clearNpcActions(npc_id : int):
|
||||
"""
|
||||
This function clears remote NPC actions queue. Remote NPCs uses actions queue to execute thier tasks.
|
||||
Original: [clearNpcActions](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/clearNpcActions/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
clearNpcActions(npc_id : int)
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the npc identifier.
|
||||
"""
|
||||
return sqg2o.clearNpcActions(npc_id)
|
||||
|
||||
def createNpc(name : str, instance : str = 'PC_HERO') -> int:
|
||||
"""
|
||||
!!! note
|
||||
By default npcs won't be added to world. In order to do that, you have to call [spawnPlayer](../player/spawnPlayer.md).
|
||||
!!! note
|
||||
Remote NPC id will always begins from max slots value.
|
||||
This function creates remote NPC.
|
||||
Original: [createNpc](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/createNpc/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def createNpc(name : str, instance : str = 'PC_HERO') -> int
|
||||
```
|
||||
## Parameters
|
||||
`str` **name**: the displayed name of the npc.
|
||||
`str` **instance**: the instance name of for the npc.
|
||||
"""
|
||||
return sqg2o.createNpc(name, instance)
|
||||
|
||||
def destroyNpc(npc_id : int) -> bool:
|
||||
"""
|
||||
This function destroys remote NPC.
|
||||
Original: [destroyNpc](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/destroyNpc/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def destroyNpc(npc_id : int) -> bool
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the identifier of npc.
|
||||
## Returns
|
||||
`bool`: `true` when npc was successfully destroyed, otherwise false`.
|
||||
"""
|
||||
return sqg2o.destroyNpc(npc_id)
|
||||
|
||||
def getNpcAction(npc_id : int, index : int) -> dict:
|
||||
"""
|
||||
This function gets information about element on specified index in NPC action queue.
|
||||
Original: [getNpcAction](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/getNpcAction/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
getNpcAction(npc_id : int, index : int) -> dict
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the identifier of npc.
|
||||
`int` **index**: the index of element in the queue.
|
||||
## Returns
|
||||
`dict {type, id, status}`: The table containing information about selected element.
|
||||
"""
|
||||
return sqg2o.getNpcAction(npc_id, index)
|
||||
|
||||
def getNpcActions(npc_id : int) -> list:
|
||||
"""
|
||||
This function gets informations about elements in NPC action queue.
|
||||
Original: [getNpcActions](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/getNpcActions/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getNpcActions(npc_id : int) -> list
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the identifier of npc.
|
||||
## Returns
|
||||
`list [{type, id}]`: The array containing information about queue elements.
|
||||
"""
|
||||
return sqg2o.getNpcActions(npc_id)
|
||||
|
||||
def getNpcActionsCount(npc_id : int) -> int:
|
||||
"""
|
||||
This function gets elements count in NPC action queue.
|
||||
Original: [getNpcActionsCount](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/getNpcActionsCount/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getNpcActionsCount(npc_id : int) -> int
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the identifier of npc.
|
||||
## Returns
|
||||
`int`: The count of elements inside queue, otherwise `-1`.
|
||||
"""
|
||||
return sqg2o.getNpcActionsCount(npc_id)
|
||||
|
||||
def getNpcHostPlayer(npc_id : int) -> int:
|
||||
"""
|
||||
This function gets NPC host player id.
|
||||
Original: [getNpcHostPlayer](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/getNpcHostPlayer/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
getNpcHostPlayer(npc_id : int) -> int
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the identifier of npc.
|
||||
## Returns
|
||||
`int`: the host player identifier. If there is no host player `-1` is returned instead.
|
||||
"""
|
||||
return sqg2o.getNpcHostPlayer(npc_id)
|
||||
|
||||
def getNpcLastActionId(npc_id : int) -> int:
|
||||
"""
|
||||
This function gets last action identifier, that was enqued to the NPC action queue. Every action in queue has associated unique id, by which can be identified.
|
||||
Original: [getNpcLastActionId](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/getNpcLastActionId/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
getNpcLastActionId(npc_id : int) -> int
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the identifier of npc.
|
||||
## Returns
|
||||
`int`: The last finished action identifier, otherwise `-1`.
|
||||
"""
|
||||
return sqg2o.getNpcLastActionId(npc_id)
|
||||
|
||||
def isNpc(npc_id : int) -> bool:
|
||||
"""
|
||||
This function checks whether id related to given object is remote NPC.
|
||||
Original: [isNpc](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/isNpc/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def isNpc(npc_id : int) -> bool
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the identifier of npc.
|
||||
## Returns
|
||||
`bool`: `true` when object is NPC, otherwise `false`.
|
||||
"""
|
||||
return sqg2o.isNpc(npc_id)
|
||||
|
||||
def isNpcActionFinished(npc_id : int, action_id : int) -> bool:
|
||||
"""
|
||||
This function checks whether specified NPC action was finished.
|
||||
Original: [isNpcActionFinished](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/isNpcActionFinished/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def isNpcActionFinished(npc_id : int, action_id : int) -> bool
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the identifier of npc.
|
||||
`int` **action_id**: the unique action identifier.
|
||||
## Returns
|
||||
`bool`: `true` if specified action identifier was already finished, otherwise `false`.
|
||||
"""
|
||||
return sqg2o.isNpcActionFinished(npc_id, action_id)
|
||||
|
||||
def npcAttackMelee(attacker_id : int, enemy_id : int, attack_type : int, combo : int):
|
||||
"""
|
||||
!!! note
|
||||
Combo is internal Gothic value. Its behaviour can be sometimes undefined. For example -1 value doesn't work for not humanoid NPCs.
|
||||
|
||||
This function enqueues attack melee action to the remote NPC action queue.
|
||||
Original: [npcAttackMelee](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/npcAttackMelee/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def npcAttackMelee(attacker_id : int, enemy_id : int, attack_type : int, combo : int)
|
||||
```
|
||||
## Parameters
|
||||
`int` **attacker_id**: the remote npc id.
|
||||
`int` **enemy_id**: the remote npc or player id.
|
||||
`int` **attack_type**: the type of attack.
|
||||
`int` **combol**: the combo sequence. For `-1` execute next command immediately.
|
||||
"""
|
||||
return sqg2o.npcAttackMelee(attacker_id, enemy_id, attack_type, combo)
|
||||
|
||||
def npcAttackRanged(attacker_id : int, enemy_id : int):
|
||||
"""
|
||||
This function enqueues attack ranged action to the remote NPC action queue.
|
||||
Original: [npcAttackRanged](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/npcAttackRanged/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def npcAttackRanged(attacker_id : int, enemy_id : int)
|
||||
```
|
||||
## Parameters
|
||||
`int` **attacker_id**: the remote npc id.
|
||||
`int` **enemy_id**: the remote npc or player id.
|
||||
"""
|
||||
return sqg2o.npcAttackRanged(attacker_id, enemy_id)
|
||||
|
||||
def npcSpellCast(attacker_id : int, enemy_id : int):
|
||||
"""
|
||||
This function enqueues spell cast action to the remote NPC action queue.
|
||||
Original: [npcSpellCast](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/npcSpellCast/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def npcSpellCast(attacker_id : int, enemy_id : int)
|
||||
```
|
||||
## Parameters
|
||||
`int` **attacker_id**: the remote npc id.
|
||||
`int` **enemy_id**: the remote npc or player id.
|
||||
"""
|
||||
return sqg2o.npcSpellCast(attacker_id, enemy_id)
|
||||
|
||||
def npcUseClosestMob(npc_id : int, sceme : str, target_state : int):
|
||||
"""
|
||||
This function enqueues use closest mob action to the remote NPC action queue.
|
||||
Original: [npcUseClosestMob](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/npcUseClosestMob/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def npcUseClosestMob(npc_id : int, sceme : str, target_state : int)
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the npc identifier.
|
||||
`str` **sceme**: the animation sceme name, e.g: `"BENCH"` when you want to interact with bench.
|
||||
`int` **target_state**: the target state, use `1` if you want to start interaction and `-1` to end it.
|
||||
"""
|
||||
return sqg2o.npcUseClosestMob(npc_id, sceme, target_state)
|
||||
|
||||
def setNpcHostPlayer(npc_id : int, host_id : int) -> bool:
|
||||
"""
|
||||
This function sets new NPC host player.
|
||||
Original: [setNpcHostPlayer](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/npc/setNpcHostPlayer/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def setNpcHostPlayer(npc_id : int, host_id : int) -> bool
|
||||
```
|
||||
## Parameters
|
||||
`int` **npc_id**: the npc identifier.
|
||||
`int` **host_id**: the player host identifier.
|
||||
## Returns
|
||||
`bool`: `true` if host was successfully changed, otherwise `false`.
|
||||
"""
|
||||
return sqg2o.setNpcHostPlayer(npc_id, host_id)
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,52 +0,0 @@
|
||||
import sqg2o
|
||||
|
||||
def findNearbyPlayers(position : dict, radius : int, world : str, virtual_world : int = 0) -> list:
|
||||
"""
|
||||
This function will search for nearest players, that matches given query arguments.
|
||||
Original: [findNearbyPlayers](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/streamer/findNearbyPlayers/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def findNearbyPlayers(position : dict, radius : int, world : str, virtual_world : int = 0) -> list
|
||||
```
|
||||
## Parameters
|
||||
`dict {x, y, z}` **position**: the centroid position.
|
||||
`int` **radius**: the maximum radius to search from centroid.
|
||||
`str` **world**: the world used to find players.
|
||||
`int` **virtual_world**: the virtual world used to find players.
|
||||
## Returns
|
||||
`list [int]`: ids of nearby players.
|
||||
"""
|
||||
return sqg2o.findNearbyPlayers(position, radius, world, virtual_world)
|
||||
|
||||
def getSpawnedPlayersForPlayer(id : int) -> list:
|
||||
"""
|
||||
This function is used to retrieve currently spawned players for given player.
|
||||
Original: [getSpawnedPlayersForPlayer](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/streamer/getSpawnedPlayersForPlayer/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getSpawnedPlayersForPlayer(id : int) -> list
|
||||
```
|
||||
## Parameters
|
||||
`int` **id**: the player id.
|
||||
## Returns
|
||||
`list [int]`: ids of spawned players.
|
||||
"""
|
||||
return sqg2o.getSpawnedPlayersForPlayer(id)
|
||||
|
||||
def getStreamedPlayersByPlayer(id : int) -> list:
|
||||
"""
|
||||
This function is used to retrieve currently streamed players by given player. More details: Streamed players are basically clients, that has spawned given player in their game. Please notice, that player can be spawned only one way. Which means that there are situation were player 1 is spawned for player 2, but not the other way arount. Simple examples: - Invisible players cannot be seen, but they can see everyone nearby. - Flying around world using camera.
|
||||
Original: [getStreamedPlayersByPlayer](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/streamer/getStreamedPlayersByPlayer/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getStreamedPlayersByPlayer(id : int) -> list
|
||||
```
|
||||
## Parameters
|
||||
`int` **id**: the player id.
|
||||
## Returns
|
||||
`list [int]`: ids of streamed players.
|
||||
"""
|
||||
return sqg2o.getStreamedPlayersByPlayer(id)
|
||||
@@ -1,37 +0,0 @@
|
||||
import sqg2o
|
||||
|
||||
def getNearestWaypoint(world : str, x : int, y : int, z : int) -> dict:
|
||||
"""
|
||||
This function is used to retrieve the information about nearest waypoint from the specified position.
|
||||
Original: [getNearestWaypoint](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/waypoint/getNearestWaypoint/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getNearestWaypoint(world : str, x : int, y : int, z : int) -> dict
|
||||
```
|
||||
## Parameters
|
||||
`str` **world**: the world name in which the waypoint exists.
|
||||
`int` **x**: the position in the world on the x axis.
|
||||
`int` **y**: the position in the world on the y axis.
|
||||
`int` **z**: the position in the world on the z axis.
|
||||
## Returns
|
||||
`dict {name, x, y, z}`: Waypoint information.
|
||||
"""
|
||||
return sqg2o.getNearestWaypoint(world, x, y, z)
|
||||
|
||||
def getWaypoint(world : str, name : str) -> dict:
|
||||
"""
|
||||
This function is used to retrieve the position of specified waypoint.
|
||||
Original: [getWaypoint](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-functions/waypoint/getWaypoint/)
|
||||
|
||||
## Declaration
|
||||
```python
|
||||
def getWaypoint(world : str, name : str) -> dict
|
||||
```
|
||||
## Parameters
|
||||
`str` **world**: the world name in which the waypoint exists.
|
||||
`str` **name**: the name of the waypoint.
|
||||
## Returns
|
||||
`dict {x, y, z}`: The position of waypoint.
|
||||
"""
|
||||
return sqg2o.getWaypoint(world, name)
|
||||
Reference in New Issue
Block a user