Merge branch 'dev'

mkdocs.yml

@@ -0,0 +1,271 @@
+site_name: PyG2O
+
+markdown_extensions:
+  - nl2br
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - sane_lists
+  - attr_list
+  - md_in_html
+  - pymdownx.blocks.caption
+
+plugins:
+  - mkdocstrings
+  - search
+  - callouts
+  - glightbox
+  
+repo_url: https://github.com/AURUMVORXX/PyG2O.git
+  
+nav:
+  - How to use: index.md
+  - Comparing with Squirrel: comparing.md
+  - QnA: qna.md
+  - Classes:
+    - Game:
+      - Daedalus: classes/game/Daedalus.md
+      - Sky: classes/game/Sky.md
+      - DamageDescription: classes/game/DamageDescription.md
+    - Item:
+      - ItemGround: classes/item/ItemGround.md
+      - ItemsGround: classes/item/ItemsGround.md
+    - Mds:
+      - Mds: classes/mds/Mds.md
+  - Constants:
+    - AntiCheat: constants/anticheat.md
+    - Context: constants/context.md
+    - Damage: constants/damage.md
+    - General: constants/general.md
+    - Hand: constants/hand.md
+    - Item: constants/item.md
+    - Network: constants/network.md
+    - NPC: constants/npc.md
+    - Reliability: constants/reliability.md
+    - Skill weapon: constants/skill-weapon.md
+    - Talent: constants/talent.md
+    - Weapon mode: constants/weapon-mode.md
+    - Weather: constants/weather.md
+  - Events:
+    - Anticheat:
+      - onPlayerUseCheat: defaultEvents/anticheat/onPlayerUseCheat.md
+    - General:
+      - onInit: defaultEvents/general/onInit.md
+      - onExit: defaultEvents/general/onExit.md
+      - onTick: defaultEvents/general/onTick.md
+      - onTime: defaultEvents/general/onTime.md
+      - onBan: defaultEvents/general/onBan.md
+      - onUnban: defaultEvents/general/onUnban.md
+    - Npc:
+      - onNpcActionFinished: defaultEvents/npc/onNpcActionFinished.md
+      - onNpcActionSent: defaultEvents/npc/onNpcActionSent.md
+      - onNpcChangeHostPlayer: defaultEvents/npc/onNpcChangeHostPlayer.md
+      - onNpcCreated: defaultEvents/npc/onNpcCreated.md
+      - onNpcDestroyed: defaultEvents/npc/onNpcDestroyed.md
+    - Player:
+      - onPlayerChangeColor: defaultEvents/player/onPlayerChangeColor.md
+      - onPlayerChangeFocus: defaultEvents/player/onPlayerChangeFocus.md
+      - onPlayerChangeHealth: defaultEvents/player/onPlayerChangeHealth.md
+      - onPlayerChangeMana: defaultEvents/player/onPlayerChangeMana.md
+      - onPlayerChangeMaxHealth: defaultEvents/player/onPlayerChangeMaxHealth.md
+      - onPlayerChangeMaxMana: defaultEvents/player/onPlayerChangeMaxMana.md
+      - onPlayerChangeWeaponMode: defaultEvents/player/onPlayerChangeWeaponMode.md
+      - onPlayerChangeWorld: defaultEvents/player/onPlayerChangeWorld.md
+      - onPlayerCommand: defaultEvents/player/onPlayerCommand.md
+      - onPlayerDamage: defaultEvents/player/onPlayerDamage.md
+      - onPlayerDead: defaultEvents/player/onPlayerDead.md
+      - onPlayerDisconnect: defaultEvents/player/onPlayerDisconnect.md
+      - onPlayerDropItem: defaultEvents/player/onPlayerDropItem.md
+      - onPlayerEnterWorld: defaultEvents/player/onPlayerEnterWorld.md
+      - onPlayerEquipAmulet: defaultEvents/player/onPlayerEquipAmulet.md
+      - onPlayerEquipArmor: defaultEvents/player/onPlayerEquipArmor.md
+      - onPlayerEquipBelt: defaultEvents/player/onPlayerEquipBelt.md
+      - onPlayerEquipHandItem: defaultEvents/player/onPlayerEquipHandItem.md
+      - onPlayerEquipHelmet: defaultEvents/player/onPlayerEquipHelmet.md
+      - onPlayerEquipMeleeWeapon: defaultEvents/player/onPlayerEquipMeleeWeapon.md
+      - onPlayerEquipRangedWeapon: defaultEvents/player/onPlayerEquipRangedWeapon.md
+      - onPlayerEquipRing: defaultEvents/player/onPlayerEquipRing.md
+      - onPlayerEquipShield: defaultEvents/player/onPlayerEquipShield.md
+      - onPlayerEquipSpell: defaultEvents/player/onPlayerEquipSpell.md
+      - onPlayerJoin: defaultEvents/player/onPlayerJoin.md
+      - onPlayerMessage: defaultEvents/player/onPlayerMessage.md
+      - onPlayerMobInteract: defaultEvents/player/onPlayerMobInteract.md
+      - onPlayerRespawn: defaultEvents/player/onPlayerRespawn.md
+      - onPlayerShoot: defaultEvents/player/onPlayerShoot.md
+      - onPlayerSpellCast: defaultEvents/player/onPlayerSpellCast.md
+      - onPlayerSpellSetup: defaultEvents/player/onPlayerSpellSetup.md
+      - onPlayerTakeItem: defaultEvents/player/onPlayerTakeItem.md
+      - onPlayerTeleport: defaultEvents/player/onPlayerTeleport.md
+      - onPlayerToggleFaceAni: defaultEvents/player/onPlayerToggleFaceAni.md
+  - Functions:
+    - Exception:
+      - set_default_logger: functions/exception/set_default_logger.md
+      - handle_exception: functions/exception/handle_exception.md
+    - Chat:
+      - sendMessageToAll: functions/chat/sendMessageToAll.md
+      - sendMessageToPlayer: functions/chat/sendMessageToPlayer.md
+      - sendPlayerMessageToAll: functions/chat/sendPlayerMessageToAll.md
+      - sendPlayerMessageToPlayer: functions/chat/sendPlayerMessageToPlayer.md
+    - Game:
+      - getHostname: functions/game/getHostname.md
+      - getMaxSlots: functions/game/getMaxSlots.md
+      - getPlayersCount: functions/game/getPlayersCount.md
+      - exit: functions/game/exit.md
+      - getDayLength: functions/game/getDayLength.md
+      - getServerDescription: functions/game/getServerDescription.md
+      - getServerWorld: functions/game/getServerWorld.md
+      - getTime: functions/game/getTime.md
+      - serverLog: functions/game/serverLog.md
+      - setDayLength: functions/game/setDayLength.md
+      - setServerDescription: functions/game/setServerDescription.md
+      - setServerWorld: functions/game/setServerWorld.md
+      - setTime: functions/game/setTime.md
+    - Npc:
+      - clearNpcActions: functions/npc/clearNpcActions.md
+      - createNpc: functions/npc/createNpc.md
+      - destroyNpc: functions/npc/destroyNpc.md
+      - getNpcAction: functions/npc/getNpcAction.md
+      - getNpcActions: functions/npc/getNpcActions.md
+      - getNpcActionsCount: functions/npc/getNpcActionsCount.md
+      - getNpcHostPlayer: functions/npc/getNpcHostPlayer.md
+      - getNpcLastActionId: functions/npc/getNpcLastActionId.md
+      - isNpc: functions/npc/isNpc.md
+      - isNpcActionFinished: functions/npc/isNpcActionFinished.md
+      - npcAttackMelee: functions/npc/npcAttackMelee.md
+      - npcAttackRanged: functions/npc/npcAttackRanged.md
+      - npcSpellCast: functions/npc/npcSpellCast.md
+      - npcUseClosestMob: functions/npc/npcUseClosestMob.md
+      - setNpcHostPlayer: functions/npc/setNpcHostPlayer.md
+    - Player:
+      - addBan: functions/player/addBan.md
+      - applyPlayerOverlay: functions/player/applyPlayerOverlay.md
+      - ban: functions/player/ban.md
+      - drawWeapon: functions/player/drawWeapon.md
+      - equipItem: functions/player/equipItem.md
+      - getPlayerAmulet: functions/player/getPlayerAmulet.md
+      - getPlayerAngle: functions/player/getPlayerAngle.md
+      - getPlayerAni: functions/player/getPlayerAni.md
+      - getPlayerArmor: functions/player/getPlayerArmor.md
+      - getPlayerAtVector: functions/player/getPlayerAtVector.md
+      - getPlayerBelt: functions/player/getPlayerBelt.md
+      - getPlayerCameraPosition: functions/player/getPlayerCameraPosition.md
+      - getPlayerCollision: functions/player/getPlayerCollision.md
+      - getPlayerColor: functions/player/getPlayerColor.md
+      - getPlayerContext: functions/player/getPlayerContext.md
+      - getPlayerDexterity: functions/player/getPlayerDexterity.md
+      - getPlayerFaceAnis: functions/player/getPlayerFaceAnis.md
+      - getPlayerFatness: functions/player/getPlayerFatness.md
+      - getPlayerFocus: functions/player/getPlayerFocus.md
+      - getPlayerHealth: functions/player/getPlayerHealth.md
+      - getPlayerHelmet: functions/player/getPlayerHelmet.md
+      - getPlayerIP: functions/player/getPlayerIP.md
+      - getPlayerInstance: functions/player/getPlayerInstance.md
+      - getPlayerInvisible: functions/player/getPlayerInvisible.md
+      - getPlayerMacAddr: functions/player/getPlayerMacAddr.md
+      - getPlayerMana: functions/player/getPlayerMana.md
+      - getPlayerMaxHealth: functions/player/getPlayerMaxHealth.md
+      - getPlayerMaxMana: functions/player/getPlayerMaxMana.md
+      - getPlayerMeleeWeapon: functions/player/getPlayerMeleeWeapon.md
+      - getPlayerName: functions/player/getPlayerName.md
+      - getPlayerPing: functions/player/getPlayerPing.md
+      - getPlayerPosition: functions/player/getPlayerPosition.md
+      - getPlayerRangedWeapon: functions/player/getPlayerRangedWeapon.md
+      - getPlayerRespawnTime: functions/player/getPlayerRespawnTime.md
+      - getPlayerRing: functions/player/getPlayerRing.md
+      - getPlayerScale: functions/player/getPlayerScale.md
+      - getPlayerSerial: functions/player/getPlayerSerial.md
+      - getPlayerShield: functions/player/getPlayerShield.md
+      - getPlayerSkillWeapon: functions/player/getPlayerSkillWeapon.md
+      - getPlayerSpell: functions/player/getPlayerSpell.md
+      - getPlayerStrength: functions/player/getPlayerStrength.md
+      - getPlayerTalent: functions/player/getPlayerTalent.md
+      - getPlayerUID: functions/player/getPlayerUID.md
+      - getPlayerVirtualWorld: functions/player/getPlayerVirtualWorld.md
+      - getPlayerVisual: functions/player/getPlayerVisual.md
+      - getPlayerWeaponMode: functions/player/getPlayerWeaponMode.md
+      - getPlayerWorld: functions/player/getPlayerWorld.md
+      - giveItem: functions/player/giveItem.md
+      - hitPlayer: functions/player/hitPlayer.md
+      - isPlayerConnected: functions/player/isPlayerConnected.md
+      - isPlayerDead: functions/player/isPlayerDead.md
+      - isPlayerSpawned: functions/player/isPlayerSpawned.md
+      - isPlayerUnconscious: functions/player/isPlayerUnconscious.md
+      - kick: functions/player/kick.md
+      - playAni: functions/player/playAni.md
+      - playFaceAni: functions/player/playFaceAni.md
+      - readySpell: functions/player/readySpell.md
+      - removeItem: functions/player/removeItem.md
+      - removePlayerOverlay: functions/player/removePlayerOverlay.md
+      - removeWeapon: functions/player/removeWeapon.md
+      - setPlayerAngle: functions/player/setPlayerAngle.md
+      - setPlayerCollision: functions/player/setPlayerCollision.md
+      - setPlayerColor: functions/player/setPlayerColor.md
+      - setPlayerDexterity: functions/player/setPlayerDexterity.md
+      - setPlayerDexterity: functions/player/setPlayerDexterity.md
+      - setPlayerFatness: functions/player/setPlayerFatness.md
+      - setPlayerHealth: functions/player/setPlayerHealth.md
+      - setPlayerInstance: functions/player/setPlayerInstance.md
+      - setPlayerInvisible: functions/player/setPlayerInvisible.md
+      - setPlayerMana: functions/player/setPlayerMana.md
+      - setPlayerMaxHealth: functions/player/setPlayerMaxHealth.md
+      - setPlayerMaxMana: functions/player/setPlayerMaxMana.md
+      - setPlayerName: functions/player/setPlayerName.md
+      - setPlayerScale: functions/player/setPlayerScale.md
+      - setPlayerRespawnTime: functions/player/setPlayerRespawnTime.md
+      - setPlayerScale: functions/player/setPlayerScale.md
+      - setPlayerSkillWeapon: functions/player/setPlayerSkillWeapon.md
+      - setPlayerStrength: functions/player/setPlayerStrength.md
+      - setPlayerTalent: functions/player/setPlayerTalent.md
+      - setPlayerVirtualWorld: functions/player/setPlayerVirtualWorld.md
+      - setPlayerVisual: functions/player/setPlayerVisual.md
+      - setPlayerWeaponMode: functions/player/setPlayerWeaponMode.md
+      - setPlayerWorld: functions/player/setPlayerWorld.md
+      - setPlayerAttributes: functions/player/setPlayerAttributes.md
+      - setPlayerTalents: functions/player/setPlayerTalents.md
+      - spawnPlayer: functions/player/spawnPlayer.md
+      - stopAni: functions/player/stopAni.md
+      - stopFaceAni: functions/player/stopFaceAni.md
+      - unequipItem: functions/player/unequipItem.md
+      - unreadySpell: functions/player/unreadySpell.md
+      - unspawnPlayer: functions/player/unspawnPlayer.md
+      - useItem: functions/player/useItem.md
+      - useItemToState: functions/player/useItemToState.md
+    - Event:
+      - addEvent: functions/event/addEvent.md
+      - event: functions/event/event.md
+      - callEvent: functions/event/callEvent.md
+      - removeEvent: functions/event/removeEvent.md
+      - removeEventHandler: functions/event/removeEventHandler.md
+      - toggleEvent: functions/event/toggleEvent.md
+    - Streamer:
+      - findNearbyPlayers: functions/streamer/findNearbyPlayers.md
+      - getSpawnedPlayersForPlayer: functions/streamer/getSpawnedPlayersForPlayer.md
+      - getStreamedPlayersByPlayer: functions/streamer/getStreamedPlayersByPlayer.md
+    - Waypoint:
+      - getNearestWaypoint: functions/waypoint/getNearestWaypoint.md
+      - getWaypoint: functions/waypoint/getWaypoint.md
+
+theme:
+  name: material
+  features:
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.code.annotation
+    - content.code.copy
+  icon:
+    repo: fontawesome/brands/gitlab
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/eye-outline
+        name: Switch to dark mode
+
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/eye
+        name: Switch to light mode
+        
+      primary: black