diff --git a/docs/assets/search.js b/docs/assets/search.js index 3b272d3..62cd53f 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA709SZPbOnP/RXNIDoo+gQS4+JZ6SaXe4ctSlUoOLteUrOF49D1t0TK24/J/D1ayG+wmIdIvl5FG7EY3ekcDJH8sLqev18WHjz8Wf+yOL4sP2XJx3ByaxYfFb6dLs1gu7pe9/udwernvm+tfzI+rt9thr69s95vrtdHIi8XPZR//djrtr70B7K/DI6iiHeM/NXQ7xO54ay6vm207irlKDLVcnDeX5nhreejGFutMtoNft2/NYZMw/FMLOUDFgnOkmm/N9n5rUmh1oA8QK5TKO6k9P9++nx8htmoxxmiuAnuAdjfN7Wbfqev1ftzedqdjoGouPqatwVmxwz/Zb0kzspCW6Y5ozlnw++ay23zubJiz5KkT4sd/SprMoK1vL83m9gCtVYswSjKImqG8sVp6gHKLMJey/Uin68HnUrX4jwjaw8+luzu+a5TT5fsDtCHOXPrX++GgCf7vIyKHOLPl/ra5PSJ2Bz6X6qU532+bBy0cIU3hIKtaBv4FGrkfy2Vpc2U4PNkM3w2rRBf6tjqw3i73rTaOkdGfMChPyaKw1vsyRsZCTBz9dLaZYoxEBzaRzna/M5BjAgtQE6k0xmlHJ9NCTZ2LdpBRIgFoIo233RVFLIZKBzaRzsvmthkj4mHSKWRFJmRHY68Fvh8jEoAmU/na7L683X7bXC67ZtRlYuDJVE/vzeXz/fLSHMeJRrAP0FzLCmSz3agfeZiJFKK6hKExUoyMUkFZacCJZkjqsPnSjDpqCzVZH9dzs01QSQCbSOfSXE/79+bfN7e3MVoYNJ3eYBE+TmsFvv+D8Mn5H8Q4CytmEN7t3jf7+y9gbRXGmchgvwBBKrs2o2bhQCaaxLiTznHQ0+vr6PAWZOL4zbfz6TIqoBbqzzVjR2blPloLSbAMhDi9hqPpr3YvSf6DsEfq8tvpj2a84GP4aZF/JUeJNSjDksf+5XJKqYwYlgzqL+cnqepkGLK4v5yjxBqV4clj/wquoqyfElZaqAfqZrC2/G1gOeOu/XnrSzB++grTMzxhdYbIJazPhikdTi/cWgASCmCT6diq7q9pxBDsdBmejrfm2+2/9ZXT1yTNIfDJdL+wbQ5I7stQCy+BylDWgHRSEkSPEl4XwE45Lz4HNZmK1XmiaTxKB+zSmBDiAP4tSnJg66ENNgjyoQBCePM0gk8x8kh8xJNLcvpERhJCQDIDRDRI5CI1NiSzQoeJVOWkB40hhmgL/d1MNd1qIPh0W73CtvgDxJ6uQ73xAWyWkdv3/UROPOYvYyXVXfqsPOQzKazote5ZX26eX0+XA+jXPMJUf4w57MW2m2Kw/48RdU4sHdHF/bh7by7XYSNF9AHGPNLn/eZ7c/lXWGmMEkc4v4L8b2j7MJF+QJrHwH5z/HKHBcModYAxc+6X0+F8e2TeLcLDhFPPSgwSTm6dBOTAcNr+/INsjO3Wc9w8soH+KEuD2+kTGdo+6ByRkB7ykkSW+tvej7I1vgk+kbX/uTfX4WQ2xFbAnstSnMr+CXacKKYMwPQk9tZs9mDvYJDAUws8MknL8yDB55fmur3szmhPKYV4hDiDkc3lAJopw7QD7Axyh9Ox+Z5ILsDOJfc8GpEims9pUWiIsNtEfb7DDclhyhhjPunt5rzZ7m6pwu5jzWCh+XZuLrq+26aKHSHMIEwcrBkmnHCo5kHCE3yaRZ7B0P60fUQOAPwXEJ0gAwZ1TmQ7n5vNZZNuhAhhji3c00NqgJ1B7rptjqlTDLCzwsvm9takzq+Dnk9yglXRmHOMaju+zgUW1ULP1e9zczj9bfeIlluMGaRtNZc62RZ4BsHtm3bAraaSShQhzCDcPwc7THf8DGzqfJPlm3hqbtB6P+/2u9uuSbZfAP8YWXzU9J/f4RZac7wfADl78bHSvVsbfNnsjuMDP3mwkTk4Nkk6+xNYQvJ0PNh0OujkF08n7fDXAJ2XBp6V4gkFuOmUohNzPKnUQ3MDtKL9bZ5W6hb3AK3X3VGXCrvN/vlyT7LBHsIMmZqFmElqt8vpOzhcOSDcHsYMKYfY97x5eUmi3sf4FdQvOsO9P0i/w5nOgU10yXPH0HOpps85hp8Vk1yOTZ5zH+NXUE+fO4Uzw9tsFky39hh+PuX0mfcx5kRTc/r32XWJk9wsRniQNmz6/R5c9vdbc2DLFQQ1vf03XFz3iTwl1NZ4AlN65QTd8cZUEtmUhRRBPXkVlcQEPqecQD7hQHISYdfqeoRyizGX9GVzGWrJEaRbjLmkBzesCMLjG1VJZM0pvPvB3Nn2CHGENYEFGEn+0YVElry//mdFDzh8StwI7E6JGIjWeKwYIZUSJRDF5PjQJwwV9tvbwGkKc3HGYYW2MBiUY0vkqYcwdNrN8M1tRDTXK7rjhicJQNOJxfL7qxtkkJyHmS7N18vp8OzOEiQTesJIIzMM0xg6MHYcNhZEvEOYR/i201q6bQ7ndNIQ5WHikXqdSQ7RdhB/VkzDBFKiWsf0lLgW0UtyxWFyKbEtopoc3UaJJ+xMRLRTtyZGSY9sdEdkU3a6E0kmNe9J8unN+3HBD252xzIf3+0eJTi83R0RTNjvHp/hfveeblUeeJZ2T9fbbqC4i1Xags8hmrDNG9FN3ed9gPQUi56y0zvK0vjeRcRF4ubFuLGNbifEBpe2n0ARhhnwPwaPKNmrf1bm6wZPyXqO0SkZD9AZz3aDZFKsFFBLNstBotvT4bxvYNdogCQEnkrw0nzdXJKotZAPkHro8GePVtKpT4flmZuUTTi6q4S8AqmPnA9MONvDcpJ6zOcBdhJSActOalJ4gJ3xWMxykxiVh5mRopb5mnm2Wu9xfOO3ig0MTT+prxs7XB8a/NNSy+el+bb48GNhjuMbVXxYZKt8VWvg112zf9GIH0Os1JHiYNA/+Wv/1Zi7Ow2EA/nLerH8uF7KcqXq/NOn5ceAYS+I5XoldRrJzGe2zPVHqcRS+p+V/tT/FvojL8Wy9D9X7ufafYi1/xT+M/Ofuf+U/tOMltf5UoTxhBkw1/DCjJgpx5/lWhjm6mVer0SGuDYXOrBM/5eRs8sQXG7gBAWXIzhp4DIKTiI4ZeDyZS5Wsq4RnEJwhYGTy7xYFesSwRUIrmTHKxFcxYmlQmA1O1yN4IS1gWKZy1WBpbzGcEbqmaLmIbBChNWIHjFbRQIUWCPCqqSkNIxVIqxOKpI2VoqwWqmXMlvJSmFIrBZhpJ+viXljtQgj/VyQtLFihNVMtczyVSEkhqy8o2V1Zh0tK2rrabIuraeZ341LZHllXcz8b50lM14Trlhn8a4ilaZk/lfaqHMzZm5EmYcvMnxRfri8CL+U4YsZpzZGUnsYuQ5fhIeRWfgljCwDv1K5X4AEjGnJgpQ+trrMGJcsKcgM211mjEtWhJFkURwwxiUpx8iw2WXGuNSaAsRmlxnb0vInALHVZca0VEYBYqPLjG0pLXAtQYmNKcNmlxnbUpIUkLVILftCa0ODiJVOP0r5z8J/lvpTFGqprJL1X1X7X4q1+wUQM+ZZkLHRXsq9nVgiSjuDpWK+FFn4omP6qhQKDGo0XtAzsMFJI2TalG3CqatlYWaSayqFoSIr7RBF+FK6LyCYGyMpKjKa24BmMDJtipqAlofRof6s9M/a8bLVOi/AWHxks5cCg9btSu1PmWFQpzRV+SmUa8+oSWgRoxkTZtwFGwqsq2suddyyHq51lxsdFaXWr03LegKl/VJpYnn4YlO05qdU4UsRgMsAU4Uvtf9SrcMXEb6EkSs/MuDeOERF6tBeMvSU8qFKaUDR/lLZBF8uM+kv2UBUaIYqGb4oW2vUy6oIX8rwpQowtf+lXrsvgDnjhLUgmZNWuFqmdWcCyvyQ1XJZC2cLYCjjpjWZ9O0lawLrzKmnrGs3vUIHMGUuVVpzpqhZ5Wu1rGX4opzDATIFm5Rz7P658XHNez+i5Djp5MY/azKQ5hWIE45zXY9ZzpWWrOW81IG+qlzIqH0IqQsfMerS/gCIGb9VVCy2V1pBG3cotJ2WyjtdWbhfQJVlvLQmHdhesmxWyg+mubRD6E8jfBNodM25jkOOtCXjmjQJKUAg60Z3RrI0SC6QibUPaWDYjFWbxKlF5mxak1GVKS2rOQmKs4tUXAaUOLtIPrtIbF6y5DKbxOYlKy6zSVxuSmsA2noIyDoEZO0UhOSzVvLSqhiU2GsupStcJCjBFh4KVwmKrRIUVqXK7YQUBYlVqZwqaerRmkFZUNJAFFamKthqUmFlqpI3JYXVqSp2MaKwPpXTJ+mgCtdyhfVXrUoCtMB6KqyD6tUiwWqBFVVkrPwLrKki5+VfYFUVkpd/gVVVWFUJsigqohWeVZUg00eBdVVYXekwTIFiXRUVLwCsq8LqShck1KBYV6XVlY6eBKi9FiJkYesnmzew38oqctJyQKcl1mlpnY+GxDotbSDNSEis0tKoTZIlSok1WjqNFuTcsUZLp9GSBI2W7QPrdqzQ0iqUWGmXWJ2lrY6p9XOJlVkZhZHr5wq7XWUrXHJVXGENVdbrtLIpUKyiyrqdIN3eXhs1JZ8CwJDWPTPSQCqszMoqMyNTfYWVWVllZqQxVViZlXVPuyLuiTTqwlhlZqTPVViflXXPjPS5Cmu0tu6ZkSZaY53WRnEFtYqtsUpru9AgGxg11mhtNZqR0bHGXlc7TZHpocaaqp2mSDupsaZqq6mc1H+NNVVbTeVkeK6xqmqrqpwMz3XUNLOqysnwXMd9M6urnLQAdxEC2yCZkzbgLkJg64Q5aQXuIgS2SsvJUOUuQmCrtpxUm7sIgW0vje66raNm2rrgCkp3CYI6zdE9unXUUltb3UmyvesuQmCrPUnahLsIgF3fU5JWIXq9T7t4oJqFce/TtjiFJC1IxP1P1wBleqqR6oQrXagCW8RNUNvqNA8/JpmIVGf7nULSphk3Q23LU0jaNON+qOt6Sto0RaQ84ZRHm2bUPRSZUx4ZU0TUQBS2TygUbUNZ3Lu2+lO0DUWNRGH7hULRNhQ1E4XtGQpFW0bUUBS2bygUrcGoqShs61AoWoNRX1HY7qFQBWl0WaRB2/1jWvmR/mxPT5jWFTVupD/boyPbG+4SBLV5jkze7hqEdcqjbSiPNx+c8mgbyiPl2YaSKGgbyiPl2ZaRoPup7iIELgb0EXWFhG3+0PqI+kLCdn84feSR8mz7hoxveaQ515wpaJOXke5cP6agTV5GyrOtFFHQJh/1WYTtpphmNgkc7x455dFBK2q2COmURwetqOEibFulJBcfImq5CDnkeFHbRUje8aLGi5BDjicj9ak1X2GJqKkibOuEKcdF1FcRtn3CFOQi6q0I11yhS3IRtVeE66+QRblQ8faf0x4dAaIOi3AtloKOAFGTRaiBfcCoyyKUWxyQhbSIGi3CdlOYMivqtAjXamFqp6jXInyzhVzLiajbIly7hbHOqOEibFeFts6o4SJcx4WxzqjlIlzPpaSjbBHv31rtlXSUjdououBX6SLquwjXeKHtLeq8CNteIVdhIuq8CNdeYTaSI9XZvgljE1FPRdjOCd3TE1FXRdjeCX2mwrdV7NGT9+Zya15+d0dQPn5cLJY/Fs/+RErePsPgx8/u6MmHHwtd0Omffv40o4ajXR2aFmdAWyiHW7qP2n3oVGc/daR3V/1lox4zLqTliGzg+KJk2Fr7YSpPxv+fezK5Zyb316Vnp/RwVd7NCpzTBIS1N7YzM+sXz/Wa4zrcdwWG0KVCN4TjiMcMN9ACfJUB/CwfwW9vgoUj5HAEyY3gn0UA1KoAnvCi9J9mCROP4y/C4SJpwgHXgmPEHdGGIqwAnmJFaM51Aaz1kNF4FDTfUjAYaF5HLNwshQqyiKrmyEBzBHc/QAl2k1rU3qlMamck4o7zQ26BMVUtPmtU8RMUwEgSGUfBjPB5c8V4inPlrOwmv93st/e9fU4nwFSDmMtFVqERkDF0xxV/LPy0lQ8KJo72LTmHY/nXgnXDFTnHC+Shu2kJ2BhgxFSRfcoZMQIVFtbQqTlfiu/lg04F44rkTIh4rABkAsa2rC/HaIwoGkCvXnNhyT32BaQoOO8Cx3sRopRZ2YxJ9nYI9wtCoSD1DEzohuYC5eACrE42IVusOefwj1kFVlrCVOFzVF8zKBuHo6ZwFlwcW0M09+qODkuCVJd5gSqfKBUrCTtM+8YeyAPQU+HVUrJmqv/fIW5KLnrDWLztTtHDYgFZCJct7KtSkGFxkQlJG75gBciuACR9kaH4yXY3ekPTg2znrDuEuzkhJqQuBzG/IcyKS17IVRze1517yQBMsMBclS+1Cp78Bc0XzJaNPf5ZzXCqMGR4o6r6DhLXhTCaf//cXM734x9If5zHQN27N0ABpwdlVRYKXCqi+4DQq0a9V4SqFFaj/hlUMN/CIk5w/ohuZYGBGkaWrA5RMqTAwIJg1fei3exy2B2ROgo2JdfdVPw9Q5AZqMWQvUVYI4g2cBbcLMMbW4EugDkRNfIi9xOUIAS2748HARjkRE4S8IYOIApYmIUsVBBZCNY54WV20KdAJpH9CBJ+A+hIDlxpCaYdP5ML2hjMfoKLnK84Ulds1QyCyCuOl2UxiLMk9YXuoocxAVaikqtl3ePw4GRh7bLuayqgRWUTLFq8+yjC6bmVaVhG+ezOxQY8/36soFawhtWVS8gr/6IioCUuu+XxCM65Vqfj35t/7X+ruAgr2dEyPJpjx3JDFglAB2ym7sahhliDsoVdl5sh4vBtTjd0ayHebLwMsO3AXL3uJ6AOl5w1MNiSZbnBEuc6M1Dib5vtH9g5JBehYWILt7zDdSKYYOVtVLAVDXXTOhwMaLlSYTAuuLevEQTRHYTlzA8gibSPZBHuuoaRAnZzCK91mDtUTkqQObPgjZy17F5RTuCiHEyPPU815/K6soqLSxbNv98H4oLUqrzeCpZb/6pjECVAAsipNJpHjIMnn8EED/NIxvl1eCAlZB8gtjWJ6Gdif9GPg6yt5iweh9iAinMZbDTlnGcaJJ0+7XsoACrb1VlDev6tz4Bf4BxE1R9+8+jhvkq8kB5P+uBGS1DtwFwWnHzdOmiQP7tq6z3iEkZIWOMJrstLPKQSjgGLVsFF2XaMnX1qHjRDWBhkrLvjJXhapxl5MC6HxpXRvQwIJgUgsJJzmb1ORcjhoadlfSmjanO/+3zZYAtI6qsH7KteeCJk1tNQEQfRd8cv2N+5VT6s+7rn9MOcAmy35kp1+gH7cBSQEGpW6CfcpTHnioBdcmHiEBWcMl3Wh83xvtnvcdeYLQBCKQkH6Le2Si5KwKTZPYcLZk248iTWJB61n4uA+ynPZOFNo+C82d1TjUx83KH83f5QsYDnKqwnQ0IUA9S7V6HA0YCXVRxujJWhVa6jXIaYmoWVdx6Yk+EXNl0fm6YXZcdlc2xQ0ybn0hReqTjc0+e/RdnK3NDBeCxaoUB8XGGwKz9QWpxwGZW4+edNjFoa2RfTg5wLggfb+cahQsHKgF3WL1F7kqj9JRgmCxLrB56wLHDDvDeXz/fLS3OMNiFg7KdYApo4R+2kmrMcv0HpkHpr7YLdvaljtL/D/Rm2FCY2b9wAve447E6URKUkekPELgkDd0mUt2gE+5ouJDO2JZ3HaNF6D9QxJVeGnC933FyrWHIgYPcamVyUh1PzLyyDHAKzrMJmSsGFevR4bxiNYD0puJVL9JBuiA+XZxnnl+GdG7AAhoXimouf4bGysEKEHOfcihQ+MwVEUtg/CscdguxUCOvs+p57LBZMO2BadR5G5vLPpbme9njjvGZzPvByj9eLEMBX2FML4V2uqNBgF0IZIopfAguNEe7VclYUHmkE932gQgrOz/zbh6D1ALyaW6n4twhBNCCgmlMKei0NREYbGZzhXbdvzQE1rWArhbPza4OPKJQpuzxX3G6qgenlVKcFhJNrtBIW4EzEgtXD9XY6I4qc2cClgH+3MqQFCj32MBF4cSQQJWoG+ZqBC3m3eBeakymMs7c3RHBwmQ6WligjhqUmaB2H1dXIthJVB2mOdsj4FSd1uHC8veE18uD2Ml7JgCfAwhUFjNdE+eNxTzhWJ5aBQTxw2qc/mrhtDOxGekkqzn7MY52Q6cDdpgEcTBLam1dNSBKcK+M8l3NFFJJ4dDZPKEiXaOo5tO7d0KCYANOkDslAsneMmg/3nbF6/EPuQSwA0bFdIBH9OBSG3rWHn+54scF2KAD19nVtMDwD66i5FES+aA0OAruga64OCM/ZB0U2bC/kxB4grJV777CE9QMQYz1M37+DEyKD1XvFi8AgUwek4IEYLjl+3eFDWjm3KIGG1j+HUKV0Nr6f7ojUaJ38abk4787N3mx5f/j46efP/wN/u+n0AZ4AAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA71dSZPbOpL+L6rDzEGtJgiAi28dbyYm3qFniZiYOTgcFbKK5VI/LdWUVLbH4f8+WMlMEElCZLkvLlrMxJdArkhC4o9Ve/56WX34+GP1x/70tPqQr1en7bFZfVj9dm6b1Xp1aw/qP8fz0+3QXP6sP9y8XI8HdWd32F4ujWJerX6uh/zX8/lwGQxgPh0fQRbdGP+tqLsh9qdr0z5vd90o+m5kqPXqdds2p2snQz82y3LRDX7ZvTTHbcLwDx3lCIohp6Cab83udm1SsHrSO8AKKXm/ao+P1++v94BtOo4pzI0XD2D309xtD726nm+n3XV/PnlUffM+bY3Oihz+wVwlzchQGqF7UE5Z8Nu23W8/9zZMWfLcCdHjPyRNZtTWd22zvd6BtekYJiH9UhPIW6OlO5A7hqXI5k86riNfimr471loR78Ud396Uyzn9vsd2JBnKf7ldjwqwP+7Z8khz+J1f9le71l2S74UtW1eb9ftnRaOmOZIkFedAP8GjdyNZbO0vjMenkyG74eVrA99OxVYr+1tp4xjYvQHTEojGRbSep+mYAzFzNHPryZTTEH0ZDNxdoe9ppxaME81E6XRTjs5mY5q7lyUg0yCeKKZGC/7C4pYBEpPNhPnaXvdToE4mnSEvMiZ6DEOasEPUyCeaDbK12b/5eX627Zt982ky4TEs1HPb037+dY+Nadp0ID2DsxMVCCb7Sf9yNHMRAjqEgJjohiZREFZacSJFqzUcfulmXTUjmq2Pi6vzS5BJZ5sJk7bXM6Ht+Y/t9eXKSxMmo43WoRPY23A9Z+YS85/YtMibIhBaLd72x5u7yDaxo8zU8BhAYJUdmkmzcKSzDSJaSdd4qDn5+fJ4Q3JzPGbb6/ndnKBOqpfa8YWZmP/dBaSYBmIcX4NF8ff7J+S/AdxT9Tl1/MfzXTBR8jTMb+nRIk1KCGS4373dUqpjAiRNOu7y5NUdRICGd53lyixRiVkctzvIVWQ9VPCSkd1R90M9pa/jWxn7L1ft78E46fvMJ3AM3ZnCC5hfzaOdDw/UXsBCOTJZuOYqu6vaWCIdv4ank/X5tv1f9Wd89ckzSHy2bhfyDYHhPsy1sJLQBnLGhAnJUEMkPC+AHbK6eWzVLNRjM4TTeNeHPCURocQS/AfQZIDjx66YIMo7wogEW+eB/gQMk/ERzy5JKdPFCQhBCQLEIkGiVKkxoZkUeJhIlU56UFjTKC4hf6up5puNZB8vq1eYFv8DrCHy1hvfISbFOT6/TBTEsf5bqL8/bY97K/fZwnT876bOKneOxTmLhdOEeV2adpZkjjGdxOkbS6v6nbz+Hxuj6CPdY9MwzGWiBf6dIoj/wMzzZIcM2UUp/1b017GnRdbQ8+xDPr1sP3etP8OK7BJcMTzHvC/oceqifieaZkAh+3pyw0WUpPogGPh3Nvz8fV6z7w7hruBU8+QjAInt5Q8sxc47dzCnWJMnWKgpLnnYMG9Io0eM5gp0O5O5wgW6S4vSRRpeBzgXrGmDwfMFO3vt+YynszGxPLcS0UKU9m/wE5cTChNMD+JvTTbA3imMgrw0BFPTNLIPAr4+NRcdu3+FT1rSwEPGBcIsm2P5/F6qsf2tAvgjudTM17V9nCedinc42RECjAf06LQGLB9uPx4gw9qx5Exx3Lo3fZ1u5vaQgzgAdcCEZpvr02r6rtd6rIjhgXAkQNH48AJh43uBJ7h0yTzAoEO59096wDI3wF0xhoQrEsi2+trs2236UaIGJbYwi09pHraBXCXXXNKnaKnXRRetteXiS04DCueejnkDKuKcy4xqt30PhdYVEe9VL+PzfH8t/09Wu44FkCbai51sh3xAsDdi3LAnUJJBUUMC4CH54PHcafPBqfON3l9E08Tjlrv5/1hf903yfYL6O+DxUdw//UNPlpsTrcjgDM37yvd+73Bl+3+ND3wgyObmIMVM4pzOIMtJI3jyObjoBNxNE7aobgRnKcGniGjgTzdfKTgJCENlXqYcAQreO5PY6U++h/Bet6fVKmw3x4e21uSDQ4YFqyp3ojppHZtz9/BodORxR1wLFhlH/set09PSehDjvdAb1WGe7sTv+eZL4FJdMlzx9RLUdPnHNIvikk2xybPecjxHujpc4/xLPA2kwXTrT2kX46cPvMhx5Joqk9FP9oucZKbhQx3YsOm3+/eZX+/NkeyXEFU89t/48X1EOQhobbGE5jTK4/gTjemkmBTNlIR9ORdVJIQ+Px2AnzCQe0kYNvquge541gK3W7bsZZcBLrjWAo9+sAqAjz9oCoJVp9OvB31N/7uAUdcM0SAkeQvNiSS8O7+r4oecPiUuOHFnRMxENZ0rJiASokSCDE5PgyBocJ+exk5TaFvLjis0BUGo+vYgTwMGMZOAWq5qQcRzeWCvolEQwLSdLBw/f5qBxmFczTzV/O5PR8f7VmCZKAHzDQxQz+NsYN0p3FjQeA9wzLg615p6bo9vqZDQ5a7wQP1WpMcw7YUvyqmYYCUqNYLPSeuBXhJrjgOlxLbAtTk6DYJnvBkIsBOfTQxCT3xoDuATXnSnQiZ1LyPwqc376cXfvRhd7jm00+7JwHHH3cHgAnPu6dneNi/pVuVI16k3fPluh8p7kKVduRLQBMe8wa4qc9574CeY9FznvROijT97CKQIvHhxbSxTT5OCA0u7XlCDBhmwP8aPaJk7v6qzNcPnpL1rKBzMh7Amc52ozApVgrQks1yFHR3Pr4eGtg1GoGExHMB2+brtk1C6yjvgLrr8OcAK+nUp+Vyws3KJhTuJiGvQPSJ84EJZ3tISVKP+dwhTkIqIMVJTQp3iDMdi0lpEqPyuDCC1YJnxG/ODX6mcPordCNDx3/BsB/b3x8b/NNarc9T82314cdKH8fXqviwyjd8Uyvi531zeFKMH32sVJHiqNk/uXv/0+hvvWoKS/LnbLX+mK1FuSmz8tOn9UfPYW6wdbYRMl/n+i8r1lz9LUW5Fu5zqf7KrFgX6i8vqnXpPq/c57X7yzJ/wfxF7i+4vxD+Qo/K6zXzozI9LGdrpofNZW7ENMIzLWO95vUm5wJJr+/0dLn6Xx6dZY7ouKZjMTqO6ISmy2N0AtFJTcfXnG0KliM6iegKTSfWvNiUOUN0BaIryfFKRFeR61Ihupocr0Z0zBiD0r/YlCxY6AxT6oXPZWwqDOuEGaWoMfkmExxTYq0wo5YyqmasF2YUU0XRsWaYUU29FvlG1jWmxLphWgU8i84da4dpJSg7jaFj/TCjoGqdc0VZYcrK+V1e1cbv8sL6naiF8Tv9ufaMXOXX0v3fuEwunM/oO8ZnWF1bpxFSrnP9iVSfcz0q1+bG/YXwF9INyAv/Sekv9Di1AuK1oxGZv2CORuT+Ez+y8BILaT8Ba6BNTBRRDWDry7WJ6agzpMyx9eXaxEQVs5Q8iAjaxETURXJsfbk2MZlFKbH15drEJItSYuvLtYmpOBmjxNaXaxOTykV1KMQ2lWPry7WJSRFdJWOYSgGFUokiYZtM6V7ZhLso/EWpLpj6Vxplq6nI2n1SZPYTgKcNtYgGS3OLG3upLYxU0dLA6Isi9xdcXZQZMIpca76IT8IEK8WgArTJQ8ofCj0XrjJHoUFEqYYs/EVpL0Bw17ai0kksupv4pjlyYfKMWg+ViXQS2lSZmr1yxU2WczAYHefMLS+hcb9SuVyuJWR6kSs7hzJzkpZsIGlOhhx7y4QFpt1eCaoW0ni7VFPmWk1FqVCMk9cqJZvcXfF1yf2Fyd5KpFL6i8ITl56m8he1u6gyf8H8hR+5ciODCWjHqKJqNLc0nlR+auKWXpDuA43LlWC5sHdMRNITqoS/0J+UyiWqwl+U/qLyNLX7pM7sBRBNe2LNoqIJs7ZqSWtgBFJ/kquh9YfaGsBY2lfraB1gbhmX0zG4hNZQqKAo9a1KTbI2o9dyre/aC2ldDsAUZJrmOAZw7eh1EYsrHGcgrl20jsZUXoFoYUXPXB6RSjNG9FIliKpyYaP2gaQuXNioS/sJwNPeK6OR2dzql1u7RaEcu5TO+crCfgLKL+2uddSTzS0ja6XMyQwmMmbH0BdaGzrkqJI0C4OPMOVkFrUNwUBI68c31qIsUnPZmKb2NvYKjJuT+hM41whOZjoRVKDCyMqjpDjZCEkmRYGTjaCTjcCGJkoy1QlsaKIiU53AxagwdqBUEyOtfYDOVCURW/+8W39hVQ2q8IzM9RLXD5KRNYnE9YOk6weJdSq5mZaMkmKlSqvUOH6ws5CGNGoqEmtVFmSxKbFWZUkblcRqlRW5ZZFYrdKqNeqtEhd6hXFeFWwipAXWVGF8Ve0rI6IWWFVFTiugwLoqOK2AAuuqELQCCqyrwuiKRUulItgIGl2xaEopsLIKoyy1fY6RYmUVZk+hyqQYKdZWUY8sFtZWabSlUnhk1BJrq7TaKqKkWFul0ZZy9RipL350EC5MtbYeBgVdRuAAUHLaWEqs1lKrTsQpsVZLE1bzKCVWaqkVJ6LVUBns761Oo75SYp2WVqdRXymxTkt6m19ilVb0Pr/CGq1M/RvdvVdYoZXJftHde4W9rzL7/OievMJaqozz5VE1VVhNlXG+eFOnkin25JMMGNN4aR7VfYU1WhmN5tGQWgVNG6PRPGonFdZoZbw0j3pphVVaG5XmUdersU5r46V51PVqrNTaeGkeNdQaa7U2BX90/1xjrdam/o72T2qs1NoqNWoqNXa+2uiKR5t/NdZVbXTFo6ZSY13VRlc8agF10GMzuuLROF2HbTajLB4N1PYmJDbq4tH4a29CYqMwHjUDexMSm3jJo4Zgb0Ji44s8agr2JiQ2iuPRqGVvQmKjOhFVnb0JiU1vNN76y4LuW1aR1au9B2mN+kR0U2BvAmLbJxXR9M0GnVKjPxE1DBY2S01LVP+Wc5Q40J/pihIty7BjavqiTMStKGya2q4p0d0NtGeao0Q5z8LOqemPMhE3z7B5alukIm6eLNAfs/qLm2fQaGS51V/cPINeIzMdRSbj5pmHzW6jPxmNLSzoODLTV2QybkZB05GZ1iKTcTMK+o7MdBeZjJtR0HpkpsHIZNw0gu4jMz1GJuMazAMNmgahbitGiQMNmsYfk3HXzgMNmk4e8VSBBwrkVoF1dGAeKNA03uKtFXsP0pqUF00O9h6kNeor4lbEA/WZrhKLN13tTUhs1FfErShoHDHTHmJF3IqC3hHj1YhGeKA+096hNBJoz3ZvCI2IQH22JROPciLQnumzsCJu90EThplWCyvidi/CJ05Wf3G7DzoxTFj9xe0+aMYwYfUXj1xBP4YJq7945ApaMsw0XspoocmCpgwTY94nAv3JEe8LWi1Mjnlf0G1hMqfrLRY0XJjtuMTLcxa0XJjtucQLdCbDh4a27oyvXNB2YbbvEi/SWdB5Ybb1UsbDQNB7YabDwsp4GAjaL8z0WIinkkH/hdkGDPFYNOjAMNNmISquoAXDbA+GqKKCJgyzXZj47o4FbRhm+zCEfQaNGGa6LYR9FuFj32LEPoNeDLPNmDIea4NuDLPtmDIea4N+DCvozTsLGjLMdmQIiwtaMsz0XeL7Mhb0ZJhtvBBPtgPtmYYKYRZBs4WZlkq8i8iCdgszTRXisIdruJizMW9Ne22efrdnZD5+XK3WP1aP7sgM735k4cfP/mzMhx8rVTWqj37+1KP6s2c9m1p+z7aSlre0f2r7R2VT81dlEnvXfa41pMeFWBZkC8dnJSFW5oapHIz7P3cw3AnD3X3hYEt3v5L9rMBBUgCsPLKbmd7NOKlzSmr/xTAwRAEWR1cKo5z+G76AXwrAn8sJ/u5bunAECUcoqBHcjyUAtUI+5pbS/dXbmXAcdxMOh1eTl3A1OSWIPUMO1Z8BPkkuoT54BriyMaNxLGi+JSM40LxOeHHzFBRkEVVNwXDAA76eAVewh1vVzqp1fidWxH7fAEoLjKnq+EmjCn/iAXoG1KULD8MRPm8vmE9SrpyX/eR328PudjA/JAo45SjnepVXaARkDHDeLhZJP30VSIeWzOFY7n1u/XDApwNZoAz9t6qAjUFvFsNlc7ErGCEWFnLo1JQvhV82hHEJSUKZUOR3D6AQMLblw3UMxghiK/TqjApL9ndpQIqCXAWO97p5Yy8Em1zZ69F/oREuSgEXZWRCVzQXCdKEXQaVbJxZ6o4ZMYz9HVhgpdCn3FSqoWZQNvZnYeEsqDiWQTb7zpWeS9RgDm5BpUuoZISxw3SvWoIyAD0VLmmUpJmq/++RNCUVvWEs3vXH/GG2gJ5RUNnCvOMGGRYVmdBqwzfjgLWDZuOqBDk0wX4M/010aHpQbE66g/+6KeSsoNGOcn5DnBWVvJCrWL6ve/t2CJhggblKV2oVpM/o09mAG5hHRrG4H5OGU4UhwznIkH1QF8Jo/v1z077eTn8g/VEeA3VvX90FnB4Ev9wXuMPVX3EXEAbVqPMKX5XCatT9SBaMlqgYo1YZfdcGBuoaGpev4YRfJ+k/KSjreVJu1h73J6SOgkzJdT8V96UmKAy019wX1X5ZmOjKbGqW/lW7QBfAnCLJcMXdmAKEwOZbs7th+8qBD5Lg4BsnYCmAALXPQmUkC8E6x7+FEPoUyCSxJCZYyI7WgSotwbTDHw2DNgbdi1GR8xlH6oqsmkEQecbxsixGedZRfaGv+cOYALOmoGpZ+3t9cLKwdmFUsP4Slk3Qdp3FyojTUztTv41yJkLFBjz/YayI7WC1qBubkDfuDVNAS1R2g7HRjGCda3M+/bP+r/nfJizCSnK0HI9mxTHSRIsEYO0FrTk/TmyIDES2gsokeogwfOszD/1eaAy8eQszroC5mo2hRmcNDLakKqsvDV5xqjMDV/xlu/sDO4egIjRMbP47+XBtwASrwmcJqnyLfaseDgY8rfJVsaTia/f+RxDdgTS585SpvVP3tXBYGcJujqTK8j0qJ+E+N/feSC3E/hnlBCrKwfQ48FR9FLAvq6j+mGFzb0KCvCCCSxdbClJa945qECXAnpDH0igPBAc/zQYTPMwjOZVH/C9mQvEBflcGsEh4FXAFkbXVlMXjEOtZcS6DlTSn3FozqfRpXpQBWMmuTgbx3Ou6gbzAJnmsEyEgu//iJ24KTSd98E1QUO2gfYNb7cw7qN+0MXLXNvgNThgh4diMtOLhr2jCMWDRmtPqcGPszc/6QTOEhUFOujvegqd1mpEH43JoWhn924pgUgALVlIuc1CpCDk8bA5HHA1Vm4f953aLLSCpr+65L2rjiZhJT0NFHGTfn75gf6d2+bDu618kAG0e1tvUpiX+BgA4CnC+mlz08yVoXMHOGaMS+DEoOEX6Wh+3p9v2cMBdY7IA8KUkHGDY2iqpKAGTZv9DYbC+hjtPMvVFchHgk07IwpkG+dzHfukbmfi0Q7mfI4AlB8CufCKRvpApqVgC39UCRwP5rKZ4Q64cJUGLXPmY6vcDjHfC+U/IOvjUNIMoO702pwY1bTiVpvBOxfKeP/8tyFb6eySEx6IdCuTHFQa58wOlxRmXUYkP/5yJxbZG52c0Yg1iraD0iUMF7FnwofF2DyFgezJS+8O0mPsVizxJK4FTqrzYfr61T80peAgBY39MJKCJ16CdVFOWw8GqDffaBfn0pg7Z/gn3Z8hSOPLwxg4w6I7DsFtGakI2GCJ0SbhtKyOrjkYw7xFDa0a2pHnIFuz3QB1TUmXIa3vDzbWKhAO2MWhkUlEeTq17myuUET4go2R0r2KDkRGk4cqXkOSGA/1wOSzU4DOdnGrFBD8/Dvnhvi6nErJ/mwjM/7DCzKjA638wF+ZEKHGkbHeM4NdgQAiG0vpzEn7tpM8HZGOA+sEvqBUwrVp6rVCBrm0u5wN+4l6TxQIID45vEFqAk3FySd1balGFQu6gcgSKX28LbRhk3Ejr1Q9gf6wJtgVgJ5A0fvdeJWg9gK+mChr3fiTIBsvHjNIKeuMO5IYbq4yyvMvupTmidhfsdlH+eWnw4YYy5fnQBTeqarDp4rEeDQhEl2APzcBpihX5KOJyPb8iRMpu4CbCvU4bYgHtkU8JwTsxwVLCqOHcq6LW9Bo+v6bWFEbo6wsCHN3gg00pyqV+kwqazn5fNvFAKlZBKYn2yPoltepwy3l9wbvr0QfTeA8EftwWxl249ILS2vWM00NiAemXB6Tz6/mPJmw4A7sRbiXJM0n6F6uQ6cDnVCM8GBJO2qnGZwkqwOJEx6nyC614cKpPn6MHSY5C6l97DcoQMM3Y8RoIe8OsfLxjjdVjX8AOnRrs+8hdnvvVfxBBQOLgvv/FIwcvYPB6U3HhfMObG7IjAmTu3l8HgzrcYmdU6oq+eg6Ogp6OU+bl3zwAqnp08iDS9oXF+eCtnrDuALmpHsd3byWFzCBx1PQSaObYiSx4AodK4V/3+FQYp3ZB0D6HBx+qlFbK9/MNQU0W5p/Wq9f9a3PQz9g/fPz08+f/A849O3UroAAA"; \ No newline at end of file diff --git a/docs/classes/Core.Client.html b/docs/classes/Core.Client.html index 86f3f24..599099a 100644 --- a/docs/classes/Core.Client.html +++ b/docs/classes/Core.Client.html @@ -1,4 +1,4 @@ -Client | AIGE

Class Client

Constructors

constructor +Client | AIGE

Class Client

Constructors

constructor

Properties

client contextWindow game @@ -7,4 +7,4 @@ tokens

Methods

call image -

Constructors

constructor

Properties

client

client: OpenAI

contextWindow

contextWindow: number

game

game: Game

imageModel

imageModel: string

model

model: string

tokens

tokens: number = 0

Methods

call

  • call(tool, parameters): Promise<any>

  • Parameters

    Returns Promise<any>

image

  • image(prompt, options?): Promise<undefined | Image>

  • Parameters

    Returns Promise<undefined | Image>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

client

client: OpenAI

contextWindow

contextWindow: number

game

game: Game

imageModel

imageModel: string

model

model: string

tokens

tokens: number = 0

Methods

call

  • call(tool, parameters): Promise<any>

  • Parameters

    Returns Promise<any>

image

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/Core.Game.html b/docs/classes/Core.Game.html index 83a4c67..96559ff 100644 --- a/docs/classes/Core.Game.html +++ b/docs/classes/Core.Game.html @@ -2,7 +2,7 @@ This is the class that you will use to create a game.

Example

const game = new Game({
 universe: 'Cyberpunk',
 playerName: 'Punk',
 playerClass: 'Hacker'
})
-

Constructors

constructor +

Constructors

constructor

Properties

chats client data @@ -24,22 +24,22 @@ on resolvePath set -

Constructors

constructor

Properties

chats

chats: Chat[] = []

client

client: Client

data

data: GameData = ...

events

events: EventEmitter = ...

history

history: (ChatCompletionUserMessageParam | ChatCompletionMessage)[] = []

id

id: string = ...

options

options: GameOptions

Accessors

level

  • get level(): number

  • Calculate the player's level based on their experience

    -

    Returns number

overburdened

  • get overburdened(): boolean

  • Determine if the player is overburdened

    -

    Returns boolean

weightCarried

  • get weightCarried(): number

  • Calculate the player's weight carried

    -

    Returns number

Methods

action

  • action(action): Promise<Game>

  • Commit an action on the game

    +

Constructors

constructor

Properties

chats

chats: Chat[] = []

client

client: Client

data

data: GameData = ...

events

events: EventEmitter = ...

history

history: (ChatCompletionUserMessageParam | ChatCompletionMessage)[] = []

id

id: string = ...

options

options: GameOptions

Accessors

level

overburdened

weightCarried

Methods

action

chat

Returns Promise<Game>

chat

export

images

export

images

import

init

inspect

off

on

resolvePath

set

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Parameters

Returns Promise<any>

import

init

inspect

off

on

resolvePath

set

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/enums/Core.GameEvent.html b/docs/enums/Core.GameEvent.html index 3898674..dba34df 100644 --- a/docs/enums/Core.GameEvent.html +++ b/docs/enums/Core.GameEvent.html @@ -1,4 +1,4 @@ -GameEvent | AIGE

Enumeration GameEvent

Enumeration Members

ability_added +GameEvent | AIGE

Enumeration GameEvent

Enumeration Members

ability_added ability_removed action armor_destroyed @@ -15,4 +15,4 @@ loss quest_added quest_removed -

Enumeration Members

ability_added

ability_added: "ability_added"

ability_removed

ability_removed: "ability_removed"

action

action: "action"

armor_destroyed

armor_destroyed: "armor_destroyed"

character_added

character_added: "character_added"

character_removed

character_removed: "character_removed"

chat

chat: "chat"

death

death: "death"

financial_ruin

financial_ruin: "financial_ruin"

gain

gain: "gain"

images_created

images_created: "images_created"

import

import: "import"

inventory_added

inventory_added: "inventory_added"

inventory_removed

inventory_removed: "inventory_removed"

loss

loss: "loss"

quest_added

quest_added: "quest_added"

quest_removed

quest_removed: "quest_removed"

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Enumeration Members

ability_added

ability_added: "ability_added"

ability_removed

ability_removed: "ability_removed"

action

action: "action"

armor_destroyed

armor_destroyed: "armor_destroyed"

character_added

character_added: "character_added"

character_removed

character_removed: "character_removed"

chat

chat: "chat"

death

death: "death"

financial_ruin

financial_ruin: "financial_ruin"

gain

gain: "gain"

images_created

images_created: "images_created"

import

import: "import"

inventory_added

inventory_added: "inventory_added"

inventory_removed

inventory_removed: "inventory_removed"

loss

loss: "loss"

quest_added

quest_added: "quest_added"

quest_removed

quest_removed: "quest_removed"

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/functions/tools.call.html b/docs/functions/tools.call.html index f0bb66f..963764f 100644 --- a/docs/functions/tools.call.html +++ b/docs/functions/tools.call.html @@ -1 +1 @@ -call | AIGE

Function call

  • call(client, tool): ((parameters) => Promise<any>)

  • Parameters

    Returns ((parameters) => Promise<any>)

      • (parameters): Promise<any>

      • Parameters

        • parameters: any

        Returns Promise<any>

Settings

Member Visibility

Theme

\ No newline at end of file +call | AIGE

Function call

  • call(client, tool): ((parameters) => Promise<any>)

  • Parameters

    Returns ((parameters) => Promise<any>)

      • (parameters): Promise<any>

      • Parameters

        • parameters: any

        Returns Promise<any>

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index cafb799..9ea928b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -9,9 +9,9 @@

NPM

View Docs Made with TypeScript

-

Version +

Version CircleCI -Last Commit +Last Commit Open issues Closed issues

Sponsors @@ -34,6 +34,9 @@

  • 🧰 Track stats, scene, inventory, characters, abilities, quests, and more
  • 🤖 Powered by OpenAI API (planned support for additional LLMs)
    • +
    +

    asciicast

    +

    Table of Contents

    -

    The default models are gpt-3.5-turbo-1106 and dall-e-2. You can change the models in the GameClientOptions to use other models. Creating a game and performing an action uses ~2000-3000 tokens.

    +

    The default models are gpt-3.5-turbo-1106 and dall-e-2. You can change the models in the GameClientOptions to use other models. Creating a game and performing an action uses ~2000-3000 tokens.

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.Ability.html b/docs/interfaces/Core.Ability.html index e457bed..7902320 100644 --- a/docs/interfaces/Core.Ability.html +++ b/docs/interfaces/Core.Ability.html @@ -1,4 +1,4 @@ -Ability | AIGE

    Interface Ability

    interface Ability {
        description: string;
        emoji: string;
        name: string;
    }

    Properties

    description +Ability | AIGE

    Interface Ability

    interface Ability {
        description: string;
        emoji: string;
        name: string;
    }

    Properties

    description emoji name -

    Properties

    description

    description: string

    emoji

    emoji: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    description

    description: string

    emoji

    emoji: string

    name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.Character.html b/docs/interfaces/Core.Character.html index c106d8d..eb83711 100644 --- a/docs/interfaces/Core.Character.html +++ b/docs/interfaces/Core.Character.html @@ -1,4 +1,4 @@ -Character | AIGE

    Interface Character

    interface Character {
        abilities: Ability[];
        alive: boolean;
        appearance: string;
        armor: number;
        description: string;
        emoji: string;
        health: number;
        health_description: string;
        hostile: boolean;
        inventory: InventoryItem[];
        money: number;
        name: string;
        reputation: number;
        reputation_description: string;
    }

    Properties

    abilities +Character | AIGE

    Interface Character

    interface Character {
        abilities: Ability[];
        alive: boolean;
        appearance: string;
        armor: number;
        description: string;
        emoji: string;
        health: number;
        health_description: string;
        hostile: boolean;
        inventory: InventoryItem[];
        money: number;
        name: string;
        reputation: number;
        reputation_description: string;
    }

    Properties

    abilities alive appearance armor @@ -12,4 +12,4 @@ name reputation reputation_description -

    Properties

    abilities

    abilities: Ability[]

    alive

    alive: boolean

    appearance

    appearance: string

    armor

    armor: number

    description

    description: string

    emoji

    emoji: string

    health

    health: number

    health_description

    health_description: string

    hostile

    hostile: boolean

    inventory

    inventory: InventoryItem[]

    money

    money: number

    name

    name: string

    reputation

    reputation: number

    reputation_description

    reputation_description: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    abilities

    abilities: Ability[]

    alive

    alive: boolean

    appearance

    appearance: string

    armor

    armor: number

    description

    description: string

    emoji

    emoji: string

    health

    health: number

    health_description

    health_description: string

    hostile

    hostile: boolean

    inventory

    inventory: InventoryItem[]

    money

    money: number

    name

    name: string

    reputation

    reputation: number

    reputation_description

    reputation_description: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.Chat.html b/docs/interfaces/Core.Chat.html index be2b2f8..a279065 100644 --- a/docs/interfaces/Core.Chat.html +++ b/docs/interfaces/Core.Chat.html @@ -1,3 +1,3 @@ -Chat | AIGE

    Interface Chat

    interface Chat {
        character_name: string;
        messages: [ChatMessage];
    }

    Properties

    character_name +Chat | AIGE

    Interface Chat

    interface Chat {
        character_name: string;
        messages: [ChatMessage];
    }

    Properties

    character_name messages -

    Properties

    character_name

    character_name: string

    messages

    messages: [ChatMessage]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    character_name

    character_name: string

    messages

    messages: [ChatMessage]

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.ChatMessage.html b/docs/interfaces/Core.ChatMessage.html index 53dfe4e..1317b36 100644 --- a/docs/interfaces/Core.ChatMessage.html +++ b/docs/interfaces/Core.ChatMessage.html @@ -1,4 +1,4 @@ -ChatMessage | AIGE

    Interface ChatMessage

    interface ChatMessage {
        content: string;
        from_player: boolean;
        timestamp: string;
    }

    Properties

    content +ChatMessage | AIGE

    Interface ChatMessage

    interface ChatMessage {
        content: string;
        from_player: boolean;
        timestamp: string;
    }

    Properties

    content from_player timestamp -

    Properties

    content

    content: string

    from_player

    from_player: boolean

    timestamp

    timestamp: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    content

    content: string

    from_player

    from_player: boolean

    timestamp

    timestamp: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.GameClientImageOptions.html b/docs/interfaces/Core.GameClientImageOptions.html index 3cdca9e..45c9cc3 100644 --- a/docs/interfaces/Core.GameClientImageOptions.html +++ b/docs/interfaces/Core.GameClientImageOptions.html @@ -1,5 +1,7 @@ -GameClientImageOptions | AIGE

    Interface GameClientImageOptions

    interface GameClientImageOptions {
        model?: string;
        response_format?: string;
        size?: string;
        style?: string;
    }

    Properties

    model? +GameClientImageOptions | AIGE

    Interface GameClientImageOptions

    interface GameClientImageOptions {
        model?: string;
        quality?: string;
        response_format?: string;
        size?: string;
        style?: string;
        user?: string;
    }

    Properties

    model? +quality? response_format? size? style? -

    Properties

    Optional model

    model?: string

    Optional response_format

    response_format?: string

    Optional size

    size?: string

    Optional style

    style?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +user? +

    Properties

    Optional model

    model?: string

    Optional quality

    quality?: string

    Optional response_format

    response_format?: string

    Optional size

    size?: string

    Optional style

    style?: string

    Optional user

    user?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.GameClientOptions.html b/docs/interfaces/Core.GameClientOptions.html index 2e89ad2..0350949 100644 --- a/docs/interfaces/Core.GameClientOptions.html +++ b/docs/interfaces/Core.GameClientOptions.html @@ -1,5 +1,5 @@ -GameClientOptions | AIGE

    Interface GameClientOptions

    interface GameClientOptions {
        clientOptions?: ClientOptions;
        contextWindow?: number;
        imageModel?: string;
        model?: string;
    }

    Properties

    clientOptions? +GameClientOptions | AIGE

    Interface GameClientOptions

    interface GameClientOptions {
        clientOptions?: ClientOptions;
        contextWindow?: number;
        imageModel?: string;
        model?: string;
    }

    Properties

    clientOptions? contextWindow? imageModel? model? -

    Properties

    Optional clientOptions

    clientOptions?: ClientOptions

    Optional contextWindow

    contextWindow?: number

    Optional imageModel

    imageModel?: string

    Optional model

    model?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional clientOptions

    clientOptions?: ClientOptions

    Optional contextWindow

    contextWindow?: number

    Optional imageModel

    imageModel?: string

    Optional model

    model?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.GameData.html b/docs/interfaces/Core.GameData.html index 0180745..d574c15 100644 --- a/docs/interfaces/Core.GameData.html +++ b/docs/interfaces/Core.GameData.html @@ -1,5 +1,5 @@ GameData | AIGE

    Interface GameData

    The data of a game

    -
    interface GameData {
        abilities?: Ability[];
        actions?: string[];
        appearance?: string;
        armor: number;
        characters?: Character[];
        chats?: Chat[];
        experience: number;
        health: number;
        health_description: string;
        inventory?: InventoryItem[];
        location?: string;
        location_description?: string;
        money: number;
        money_name: string;
        quests?: Quest[];
        reputation: number;
        reputation_description: string;
        rumor?: string;
        scene?: string;
        scene_emoji?: string;
        weather?: string;
        weather_description?: string;
        weight_capacity: number;
        weight_unit: string;
        [key: string]: any;
    }

    Indexable

    [key: string]: any

    Properties

    abilities? +
    interface GameData {
        abilities?: Ability[];
        actions?: string[];
        appearance?: string;
        armor: number;
        characters?: Character[];
        chats?: Chat[];
        experience: number;
        health: number;
        health_description: string;
        inventory?: InventoryItem[];
        location?: string;
        location_description?: string;
        money: number;
        money_name: string;
        quests?: Quest[];
        reputation: number;
        reputation_description: string;
        rumor?: string;
        scene?: string;
        scene_emoji?: string;
        weather?: string;
        weather_description?: string;
        weight_capacity: number;
        weight_unit: string;
        [key: string]: any;
    }

    Indexable

    [key: string]: any

    Properties

    abilities? actions? appearance? armor @@ -23,4 +23,4 @@ weather_description? weight_capacity weight_unit -

    Properties

    Optional abilities

    abilities?: Ability[]

    Optional actions

    actions?: string[]

    Optional appearance

    appearance?: string

    armor

    armor: number

    Optional characters

    characters?: Character[]

    Optional chats

    chats?: Chat[]

    experience

    experience: number

    health

    health: number

    health_description

    health_description: string

    Optional inventory

    inventory?: InventoryItem[]

    Optional location

    location?: string

    Optional location_description

    location_description?: string

    money

    money: number

    money_name

    money_name: string

    Optional quests

    quests?: Quest[]

    reputation

    reputation: number

    reputation_description

    reputation_description: string

    Optional rumor

    rumor?: string

    Optional scene

    scene?: string

    Optional scene_emoji

    scene_emoji?: string

    Optional weather

    weather?: string

    Optional weather_description

    weather_description?: string

    weight_capacity

    weight_capacity: number

    weight_unit

    weight_unit: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional abilities

    abilities?: Ability[]

    Optional actions

    actions?: string[]

    Optional appearance

    appearance?: string

    armor

    armor: number

    Optional characters

    characters?: Character[]

    Optional chats

    chats?: Chat[]

    experience

    experience: number

    health

    health: number

    health_description

    health_description: string

    Optional inventory

    inventory?: InventoryItem[]

    Optional location

    location?: string

    Optional location_description

    location_description?: string

    money

    money: number

    money_name

    money_name: string

    Optional quests

    quests?: Quest[]

    reputation

    reputation: number

    reputation_description

    reputation_description: string

    Optional rumor

    rumor?: string

    Optional scene

    scene?: string

    Optional scene_emoji

    scene_emoji?: string

    Optional weather

    weather?: string

    Optional weather_description

    weather_description?: string

    weight_capacity

    weight_capacity: number

    weight_unit

    weight_unit: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.GameOptions.html b/docs/interfaces/Core.GameOptions.html index 13b0b62..3aaf7d1 100644 --- a/docs/interfaces/Core.GameOptions.html +++ b/docs/interfaces/Core.GameOptions.html @@ -1,8 +1,8 @@ GameOptions | AIGE

    Interface GameOptions

    The options of a game

    -
    interface GameOptions {
        clientOptions?: GameClientOptions;
        language?: string;
        playerClass?: string;
        playerName?: string;
        prompts?: {
            class?: string;
            create?: string;
            name?: string;
            quest?: string;
            summarize?: string;
        };
        universe?: string;
        [key: string]: any;
    }

    Indexable

    [key: string]: any

    Properties

    clientOptions? +
    interface GameOptions {
        clientOptions?: GameClientOptions;
        language?: string;
        playerClass?: string;
        playerName?: string;
        prompts?: {
            class?: string;
            create?: string;
            name?: string;
            quest?: string;
            summarize?: string;
        };
        universe?: string;
        [key: string]: any;
    }

    Indexable

    [key: string]: any

    Properties

    clientOptions? language? playerClass? playerName? prompts? universe? -

    Properties

    Optional clientOptions

    clientOptions?: GameClientOptions

    Optional language

    language?: string

    Optional playerClass

    playerClass?: string

    Optional playerName

    playerName?: string

    Optional prompts

    prompts?: {
        class?: string;
        create?: string;
        name?: string;
        quest?: string;
        summarize?: string;
    }

    Type declaration

    • Optional class?: string
    • Optional create?: string
    • Optional name?: string
    • Optional quest?: string
    • Optional summarize?: string

    Optional universe

    universe?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    Optional clientOptions

    clientOptions?: GameClientOptions

    Optional language

    language?: string

    Optional playerClass

    playerClass?: string

    Optional playerName

    playerName?: string

    Optional prompts

    prompts?: {
        class?: string;
        create?: string;
        name?: string;
        quest?: string;
        summarize?: string;
    }

    Type declaration

    • Optional class?: string
    • Optional create?: string
    • Optional name?: string
    • Optional quest?: string
    • Optional summarize?: string

    Optional universe

    universe?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.InventoryItem.html b/docs/interfaces/Core.InventoryItem.html index a3e5800..7b3dd31 100644 --- a/docs/interfaces/Core.InventoryItem.html +++ b/docs/interfaces/Core.InventoryItem.html @@ -1,4 +1,4 @@ -InventoryItem | AIGE

    Interface InventoryItem

    interface InventoryItem {
        consumable: boolean;
        description: string;
        emoji: string;
        name: string;
        rarity: number;
        type: string;
        value: number;
        weight: number;
    }

    Properties

    consumable +InventoryItem | AIGE

    Interface InventoryItem

    interface InventoryItem {
        consumable: boolean;
        description: string;
        emoji: string;
        name: string;
        rarity: number;
        type: string;
        value: number;
        weight: number;
    }

    Properties

    consumable description emoji name @@ -6,4 +6,4 @@ type value weight -

    Properties

    consumable

    consumable: boolean

    description

    description: string

    emoji

    emoji: string

    name

    name: string

    rarity

    rarity: number

    type

    type: string

    value

    value: number

    weight

    weight: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    consumable

    consumable: boolean

    description

    description: string

    emoji

    emoji: string

    name

    name: string

    rarity

    rarity: number

    type

    type: string

    value

    value: number

    weight

    weight: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/Core.Quest.html b/docs/interfaces/Core.Quest.html index 722fa9a..6c89261 100644 --- a/docs/interfaces/Core.Quest.html +++ b/docs/interfaces/Core.Quest.html @@ -1,6 +1,6 @@ -Quest | AIGE

    Interface Quest

    interface Quest {
        completed: boolean;
        description: string;
        emoji: string;
        name: string;
        reward: {
            experience: number;
            inventory: InventoryItem[];
            money: number;
            reputation: number;
        };
    }

    Properties

    completed +Quest | AIGE

    Interface Quest

    interface Quest {
        completed: boolean;
        description: string;
        emoji: string;
        name: string;
        reward: {
            experience: number;
            inventory: InventoryItem[];
            money: number;
            reputation: number;
        };
    }

    Properties

    completed description emoji name reward -

    Properties

    completed

    completed: boolean

    description

    description: string

    emoji

    emoji: string

    name

    name: string

    reward

    reward: {
        experience: number;
        inventory: InventoryItem[];
        money: number;
        reputation: number;
    }

    Type declaration

    • experience: number
    • inventory: InventoryItem[]
    • money: number
    • reputation: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    completed

    completed: boolean

    description

    description: string

    emoji

    emoji: string

    name

    name: string

    reward

    reward: {
        experience: number;
        inventory: InventoryItem[];
        money: number;
        reputation: number;
    }

    Type declaration

    • experience: number
    • inventory: InventoryItem[]
    • money: number
    • reputation: number

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/tools.Tool.html b/docs/interfaces/tools.Tool.html index d613cec..e294446 100644 --- a/docs/interfaces/tools.Tool.html +++ b/docs/interfaces/tools.Tool.html @@ -1,3 +1,3 @@ -Tool | AIGE

    Interface Tool

    interface Tool {
        execute: ((parameters) => any);
        schema: ChatCompletionTool;
    }

    Properties

    execute +Tool | AIGE

    Interface Tool

    interface Tool {
        execute: ((parameters) => any);
        schema: ChatCompletionTool;
    }

    Properties

    execute schema -

    Properties

    execute

    execute: ((parameters) => any)

    Type declaration

      • (parameters): any

      • Parameters

        • parameters: any

        Returns any

    schema

    schema: ChatCompletionTool

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    execute

    execute: ((parameters) => any)

    Type declaration

      • (parameters): any

      • Parameters

        • parameters: any

        Returns any

    schema

    schema: ChatCompletionTool

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/modules/Core.html b/docs/modules/Core.html index d1b707f..accbafe 100644 --- a/docs/modules/Core.html +++ b/docs/modules/Core.html @@ -1,5 +1,5 @@ Core | AIGE

    Module Core

    Description

    This is the main module of the library. It exports all the classes and interfaces needed to create a game.

    -

    References

    call +

    References

    call tools

    Enumerations

    GameEvent

    Classes

    Client diff --git a/docs/modules/tools.html b/docs/modules/tools.html index 7e1ee7d..40f7a71 100644 --- a/docs/modules/tools.html +++ b/docs/modules/tools.html @@ -1,4 +1,4 @@ -tools | AIGE

    Module tools

    Index

    Interfaces

    Tool +tools | AIGE

    Module tools

    Index

    Interfaces

    Tool

    Variables

    tools

    Functions

    call

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/tools.tools.html b/docs/variables/tools.tools.html index 4abc865..296b5fc 100644 --- a/docs/variables/tools.tools.html +++ b/docs/variables/tools.tools.html @@ -1 +1 @@ -tools | AIGE

    Variable toolsConst

    tools: {
        action: Tool;
        chat: Tool;
        class: Tool;
        create: Tool;
        inventory: Tool;
        name: Tool;
        reputation: Tool;
        summarize: Tool;
    } = ...

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +tools | AIGE

    Variable toolsConst

    tools: {
        action: Tool;
        chat: Tool;
        class: Tool;
        create: Tool;
        inventory: Tool;
        name: Tool;
        reputation: Tool;
        summarize: Tool;
    } = ...

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file