API reference / @jsprismarine/protocol / EduSharedUriResource
Class: EduSharedUriResource
Defined in: protocol/src/structure/EduSharedUriResource.ts:20
The link an Education Edition world offers its players, as EduUriResourcePacket and LevelSettings (inside StartGamePacket) carry it.
Protocol 2193 wire order: Button Name then Link Uri, both strings (a varuint32 byte length followed by UTF-8). Both are empty when the world shares no link. https://mojang.github.io/bedrock-protocol-docs/1.26.51/types/edu-shared-uri-resource/
Extends
Implements
Constructors
Constructor
new EduSharedUriResource(
buttonName?,linkUri?):EduSharedUriResource
Defined in: protocol/src/structure/EduSharedUriResource.ts:21
Parameters
buttonName?
string = ''
linkUri?
string = ''
Returns
EduSharedUriResource
Overrides
Properties
buttonName
buttonName:
string=''
Defined in: protocol/src/structure/EduSharedUriResource.ts:22
Button Name, the label of the button the Education Edition client shows.
Implementation of
EduSharedUriResourceData.buttonName
linkUri
linkUri:
string=''
Defined in: protocol/src/structure/EduSharedUriResource.ts:23
Link Uri, the address the button opens.
Implementation of
EduSharedUriResourceData.linkUri
Methods
deserialize()
deserialize(
stream):void
Defined in: protocol/src/structure/EduSharedUriResource.ts:35
Reads Button Name, then Link Uri.
Parameters
stream
Returns
void
Overrides
serialize()
serialize(
stream):void
Defined in: protocol/src/structure/EduSharedUriResource.ts:29
Writes Button Name, then Link Uri.
Parameters
stream
Returns
void
Overrides
deserialize()
staticdeserialize<T>(this,stream):T
Defined in: protocol/src/NetworkStructure.ts:28
Deserializes the network structure from a binary stream. The constructor runs with no arguments before the stream is read, so the class must tolerate that.
Type Parameters
T
T extends NetworkStructure
Parameters
this
Constructor<T>
stream
The binary stream to deserialize from.
Returns
T
An instance of the class T.