Logo

STD Library

Required Module

Components & Properties

Name Description
Object \
Type This is the type of the description. Using “typeof” will return its type.
Entity An entity is a vessel that holds all components, which must be added to entities in order to be activated
Property \
Event ID Represents an event
Type Enum \
Bool \
Int \
Float \
Int64 A 64-bit signed integer
Number \
String \
Color The type of the RGBA color channel, which ranges from 0 to 255
UUID The unique identifier of a player
Asset Config ID \
Asset ID \
Plot ID \
Collection ID The Collection ID used for asset information collection
Item ID The item ID (only weapon ID available in the current version)
Level Object ID Describes the object type. Requires parsing through the SceneEditPrefab configuration table before loading.
Human Model ID \
List \
List Template \
Map A data container for dict. The element is a pair that consists of a key and a value.
Map Template The data template for dict. You may designate the content type through T1 and T2.
List or Map \
Type List \
Type or Type List \
Vector2 \
Vector3 \
Quaternion Quaternion is a special four-dimensional vector used only to represent a rotation
Condition Conditions are a special Boolean type
Condition List \
Direction point[Obsolete] \
Localization Key \
Mesh ID Describes the mesh type
Preset Character Type Customize character asset ID
Animation Clip ID Customize animation clip ID
Material ID \
Collider Collection ID The collider ID
Texture ID \
Sprite ID The ID used to describe the sprite asset
Script ID The ID used to describe a script asset
Static Script ID The ID used to describe a static script asset
Custom UI ID The ID used to describe a custom HUD asset
Custom UI Widget ID The ID used to describe a control in the interface assets. It must be paired with a custom HUD ID in order to ensure that it corresponds to a unique control ID.
Prefab ID The ID used to describe a prefab asset
Audio ID The ID used to describe an audio asset
CSV ID The ID used to describe a configuration table asset
Effect ID The ID used to describe a special effect asset
Animation Controller ID The ID used to describe an animation controller asset
Particles ID \
Bool List \
Int List \
Int or Int List \
Float List \
String List \
Vector3 List \
Localization Key List \
Skill List[Obsolete] \
Skill ID List \
Component \
entity The basic component of an entity. All components will combine this component.
Terrain A terrain component of which attributes cannot be modified. Used to test functions only.
Transform Rotation, scaling, and parent-child record
Visibility Indicates whether visibility can be set
Basic Appearance \
Collider \
Entity or Prefab ID Logical Entity or Prefab ID
Animation Controller Attachable The file and resource used to manage the animation controller
Built-In Render The bridging rendering component used for rendering with built-in models
Batch Combine Render \
Custom Render Component A custom rendering component, used for rendering with custom model resources.
Aimable \
Container \
Game entity \
Rankable \
Scoreable \
Team The team entity in the game. Each team has one entity.
Combatable An entity that can fight (e.g. launch attacks, be attacked, or get eliminated)
Buffable Enables adding buffs, removing buffs, and getting added buff lists
Spawn \
Spawnable \
Resetable \
Formulable An entity that can formulate properties
Player The in-game player entity. Each player has one.
Level Object \
Level Object List \
VFX Type Visual effects
Icon Type Icon
SoundEffect Type Sound effects
Sort Type Sort types: non-zero ascending, descending, and ascending
Item ID Type The type of item
Icon entity[Obsolete] \
Text entity[Obsolete] \
Visual effects entity[Obsolete] \
Player List \
Team List \
Entity List \
Wave Count Type # of waves
Wave Interval Type Wave interval
Playable A playable entity
Loopable Loopable
Sound entity[Obsolete] \
Sound Effect Entity List[Obsolete] \
Sound Effect Entity or List[Obsolete] \
Custom Path \
Path Point \
Weapon Type Weapon Type
Ammo Type Ammo Type
Unit Spawn \
Item Base \
Custom Object An empty object component that can be used with the render component and collision component.
NPC The NPC object
Playable List \
Coordinate System Type \
Game Result Type Result
Font Type Font enum
Text Entity The text entity represents the text to be displayed
Icon Entity The icon entity represents the icon to be displayed
Effect The special effects entity represents the special effect to be displayed
Particles \
Timestamp Localization String The localized string for a timestamp
Timestamp Format Style Type The display style of a localized string
3-Status Switch \
Skeleton Part \
Vehicle ID Type \
Sound Effect The sound effect entity represents a sound effect that is being played
Sound Effect List \
Sound Effect or Sound Effect List \
Bot Difficulty Type Bot Difficulty
Integer Map Template \
Player or NPC \
Item List \
Hierarchical Entity capable of mounting child nodes
Mid-Game Exit Configuration \
String or Localization String \
Platform Type The platform type
Base Data Alias \
Status Code The error code enum
Player or Transform An alias for the Player and Transform entity
Custom Curve Path Waypoint \
Custom Curve Path Type \
Account IDs \
Status Codes \
Group \
Custom Curve Path \
\
\
Language Type \

Event

Name Description
On Game Start Triggered when the game starts, the server will be ready some time earlier than the client
On Game End Triggered at the end of the game. This event is triggered before the game ends on the server.
On Awake Triggered after the current entity is created
On Destroy Triggered before the current entity is destroyed.
On Enable Triggered after the current entity becomes available.
On Disable Triggered after the current entity becomes unavailable.
On Spawn Fired when a spawner spawns an entity.
On Update Triggered when a logic frame is updated. The frequency of this event triggering will vary depending on the platform and settings.
On Plot Start Triggers when the plot starts to play
On Plot End Triggers when the plot ends
On Trigger Plot Option Triggers when an option is selected in the plot

API

Name Description
Get All Players Get all the players in the current game, and return a list of players.
Get All Teams Get all teams in the current game and return the team list.
Set All Players Move Status Sets whether all players can move
Log Info Print logs to the console
Break loop Interrupt the current loop and exit the loop
Continue to next Skip the remaining loop body, enter the next loop directly
Return End the current execution process and return directly to the calling location. Can return with data
Wait For Next Frame Wait until the next logical frame starts
On the server, if you turn on the low frame rate mode, you will wait longer
On the client, the waiting time is affected by the device performance and the complexity of the current frame logic
The function using
Wait for Millisecond To wait for a certain period of time, the function using this API needs to be declared as async.
NOT Logical inversion, input value: true or false, return value: false or true
Color Get Construct a color value with a fixed transparency of decimal 255. First, convert the channel to a binary number, with each 8 bits representing a channel. Concatenate the numbers according to R, G, B, and transparency, and then convert the binary number to
Check null Determine whether the object is empty
Get Server Timestamp Get server timestamp
Get Server Region Get Server Region
Set property Set the attribute value of the target entity. This attribute must have been defined.
Get property Get the value of an entity’s attribute
Create Icon[Obsolete] Create an icon using the specified icon type. If there are more properties to set, further set its entity properties through the entity (deprecated, please use CreateLevelObject)
Remove icon[Obsolete] Remove the specified icon (deprecated, please use DeleteEntity)
Create text[Obsolete] Create a text with the specified text content. If there are more properties to be set, further set its entity properties through the entity (deprecated, please use CreateLevelObject)
Remove text[Obsolete] Remove the specified text (deprecated, please use DeleteEntity)
Create visual effects[Obsolete] Create an icon using the specified effect type. If there are more properties to set, further set its entity properties through the entity (deprecated, please use CreateEffect)
Create visual effects[Obsolete] Create an icon using the specified special effect type. If there are more properties that need to be set, further set its entity properties through the entity.
Delete visual effects[Obsolete] Remove the specified effect (deprecated, please use DeleteEntity)
Play sound effect[Obsolete] Play the specified sound effect. If there are more properties to set, further set its entity properties through the entity (deprecated, please use CreateSound)
Pause sound effect[Obsolete] Interrupt the playing sound entity (deprecated, please use PauseSound)
Play sound effect[Obsolete] Continue playing the sound effect, you can choose whether to play it from the beginning (deprecated, please use ResumeSound)
Notify Play Sound Notify the target player’s client to play the sound effect
Notify Show Tips Notify the target player’s client to display Pop-up text
This Entity Return the entity bound to the current script
Get global Get the Global entity of that game
Teleport[Obsolete] Teleport player to specific coordinates (deprecated, use Teleport)
Obtain nearby teammates’ locations[Obsolete] Gets the position near teammates, will circumvent the position of players who can’t stand (deprecated, please use GetTeammateNearPosition)
Get Owner Get the player to which the entity belongs
Clone Clone the selected entity and all its properties in the original position
SpawnNextWave The generator immediately spawns the next wave of unit entities
Get Type Get the target type when calling this API
Type Is Determine whether the target variable is of the specified type
Is Sub Type Of Determines whether the target variable is a subtype of a certain type. The return value is a Boolean value.
Has Component Determine if the target entity has a component
Dispatch Event Make the target entity to trigger a specified custom event
Filter Entity Get all the entities in the game that meet the filter criteria
Add Script Add script to target entity
Remove Script Uninstall the script for the target entity
Has Script Check if the specified script exists on the target entity
Destroy Destroy designated entities
Add Tag Add labels to entities
Remove Tag Remove labels for entities
Has Tag Determine whether the target entity contains the specified label
Set Active Set the active state of the target entity and its children nodes; availability, visibility, collisions, etc. are turned off for inactive objects
Set Parent Setting the parent node requires that both parent and child have the Transform component
Get Children Get all child nodes of the target parent node entity
Get Child By Index Get the specified child node of the target parent node entity according to the index
Get Child By Name Get the specified child node of the target parent node entity by name
Get Parent Get the parent node of the target child node entity
Clear All Children Delete all child nodes under the specified parent node entity. The node must have a Transform component.
Set Property Smoothly Smoothly sets the properties of the target entity, the properties change immediately, but the client plays a smooth transition performance
Create From Prefab Using prefab as template to create entity
Instantiate Prefab Create a prefab instance with the option to process it asynchronously
Set Player Can Quit Midway Set whether the player can exit freely
Get Color Channel Get the channel values of the target color
Timestamp To Localization String Create a timestamp localized string
Profanity Filter Dirty word filtering
Create Sound Effect[Obsolete] Play the specified sound effect. If there are more properties that need to be set, further set its entity properties through the entity.
Pause sound effect[Obsolete] Interrupt the playing sound entity
Play sound effect[Obsolete] Continue playing the sound effect, you can choose whether to play from the beginning
Create Bot Add Bot
Destroy Bot Destroy the specified Bot
Create Damage Num Create damage tick
Log Warning Print the target content to the console as a warning
Log Error Print the target content to the console as an error
Upload Game Result Upload custom settlement information
Set Parent Set the parent node of the object entity, supporting entities with Transform, SkeletonPart, Player, and MountPoint components mounted on them
Notify Play Icon Animation Play icon animation effect, the icon moves from the starting position to the end position at the play speed
Add Component Add components to entities. Only custom components created by users are supported
Remove Component Remove component from an entity. Only custom components are supported
Apply Quit Midway UI Config Customize the interface of player quitting mid-game
Get Local Player Get the current client’s corresponding player
Add AOI Special Follow Added AOI special attention, always synchronized regardless of distance
Remove AOI Special Follow Remove AOI special attention and cancel AOI synchronization outside line of sight
Clear AOI Special Follow Clear all AOIs of the specified target.
Has AOI Special Follow Determine whether there is AOI of special concern
Switch AOI Proxy Observer Toggle the player’s proxy observer
Notify Start Plot Start playing the specified plot for the triggering player
Get Local Language Get the client language used by the player