UScript for Unturned uScript2 Official Documentation: Difference between revisions

From Free Knowledge Base- The DUCK Project
Jump to navigation Jump to search
Created page with "This is a duplication of what is available on the uScript discord server. Download the latest (uScript_v2.0.5_Documentation.zip at the time of this writing) from Discord...."
 
mNo edit summary
Line 1: Line 1:
This is a duplication of what is available on the [[uScript]] discord server.  Download the latest (uScript_v2.0.5_Documentation.zip at the time of this writing) from Discord.  [[uScript2]] was created by Ster.  Documentation last known release date:  — 4/28/23, 1:15 PM
This is a duplication of what is available on the [[uScript]] discord server.  Download the latest (uScript_v2.0.5_Documentation.zip at the time of this writing) from Discord.  [[uScript2]] was created by Ster.  Documentation last known release date:  — 4/28/23, 1:15 PM
<nowiki>Event: onAccuracyUpdated(player)</nowiki>
<nowiki>Event: onAid(player, target, item, *cancel)</nowiki>
<nowiki>Event: onAnimalKilled(player)</nowiki>
<nowiki>Event: onArenaWin(player)</nowiki>
<nowiki>Event: onBarricadeBuild(player, id, position, *cancel)</nowiki>
<nowiki>Event: onBarricadeDestroy(player, barricade, *cancel)</nowiki>
<nowiki>Event: onClothingUpdated(player, item, slot)</nowiki>
<nowiki>Event: onConsume(player, item, *cancel)</nowiki>
<nowiki>Event: onEffectButtonClicked(player, buttonName)</nowiki>
<nowiki>Event: onEffectTextCommitted(player, buttonName, text)</nowiki>
<nowiki>Event: onFishCaught(player)</nowiki>
<nowiki>Event: onHeadShot(player)</nowiki>
<nowiki>Event: onInterval(timeInSeconds) NOTE: You should replace timeInSeconds without the number of seconds you want between each interval</nowiki>
<nowiki>Event: onLoad()</nowiki>
<nowiki>Event: onMegaZombieKilled(player)</nowiki>
<nowiki>Event: onPlantHarvested(player)</nowiki>
<nowiki>Event: onPlayerChatted(player, message, mode, *color, *cancel)</nowiki>
<nowiki>Event: onPlayerCrafted(player, itemId, *cancel)</nowiki>
<nowiki>Event: onPlayerDamaged(victim, killer, *cancel, *damage, cause, limb)</nowiki>
<nowiki>Event: onPlayerDeath(victim, killer, cause)</nowiki>
<nowiki>Event: onPlayerEquipped(player, item, *cancel)</nowiki>
<nowiki>Event: onPlayerExperienceUpdated(player)</nowiki>
<nowiki>Event: onPlayerGestured(player, gesture)</nowiki>
<nowiki>Event: onPlayerInventoryAdded(player, item)</nowiki>
<nowiki>Event: onPlayerInventoryRemoved(player, item)</nowiki>
<nowiki>Event: onPlayerJoined(player)</nowiki>
<nowiki>Event: onPlayerQuit(player)</nowiki>
<nowiki>Event: onPlayerRespawned(player)</nowiki>
<nowiki>Event: onRockMined(player)</nowiki>
<nowiki>Event: onSignModify(player, sign, *text, *cancel)</nowiki>
<nowiki>Event: onStructureBuild(player, id, position, *cancel)</nowiki>
<nowiki>Event: onStructureDestroy(player, structure, *cancel)</nowiki>
<nowiki>Event: onTreeChopped(player)</nowiki>
<nowiki>Event: onUnload()</nowiki>
<nowiki>Event: onVehicleDamaged(vehicle, player, cause, *damage, *cancel)</nowiki>
<nowiki>Event: onVehicleEnter(player, vehicle, *cancel)</nowiki>
<nowiki>Event: onVehicleExit(player, vehicle, *cancel)</nowiki>
<nowiki>Event: onZombieKilled(player)</nowiki>
<nowiki></nowiki>
<nowiki>Globals:</nowiki>
<nowiki>    +print(object... arguments)</nowiki>
<nowiki>    +array(object... arguments) : object [DEPRECATED]</nowiki>
<nowiki>    +broadcast(object message, [string chatColor], [string url])</nowiki>
<nowiki>    +isPlayer(object obj) : boolean [DEPRECATED]</nowiki>
<nowiki>    +isSet(object obj) : boolean [DEPRECATED]</nowiki>
<nowiki>    +toPlayer(string name_OR_id) : player</nowiki>
<nowiki></nowiki>
<nowiki>Array [Base Type]:</nowiki>
<nowiki>    +add(object item)</nowiki>
<nowiki>    +clear()</nowiki>
<nowiki>    +contains(object item) : boolean</nowiki>
<nowiki>    +indexOf(object item) : int32</nowiki>
<nowiki>    +insert(int32 index, object item)</nowiki>
<nowiki>    +join(string separator) : string</nowiki>
<nowiki>    +lastIndexOf(object item) : int32</nowiki>
<nowiki>    +range(int32 startIndex, int32 count) : object</nowiki>
<nowiki>    +remove(object item) : object</nowiki>
<nowiki>    +removeAt(int32 index)</nowiki>
<nowiki>    +skip(int32 count) : object</nowiki>
<nowiki>    +sort()</nowiki>
<nowiki>    +sort(int32 index, int32 count)</nowiki>
<nowiki>    +sortDesc()</nowiki>
<nowiki>    +sortDesc(int32 index, int32 count)</nowiki>
<nowiki>    +count              [get]      : int32</nowiki>
<nowiki></nowiki>
<nowiki>barricade [Class]:</nowiki>
<nowiki>    +damage(uInt16 amount)</nowiki>
<nowiki>    +destroy()</nowiki>
<nowiki>    +repair(uInt16 amount)</nowiki>
<nowiki>    +door                [get]      : door</nowiki>
<nowiki>    +health              [get]      : uInt16</nowiki>
<nowiki>    +id                  [get]      : uInt16</nowiki>
<nowiki>    +instanceId          [get]      : uInt32</nowiki>
<nowiki>    +itemType            [get]      : string</nowiki>
<nowiki>    +group              [get/set]  : string</nowiki>
<nowiki>    +maxHealth          [get]      : uInt16</nowiki>
<nowiki>    +name                [get]      : string</nowiki>
<nowiki>    +owner              [get/set]  : string</nowiki>
<nowiki>    +position            [get]      : vector3</nowiki>
<nowiki>    +sign                [get]      : sign</nowiki>
<nowiki>    +storage            [get]      : storage</nowiki>
<nowiki></nowiki>
<nowiki>database [Static Class]:</nowiki>
<nowiki>    +escape(string text) : string</nowiki>
<nowiki>    +execute(string query) : object</nowiki>
<nowiki>    +allRows(string query, object... prepareArgs) : object</nowiki>
<nowiki>    +firstRow(string query, object... prepareArgs) : object</nowiki>
<nowiki>    +scalar(string query, object... prepareArgs) : object</nowiki>
<nowiki>    +nonQuery(string query, object... prepareArgs)</nowiki>
<nowiki></nowiki>
[[Category:Unturned]]
[[Category:uScript]]

Revision as of 09:44, 1 February 2025

This is a duplication of what is available on the uScript discord server. Download the latest (uScript_v2.0.5_Documentation.zip at the time of this writing) from Discord. uScript2 was created by Ster. Documentation last known release date: — 4/28/23, 1:15 PM

Event: onAccuracyUpdated(player)
Event: onAid(player, target, item, *cancel)
Event: onAnimalKilled(player)
Event: onArenaWin(player)
Event: onBarricadeBuild(player, id, position, *cancel)
Event: onBarricadeDestroy(player, barricade, *cancel)
Event: onClothingUpdated(player, item, slot)
Event: onConsume(player, item, *cancel)
Event: onEffectButtonClicked(player, buttonName)
Event: onEffectTextCommitted(player, buttonName, text)
Event: onFishCaught(player)
Event: onHeadShot(player)
Event: onInterval(timeInSeconds) NOTE: You should replace timeInSeconds without the number of seconds you want between each interval
Event: onLoad()
Event: onMegaZombieKilled(player)
Event: onPlantHarvested(player)
Event: onPlayerChatted(player, message, mode, *color, *cancel)
Event: onPlayerCrafted(player, itemId, *cancel)
Event: onPlayerDamaged(victim, killer, *cancel, *damage, cause, limb)
Event: onPlayerDeath(victim, killer, cause)
Event: onPlayerEquipped(player, item, *cancel)
Event: onPlayerExperienceUpdated(player)
Event: onPlayerGestured(player, gesture)
Event: onPlayerInventoryAdded(player, item)
Event: onPlayerInventoryRemoved(player, item)
Event: onPlayerJoined(player)
Event: onPlayerQuit(player)
Event: onPlayerRespawned(player)
Event: onRockMined(player)
Event: onSignModify(player, sign, *text, *cancel)
Event: onStructureBuild(player, id, position, *cancel)
Event: onStructureDestroy(player, structure, *cancel)
Event: onTreeChopped(player)
Event: onUnload()
Event: onVehicleDamaged(vehicle, player, cause, *damage, *cancel)
Event: onVehicleEnter(player, vehicle, *cancel)
Event: onVehicleExit(player, vehicle, *cancel)
Event: onZombieKilled(player)

Globals:
    +print(object... arguments)
    +array(object... arguments) : object [DEPRECATED]
    +broadcast(object message, [string chatColor], [string url])
    +isPlayer(object obj) : boolean [DEPRECATED]
    +isSet(object obj) : boolean [DEPRECATED]
    +toPlayer(string name_OR_id) : player

Array [Base Type]:
    +add(object item)
    +clear()
    +contains(object item) : boolean
    +indexOf(object item) : int32
    +insert(int32 index, object item)
    +join(string separator) : string
    +lastIndexOf(object item) : int32
    +range(int32 startIndex, int32 count) : object
    +remove(object item) : object
    +removeAt(int32 index)
    +skip(int32 count) : object
    +sort()
    +sort(int32 index, int32 count)
    +sortDesc()
    +sortDesc(int32 index, int32 count)
    +count               [get]      : int32

barricade [Class]:
    +damage(uInt16 amount)
    +destroy()
    +repair(uInt16 amount)
    +door                [get]      : door
    +health              [get]      : uInt16
    +id                  [get]      : uInt16
    +instanceId          [get]      : uInt32
    +itemType            [get]      : string
    +group               [get/set]  : string
    +maxHealth           [get]      : uInt16
    +name                [get]      : string
    +owner               [get/set]  : string
    +position            [get]      : vector3
    +sign                [get]      : sign
    +storage             [get]      : storage

database [Static Class]:
    +escape(string text) : string
    +execute(string query) : object
    +allRows(string query, object... prepareArgs) : object
    +firstRow(string query, object... prepareArgs) : object
    +scalar(string query, object... prepareArgs) : object
    +nonQuery(string query, object... prepareArgs)