Using Skript Syntax (v2.7.7 or lower)

✔ v2.6.2+ of DisplayEntityUtils provides Skript Syntax

❗ Skript Version 2.10.0 or higher is required

📜 It is recommended to read through other wiki pages before exploring this page

Skript Documentation for ALL Syntax

Examples for SOME of the Skript syntax

Getting/Spawning Groups (Models)

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

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

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

#Get a savedgroup from storage
#VALID STORAGE: local, mongo, or mysql
set {_savedGroup} to saved group tagged "mygroup" from local storage

#Create a spawned-group from a saved-group
set {_spawnedgroup} to {_savedgroup} spawned at {_location}

#Create a spawned-group from a saved-group (with spawn settings)
set {_settings} to new group spawn settings
set {_settings}'s to visible by default #Makes the group visible by default (This is already the default setting property)
set {_settings}'s interactions to visible by default #Makes the group's interactions hidden by default
set {_settings}'s billboard to center for parts with tag "pivotpart"

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

Creating Spawned Part Selections

#Create a selection containing parts from a spawned-group
set {_selection} to a new spawned part selection from {_spawnedgroup}

#Filter parts by their tag (Applies to all parts in selection)
add filter to {_selection} with tag "includedTag" and without tags "excludedTag1" and "excludedTag2"

#Filter parts by blocks (Applies to Block Displays in selection)
set block filter of {_selection} with stone

#Filter parts by item (Applies to Item Displays in selection)
set item filter of {_selection} without stick and iron sword #Keeps all item displays, except ones showing sticks and iron swords

#Filter parts by their type (inclusive)
set part type filter of {_selection} to parttype_text_display

#Filter parts by their type (exclusive)
set type filter of {_selection} to exclude parttype_block_display and parttype_item_display

#Update selected parts in the selection if parts are manually removed/added from a spawned group
refresh {_selection}

#Reset all filters applied on a selection
reset {_selection}

#Remove and unregister a selection (this makes it unusable afterwards)
remove {_selection}

Getting Spawned Parts (Display/Interaction entities of a spawned-group)

#Get spawned parts of a spawned group
set {_spawnedparts::*} to {_spawnedgroup}'s parts

#Get spawned parts of a spawned selection
set {_spawnedparts::*} to {_selection}'s parts

## Get spawned part from a Display/Interaction entity that is in a group
set {_spawnedpart} to {_display}'s spawned part

## Get the entity of a spawned part
set {_entity} to {_spawnedpart}'s entity

Manipulating a Spawned Group/Selection/Part

# {_spawned} refers to a spawned group, part selection, or spawned part

#Glowing
deu make {_spawned} glow for 35 ticks
deu make {_spawned} glow with interactions and with marker particles #Applies to spawned groups and selections
deu make {_spawned} to unglow

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

#Billboard
deu set {_spawned}'s billboard to vertical
deu set {_spawned}'s billboard to center for parts with tag "pivotpart" #Applies to spawned groups and selections

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

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

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

#Teleport Spawned Group
deu teleport {_spawnedgroup} to {_location}

#Get Spawned Group's Location
set {_location} to {_spawnedgroup}'s true location

Unregistering a Spawned Group

#Unregister a spawned-group
unregister {_spawnedgroup}

#Unregister a spawned-group, and despawn
unregister {_spawnedgroup} and despawn

#Unregister a spawned-group, and despawn (forced chunk loading)
unregister {_spawnedgroup} and despawn with forced chunk loading

Getting Animations

#Get a savedanimation from storage
#VALID STORAGE: local, mongo, or mysql
set {_savedanim} to saved animation tagged "myanimation" from local storage

#Create a spawned-animation from a saved-animation
#spawned-animations are what can be applied to a group
set {_spawnedanim} to {_savedanim} as spawned animation

#Get a spawned-animation if cached (or optionally fallback from storage)
set {_cachedanim} to cached spawned anim "myanimation"
set {_cachedanim} to cached spawned anim "myanimation" or fallback with local storage

Play Animation Frames

Play a frame of an animation on a spawned group

#Play an animation frame on a spawned group
play frame with id 2 on {_spawnedgroup} from {_spawnedanimation}

#Play an animation frame on a spawned group (With manually changed duration and delay)
play frame with id 2 on {_spawnedgroup} from {_spawnedanimation} with duration 5 seconds and delay 0 ticks

Using Animators

Animators are what play animations on a spawned-group

#Create a linear animator
set {_animator} to linear animator using {_spawnedanimation}

#Create a looping animator (Must manually be stopped)
set {_animator} to looping animator using {_spawnedanimation}

#Play an animation on a spawned group
play animation on {_spawnedgroup} using {_animator}
play animation on {_spawnedgroup} using {_animator} starting at frame 3

Stopping Animations

stop all animations on {_spawnedgroup}

stop animation on {_spawnedgroup} from {_animator} #Stop a specific animator's animations