https://wiki.miniworldgame.com/ 2026-04-11T18:01:36+00:00 https://wiki.miniworldgame.com/ https://wiki.miniworldgame.com/lib/exe/fetch.php?media=wiki:favicon.ico text/html 2024-06-09T08:01:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:calcdistance&rev=1717920087&do=diff calcDistance * Parameters and types: * pos1: tablestarting coordinates * pos2: tableend coordinate * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * len: numberdistance value * The main purpose of this method: Calculate the distance between locations text/html 2024-07-01T18:33:36+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:despawnactor&rev=1719858816&do=diff despawnActor How to use World:despawnActor(objid) Where: * objid number: The id of the creature that will be despawned. And returns: * ErrorCode.Ok number: 0 if execution was succesful and 1001 if the execution failed. Use example When a bee spawns, it will be despawned after 10 seconds. text/html 2024-07-01T18:37:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:despawncreature&rev=1719859044&do=diff despawnCreature This method functions identically to despawnActor How to use World:despawnCreature(objid) Where: * objid number: The id of the creature that will be despawned. And returns: * ErrorCode.Ok number: 0 if execution was succesful and 1001 if the execution failed. text/html 2024-06-08T14:11:39+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:despawnitembybox&rev=1717855899&do=diff despawnItemByBox * Parameters & Types: * x1, y1, z1: the starting coordinates of number * x2, y2, z2: number end coordinates * Return value and type: * code: number succeeded (ErrorCode.OK) ErrorCode * The main purpose of this method is to remove all items in the area text/html 2024-06-09T07:51:55+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:despawnitembyobjid&rev=1717919515&do=diff despawnItemByObjid * Parameters and types: * objid: numberobject objID * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main purpose of this method: Remove props (by ID) * The specific use cases are as follows: text/html 2024-06-04T04:05:11+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getactorsbybox&rev=1717473911&do=diff getActorsByBox ---------- * Parameters and types: * objtype: numberbiological type (OBJ_TYPE, 0 means all objects) OBJ_TYPE * x1,y1,z1: numberstarting coordinates * x2,y2,z2: numberend coordinates * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode text/html 2024-06-04T04:16:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getallplayers&rev=1717474573&do=diff getAllPlayers ---------- * Parameters and types: * alive: numberplayer status (0 means dead, 1 means alive, default -1 means all players) * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * num: numberGet the number text/html 2024-06-01T05:20:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getcameraeditstate&rev=1717219225&do=diff getCameraEditState ---------- * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * state: numberstate value (CameraEditState) CameraEditState * The main function of this method is to obtain the perspective editing status text/html 2024-06-02T23:36:10+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getcustomcameraconfig&rev=1717371370&do=diff getCustomCameraConfig ---------- * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * config: tableCamera configuration * The main purpose of this method: Get custom camera configuration text/html 2024-06-09T08:12:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getdatefromtime&rev=1717920732&do=diff getDateFromTime * Parameters and types: * time: numbertimestamp * enum: numberenumeration value (EVENTDATE) EVENTDATE * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * ret: numbertime value * The main function of this method: Convert timestamp to time unit text/html 2024-06-09T08:07:51+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getdatestringfromtime&rev=1717920471&do=diff getDateStringFromTime * Parameters and types: * time: numbertimestamp * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * timestr: stringtime description * The main function of this method: Convert timestamp to completion time text/html 2024-05-28T03:51:31+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:gethours&rev=1716868291&do=diff For example: * Parameters & Types: not * Return value and type: * code:number succeeded (ErrorCode.OK) ErrorCode * hour: the number of the current hour * The main purpose of this method is: Get the current time of the game (h) * Specific use cases are as follows: text/html 2024-06-10T14:25:58+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getlightbypos&rev=1718029558&do=diff getLightByPos * Parameters and types: * x,y,z: numberposition * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * lv: numberlight intensity (0~16) * The main function of this method is to obtain the light intensity text/html 2024-06-09T09:33:30+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getlocaldate&rev=1717925610&do=diff getLocalDate * Parameters and types: * enum: numberenumeration value (EVENTDATE) * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * time: numberthe value obtained * The main function of this method is to obtain the host time text/html 2024-06-09T09:31:36+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getlocaldatestring&rev=1717925496&do=diff getLocalDateString * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * timestr: stringtime description * The main function of this method: Get the complete device time * The specific use cases are as follows: text/html 2024-06-04T04:13:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getplayertotal&rev=1717474425&do=diff getPlayerTotal ---------- * Parameters and types: * alive: numberplayer status (0 means dead, 1 means alive, default -1 means all players) * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * num: numberGet the number text/html 2024-06-04T03:51:10+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getrangexz&rev=1717473070&do=diff getRangeXZ ---------- * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * startX: numberstarting X coordinate * startZ: numberstarting Z coordinate * endX: numberEnd X coordinate * text/html 2024-06-04T04:05:00+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getrayblock&rev=1717473900&do=diff getRayBlock ---------- * Parameters and types: * srcx,srcy,srcz: numberstarting point * face: numberdirection enumeration (FACE_DIRECTION) FACE_DIRECTION * distance: numberthe longest detection distance * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode text/html 2024-06-09T09:29:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getserverdate&rev=1717925390&do=diff getServerDate * Parameters and types: * enum: numberenumeration value (EVENTDATE) * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * time: numberthe value obtained * The main function of this method: Get server time text/html 2024-06-09T09:27:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:getserverdatestring&rev=1717925232&do=diff getServerDateString * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * timestr: stringtime description * The main function of this method: Get the complete server time * The specific use cases are as follows: text/html 2024-06-01T05:10:16+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:iscreaterunmode&rev=1717218616&do=diff isCreateRunMode ---------- * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method: Switch from creative mode to survival mode * The specific use cases are as follows: text/html 2024-05-27T07:00:08+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:iscreativemode&rev=1716793208&do=diff For example: --Determine whether it is creative mode local result=World:isCreativeMode() --- Get the result for comparison if result==0 then--if it is creative mode Chat:sendSystemMsg("Currently in creative mode!") else--if it is not creative mode Chat:sendSystemMsg("Currently not in creative mode!") end text/html 2024-05-28T00:01:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:iscustomgame&rev=1716854509&do=diff For example: * Parameters and types: None * Return value and type: * code: number Success (ErrorCode.OK) ErrorCode * The main function of this method: Is it a custom game? * The specific use cases are as follows: --Determine whether it is a custom game text/html 2024-05-28T03:48:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:isdaytime&rev=1716868108&do=diff For example: * Parameters & Types: not * Return value and type: * code:number succeeded (ErrorCode.OK) ErrorCode * The main effect of the method: whether it is daytime or not * Specific use cases are as follows: - Determine whether it is daytime now text/html 2024-05-27T13:49:02+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:isextremitymode&rev=1716817742&do=diff For example: --Judge whether it is extreme mode local result=World:isExtremityMode() if result==0 then--if it is extreme mode Chat:sendSystemMsg("Currently in extreme mode!") else--if it is not extreme mode Chat:sendSystemMsg("This is not the extreme mode!") end text/html 2024-05-27T13:54:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:isfreemode&rev=1716818041&do=diff For example: --Determine whether it is an adventure free mode local result=World:isFreeMode() if result==0 then--if it is adventure free mode Chat:sendSystemMsg("Currently in adventure free mode!") else--if not Chat:sendSystemMsg("This is not the adventure free mode!") end text/html 2024-06-01T05:12:04+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:isgamemakermode&rev=1717218724&do=diff isGameMakerMode ---------- * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method: Editing mode of self-made gameplay * The specific use cases are as follows: text/html 2024-05-27T13:44:00+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:isgodmode&rev=1716817440&do=diff For example: --Determine whether it is multiplayer creative mode or gameplay editing mode local result=World:isGodMode() if result==0 then--If it is multi-person creation or gameplay editing Chat:sendSystemMsg("Currently in multiplayer creation or gameplay editing mode!") else--if not Chat:sendSystemMsg("Currently not in multiplayer creation or gameplay editing mode!") end text/html 2024-06-01T05:08:01+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:issurvivemode&rev=1717218481&do=diff isSurviveMode ---------- * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method: Single-player mode or free mode of adventure mode * The specific use cases are as follows: text/html 2024-06-09T08:04:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:playparticleeffect&rev=1717920285&do=diff playParticalEffect * Parameters and types: * x,y,z: numberposition * particleId: numberspecial effect id * scale: numberSpecial effect size * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method: Play special effects at the specified position text/html 2024-06-10T14:21:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:playsoundeffectonpos&rev=1718029313&do=diff playSoundEffectOnPos * Parameters and types: * pos: tableposition * soundId: numbersound effect ID * volume: numbervolume adjustment * Pitch: numberPitch adjustment * isLoop: boolWhether to play in a loop * Return value and type: text/html 2024-06-04T04:18:56+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:randomoneplayer&rev=1717474736&do=diff randomOnePlayer ---------- * Parameters and types: * alive: numberplayer status (0 means dead, 1 means alive, default -1 means all players) * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * playerid: numberplayerUin text/html 2024-06-10T14:20:08+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:randomparticleeffectid&rev=1718029208&do=diff randomParticleEffectID * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * particleId: numberspecial effect id * The main function of this method: Random special effect type, randomly return a special effect ID text/html 2024-06-09T09:37:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:randomsoundid&rev=1717925847&do=diff randomSoundID * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * soundid: numbersound ID * The main function of this method is to: Randomly generate a sound effect ID * The specific use cases are as follows: text/html 2024-06-09T09:35:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:randomweatherid&rev=1717925707&do=diff randomWeatherID * Parameters and types: None * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * wtype: numberweather value (WEATHERSTATUS) WEATHERSTATUS * The main function of this method: Randomly generate a weather ID text/html 2024-06-10T14:27:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:setblocklightex&rev=1718029668&do=diff setBlockLightEx * Parameters and types: * x,y,z: numberposition * lv: numberlight intensity (0~16) * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method: Set the light intensity * text/html 2024-06-01T07:05:24+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:setcameraeditstate&rev=1717225524&do=diff setCameraEditState ---------- * Parameters and types: * state: numberstate value (CameraEditState) * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method: Set the perspective editing state text/html 2024-06-10T14:15:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:seteffectscaleonposition&rev=1718028918&do=diff setEffectScaleOnPosition * Parameters and types: * x,y,z: numberposition * particleId: numberspecial effect id * scale: numberSpecial effect size * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method is to set the size of the special effect at the specified position text/html 2024-06-10T12:56:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:sethours&rev=1718024203&do=diff For example: -- Set the time to 8 o'clock World:setHours(8) --Display in chat box Chat:sendSystemMsg("The time is set to 8 o'clock!") ---------- If you have any questions about Developer Tools, feel free to join our official discord server text/html 2024-06-16T13:48:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:setskyboxattr&rev=1718545707&do=diff SetSkyBoxAttr * Parameters & Types: * time: number of game hours * itype: number parameter type (SKYBOXATTR) SKYBOXATTR * value: number parameter value (0~100) * Return value and type: * code:number succeeded (ErrorCode.OK) ErrorCode text/html 2024-06-16T13:47:00+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:setskyboxcolor&rev=1718545620&do=diff SetSkyBoxColor * Parameters & Types: * time: number of game hours * itype:number, color attribute enumeration (SKYBOXCOLOR), SKYBOXCOLOR * color:string16decimal color value (0xffffff) * Return value and type: * code:number succeeded (ErrorCode.OK) ErrorCode text/html 2024-06-16T13:49:49+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:setskyboxfilter&rev=1718545789&do=diff SetSkyBoxFilter * Parameters & Types: * itype: number parameter type (SKYBOXFILTER) SKYBOXFILTER * value:number: parameter value (0~100) or string: hexadecimal color value (0xffffff) * Return value and type: * code:number succeeded (ErrorCode.OK) ErrorCode text/html 2024-06-16T13:45:21+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:setskyboxmaps&rev=1718545521&do=diff SetSkyBoxMaps * Parameters & Types: * time: number of game hours * itype: number map type (SKYBOXMAP) SKYBOXMAP * url:string image link * Return value and type: * code:number succeeded (ErrorCode.OK) ErrorCode * The main purpose of this method: Set the skybox map text/html 2024-06-16T13:43:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:setskyboxtemplate&rev=1718545408&do=diff SetSkyBoxTemplate * Parameters & Types: * value: the value of the number parameter (0-9) * Return value and type: * code:number succeeded (ErrorCode.OK) ErrorCode * The main purpose of this method: Set up the skybox template * Specific use cases are as follows: text/html 2024-06-10T14:34:10+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:settimevanishingspeed&rev=1718030050&do=diff SetTimeVanishingSpeed * Parameters & Types: * speed: number skybox time * Return value and type: * code:number succeeded (ErrorCode.OK) ErrorCode * The main purpose of this method: Set the skybox time lapse velocity * Specific use cases are as follows: text/html 2024-09-29T06:41:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:spawncreature&rev=1727592075&do=diff World:spawnCreature World:spawnCreature(x,y,z,creatureid,quantity) How to use Where: * x number: The x coordinate where the creature will be spawned. * y number: The y coordinate where the creature will be spawned. * z number: The z coordinate where the creature will be spawned. text/html 2024-07-01T19:03:52+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:spawnitem&rev=1719860632&do=diff spawnItem How to use World:spawnItem(x,y,z,blockid,quantity) Where: * x number: The x coordinate where the item will spawn. * y number: The y coordinate where the item will spawn. * z number: The z coordinate where the item will spawn. * text/html 2024-06-09T07:55:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:spawnprojectile&rev=1717919747&do=diff spawnProjectile * Parameters and types: * shooter: numberSet the objid to which the thrown object belongs * itemid: numberthrowable id * x,y,z: numberstarting point of the thrown object * dstx, dsty, dstz: numberdestination of the thrown object text/html 2024-06-09T07:58:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:spawnprojectilebydir&rev=1717919909&do=diff spawnProjectileByDir * Parameters and types: * shooter: numberSet the objid to which the thrown object belongs * itemid: numberthrowable id * x,y,z: numberstarting point of the thrown object * dstx, dsty, dstz: numberthrowing direction text/html 2024-06-10T14:11:57+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:stopeffectonposition&rev=1718028717&do=diff stopEffectOnPosition * Parameters and types: * x,y,z: numberposition * particleId: numberspecial effect id * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method: Stop the special effects at the specified position text/html 2024-06-10T14:24:15+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.miniworldgame.com/doku.php?id=script:world_event:stopsoundeffectonpos&rev=1718029455&do=diff stopSoundEffectOnPos * Parameters and types: * pos: tableposition * soundId: numbersound effect ID * Return value and type: * code: numberSuccess (ErrorCode.OK) ErrorCode * The main function of this method is to stop the specified sound effect at the specified position.