Skip to content

Using Groups with Skript

Jay edited this page Oct 31, 2025 · 8 revisions

Spawn Groups/Models

Valid Storage: local, mongo, mysql

#Get a savedgroup from storage
set {_savedGroup} to saved group tagged "mygroup" from local storage

#Spawn the group at a location
set {_spawnedgroup} to {_savedgroup} spawned at {_location}

#Spawn the group at a location using packets
set {_packetgroup} to packet based {_savedgroup} spawned at {_location}

#Spawn the group at a location using packets, with persistence between server sessions (v3.3.4+)
set {_packetgroup} to persistent packet based {_savedgroup} spawned at {_location}

Spawning Non-Packet-Based Groups/Models with Spawn Settings

set {_settings} to new group spawn settings
set {_settings}'s to visible by default #Makes the group visible by default when spawned
set {_settings}'s interactions to invisible by default #Makes the group's interactions hidden by default
deu set {_settings}'s billboard to center
deu set {_settings}'s billboard to vertical for parts with tag "pivotpart" #Parts with the tag "pivotpart" will have a billboard of CENTER

set {_spawnedgroup} to {_savedgroup} spawned at {_location} with {_settings}

Getting Non-Packet-Based Groups/Models already in the world

#Get the nearest spawnedgroup from by location
set {_nearestGroup} to nearest spawnedgroup within 4 blocks of {_location}

#Get all spawnedgroupos around a location
set {_nearestGroups::*} to all spawnedgroups within 6 blocks of {_location}

# Get the selected spawnedgroup of a player
set {_selectedGroup} to player's selected spawned-group

Getting Persistent Packet Groups/Models already in the world

#Get the ID of a persistent packet-based group that is persistent, to use in it future sessions
set {id} to {_packetgroup}'s persistent id

#Get the persistent packet-based group by its id 
set {_mypersistentgroup} to persistent packet group with id {id}

Unregistering an Active Group

#Unregister an active-group
unregister {_activegroup}

#Unregister a spawned-group, and despawn. This is not required for packet-based groups
unregister {_spawnedgroup} and despawn

#Unregister a spawned-group, and despawn with forced chunk loading. This is not required for packet-based groups
unregister {_spawnedgroup} and despawn with forced chunk loading

Update changes made to a Persistent Packet-Based Group

#Save any changes made to a persistent packet-based group, so they will apply for next server sessions
update persistent {_packetgroup}

Manipulating an Active Group/Multi Part Filter/Active Part

# {_active} refers to an activegroup, multipartfilter, or activepart

#Glowing
deu make {_active} glow
deu make {_active} glow for 35 ticks
deu make {_active} unglow
deu make {_active} glow for {_player}
deu make {_active} glow for {_player} for 10 ticks

#Glow Color
set {_active}'s deu glow color to red
set {_color} to {_active}'s deu glow color #Applies to active groups and parts

#Billboard
deu set {_active}'s billboard to vertical
deu set {_active}'s billboard to center for parts with tag "pivotpart" #Applies to active groups and filters

#Change Direction (Pitch/Yaw)
deu set {_active}'s pitch to -90
deu set {_active}'s yaw to 35
deu set {_active}'s yaw with interaction pivot to 35 #Applies to active groups and filters or Interaction parts

#Show/Hide
deu show {_active} to player
deu hide {_active} from player

#Get/Set Spawned Group Tag
set {_groupTag} to {_spawnedgroup}'s deu tag
set {_spawnedgroup}'s deu tag to "newTag"

#Teleport Active Group
deu teleport {_activegroup} to {_location}

#Get Active Group's Location
set {_location} to {_activegroup}'s true location

DisplayEntityUtils Wiki

Overview

General Help / Examples

Display Groups

Interaction Entities

Animations

Animation Effects (w/ Frame Points)

DisplayControllers (Mounting, Custom Entities & Equipment)

Skript Help / Examples

API Help / Examples

Old Help / Examples

Clone this wiki locally