TilePlus Version 5
Unity3D Tilemap Extension
Loading...
Searching...
No Matches
TilePlus.StringPacket Class Reference

Common message packet for a string sent to a tile. E.G., a JSON string for the tile to expand and use to restore data. Note that there's a pool for these in TpMessaging. More...

Inheritance diagram for TilePlus.StringPacket:
Collaboration diagram for TilePlus.StringPacket:

Public Member Functions

 StringPacket (Object? sourceInstance=null)
 Initializes a new instance of the StringPacket class.
 StringPacket (string s, Object? sourceInstance=null)
 Initializes a new instance of the StringPacket class.
override string ToString ()
 To String.
Public Member Functions inherited from TilePlus.MessagePacket< T >
virtual void Reset ()
 Reset the SourceInstance. Override for additional resets of variables holding references.

Public Attributes

string? m_String
 the string sent to the tile.

Additional Inherited Members

Protected Member Functions inherited from TilePlus.MessagePacket< T >
 MessagePacket (Object? sourceInstance)
 Source Instance for this packet. Can be null.
Properties inherited from TilePlus.MessagePacket< T >
ObjectSourceInstance [get, set]
 The instance that's the source of the message. Can be null.
ulong Id [get, set]
 The ID of this packet. Packet recepients can test this to see if they're being sent the same message repeatedly. Note that 0 is not used except internally.

Detailed Description

Common message packet for a string sent to a tile. E.G., a JSON string for the tile to expand and use to restore data. Note that there's a pool for these in TpMessaging.

Constructor & Destructor Documentation

◆ StringPacket() [1/2]

TilePlus.StringPacket.StringPacket ( Object? sourceInstance = null)

Initializes a new instance of the StringPacket class.

Parameters
sourceInstanceSource of message or null

◆ StringPacket() [2/2]

TilePlus.StringPacket.StringPacket ( string s,
Object? sourceInstance = null )

Initializes a new instance of the StringPacket class.

Parameters
sThe string.
sourceInstanceSource of message or null

Member Function Documentation

◆ ToString()

override string TilePlus.StringPacket.ToString ( )

To String.

Returns
Returns 'null or empty' or string trimmed to length 10.

Member Data Documentation

◆ m_String

string? TilePlus.StringPacket.m_String

the string sent to the tile.


The documentation for this class was generated from the following file:
  • /Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/StaticLib/ClassesEnums/MessagingClasses.cs