VRC SDK
This project aims to completely document the VRChat Unity SDK
Loading...
Searching...
No Matches
VRC.SDK3.Data.JsonDictionary Class Reference
Inheritance diagram for VRC.SDK3.Data.JsonDictionary:
Collaboration diagram for VRC.SDK3.Data.JsonDictionary:

Public Member Functions

 JsonDictionary (string source)
 
override void SetValue (DataToken key, DataToken value)
 Sets the value at the specified key. If that key does not exist, a new one will be added. More...
 
override void Clear ()
 Removes all keys and values from this dictionary More...
 
override bool ContainsKey (DataToken key)
 Returns true if the specified key exists on this dictionary. More...
 
override bool Remove (DataToken key)
 Removes a specific key from this dictionary. Returns true if anything was successfully removed. More...
 
override DataList GetKeys ()
 This is not documented properly yet More...
 
override void Add (DataToken key, DataToken value)
 Adds the value at the specified key. The entire purpose of this function that sets it apart from SetValue is that an exception will be thrown if the key already exists. This is useful for initialization because it will cause a compile error, but it's not recommended for normal usage where it could cause a runtime error and halt your UdonBehaviour. More...
 
- Public Member Functions inherited from VRC.SDK3.Data.DataDictionary
virtual void SetValue (DataToken key, DataToken value)
 Sets the value at the specified key. If that key does not exist, a new one will be added. More...
 
bool TryGetValue (DataToken key, TokenType type, out DataToken value)
 This is not documented properly yet More...
 
bool TryGetValue (DataToken key, out DataToken value)
 This is not documented properly yet More...
 
DataDictionary ShallowClone ()
 Clones the DataDictionary into a new DataDictionary that contains all the same values. Unlike DeepClone, this means that if the DataDictionary contains other DataLists and DataDictionaries, those will still be the same reference. More...
 
DataDictionary DeepClone ()
 Clones the DataDictionary into a new DataDictionary that contains all the same values. Unlike ShallowClone, deep clone means that it will recursively navigate inside each DataList or DataDictionary and copy their contents as well. Items with the TokenType "Reference" will maintain the same reference as the original and not be deep cloned, which includes arrays. More...
 
virtual void Clear ()
 Removes all keys and values from this dictionary More...
 
virtual bool Remove (DataToken key)
 Removes a specific key from this dictionary. Returns true if anything was successfully removed. More...
 
bool Remove (DataToken key, out DataToken value)
 Removes a specific key from this dictionary. Returns true if anything was successfully removed. If successful, copies the value that was removed into the out DataToken. More...
 
virtual bool ContainsKey (DataToken key)
 Returns true if the specified key exists on this dictionary. More...
 
virtual bool ContainsValue (DataToken value)
 Returns true if the specified value exists on this dictionary. More...
 
virtual DataList GetKeys ()
 This is not documented properly yet More...
 
DataList GetValues ()
 This is not documented properly yet More...
 
IEnumerator< KeyValuePair< DataToken, DataToken > > GetEnumerator ()
 This is not documented properly yet More...
 
void Add (KeyValuePair< DataToken, DataToken > item)
 
virtual void Add (DataToken key, DataToken value)
 Adds the value at the specified key. The entire purpose of this function that sets it apart from SetValue is that an exception will be thrown if the key already exists. This is useful for initialization because it will cause a compile error, but it's not recommended for normal usage where it could cause a runtime error and halt your UdonBehaviour. More...
 
bool Contains (KeyValuePair< DataToken, DataToken > item)
 
void CopyTo (KeyValuePair< DataToken, DataToken >[] array, int arrayIndex)
 
bool Remove (KeyValuePair< DataToken, DataToken > item)
 

Protected Member Functions

override DataToken GetValue (DataToken key, out bool success)
 
virtual DataToken GetValue (DataToken key, out bool success)
 

Package Functions

override void ParseAll ()
 
void AddLazyValue (DataToken key, JsonType type, int index)
 
virtual void ParseAll ()
 

Properties

override int Count [get]
 
- Properties inherited from VRC.SDK3.Data.DataDictionary
virtual int Count [get]
 Get the number of elements in the dictionary More...
 
bool IsReadOnly [get]
 This is not documented properly yet More...
 
DataToken this[DataToken key] [get, set]
 

Additional Inherited Members

- Package Attributes inherited from VRC.SDK3.Data.DataDictionary
DataList keyCache
 
bool keysDirty = true
 
DataList valueCache
 
bool valuesDirty = true
 

Detailed Description

Definition at line 7844 of file VRCSDK3.cs.

Constructor & Destructor Documentation

◆ JsonDictionary()

VRC.SDK3.Data.JsonDictionary.JsonDictionary ( string  source)

Definition at line 7852 of file VRCSDK3.cs.

Member Function Documentation

◆ Add()

override void VRC.SDK3.Data.JsonDictionary.Add ( DataToken  key,
DataToken  value 
)
virtual

Adds the value at the specified key. The entire purpose of this function that sets it apart from SetValue is that an exception will be thrown if the key already exists. This is useful for initialization because it will cause a compile error, but it's not recommended for normal usage where it could cause a runtime error and halt your UdonBehaviour.

Parameters
keyThe key to set the value at
valueThe value to set


Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Reimplemented from VRC.SDK3.Data.DataDictionary.

Definition at line 7959 of file VRCSDK3.cs.

◆ AddLazyValue()

void VRC.SDK3.Data.JsonDictionary.AddLazyValue ( DataToken  key,
JsonType  type,
int  index 
)
package

Definition at line 7969 of file VRCSDK3.cs.

Here is the caller graph for this function:

◆ Clear()

override void VRC.SDK3.Data.JsonDictionary.Clear ( )
virtual

Removes all keys and values from this dictionary


Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Reimplemented from VRC.SDK3.Data.DataDictionary.

Definition at line 7892 of file VRCSDK3.cs.

◆ ContainsKey()

override bool VRC.SDK3.Data.JsonDictionary.ContainsKey ( DataToken  key)
virtual

Returns true if the specified key exists on this dictionary.

Parameters
keyThe key to check for


Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Reimplemented from VRC.SDK3.Data.DataDictionary.

Definition at line 7898 of file VRCSDK3.cs.

◆ GetKeys()

override DataList VRC.SDK3.Data.JsonDictionary.GetKeys ( )
virtual

This is not documented properly yet

<incomplete >


Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Reimplemented from VRC.SDK3.Data.DataDictionary.

Definition at line 7947 of file VRCSDK3.cs.

Here is the call graph for this function:

◆ GetValue()

override DataToken VRC.SDK3.Data.JsonDictionary.GetValue ( DataToken  key,
out bool  success 
)
protectedvirtual

Reimplemented from VRC.SDK3.Data.DataDictionary.

Definition at line 7866 of file VRCSDK3.cs.

Here is the call graph for this function:

◆ ParseAll()

override void VRC.SDK3.Data.JsonDictionary.ParseAll ( )
packagevirtual

Reimplemented from VRC.SDK3.Data.DataDictionary.

Definition at line 7916 of file VRCSDK3.cs.

Here is the call graph for this function:

◆ Remove()

override bool VRC.SDK3.Data.JsonDictionary.Remove ( DataToken  key)
virtual

Removes a specific key from this dictionary. Returns true if anything was successfully removed.

Parameters
keyThe key to remove


Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Reimplemented from VRC.SDK3.Data.DataDictionary.

Definition at line 7907 of file VRCSDK3.cs.

◆ SetValue()

override void VRC.SDK3.Data.JsonDictionary.SetValue ( DataToken  key,
DataToken  value 
)
virtual

Sets the value at the specified key. If that key does not exist, a new one will be added.

Parameters
keyThe key to set the value at
valueThe value to set


Check the VRChat documentation for more information.
Docs generated by the VRChat SDK Documentation Project.

Reimplemented from VRC.SDK3.Data.DataDictionary.

Definition at line 7857 of file VRCSDK3.cs.

Property Documentation

◆ Count

override int VRC.SDK3.Data.JsonDictionary.Count
get

Definition at line 7850 of file VRCSDK3.cs.


The documentation for this class was generated from the following file: