VRChat Wiki - User contributions [en]

Guides:UdonSharp Nitpicks

2026-05-03T20:11:33Z

Usr 923acdda-9202-4f4d-91c0-d0d7269c96a5: Added missing section, fixed a typo.

{{Noticebox/Community}}{{Noticebox/wip}}Here are some things that [[User:Usr 923acdda-9202-4f4d-91c0-d0d7269c96a5|Fax]] considers useful or practical when writing U# code, in no particular order.

''This page was originally posted on [https://vrclibrary.com/wiki/books/faxs-retrospectives-and-prefabs/page/udonsharp-nitpicks VRCLibrary], and was updated for the VRChat wiki. These suggestions are somewhat personal, so if you have any suggestions, please discuss them!''

= Attributes =
Attributes, such as <code>[SerializeField]</code>, can help make your classes, variables, or methods more useful.

=== UdonBehaviourSyncMode ===
Use U#'s <code>[https://udonsharp.docs.vrchat.com/udonsharp/#udonbehavioursyncmode UdonBehaviourSyncMode]</code> attribute to make sure your <code>UdonBehaviour</code> always uses the sync mode you intended. For example:<syntaxhighlight lang="c#">using UdonSharp;
using UnityEngine;

[UdonBehaviourSyncMode(BehaviourSyncMode.Manual)]
public class Foo : UdonSharpBehaviour
{
// This behaviour always uses manual sync.
}</syntaxhighlight>Alternatively, you can choose the sync mode UdonBehaviours in the Unity inspector. This is more flexible and allows you to use different sync modes for different instances of the same behaviour - but that's a very rare use case. Instead, you may accidentally select the wrong mode without realizing it, causing networking to break unexpectedly. <code>UdonBehaviourSyncMode</code> is usually more reliable.

=== SerializeField ===
Use the <code>[SerializeField]</code> attribute to make <code>private</code> variable visible in the Unity inspector, allowing you to assign references to assets or scene objects:<syntaxhighlight>
[SerializeField] private Transform foo; // This shows up in the Unity inspector.
</syntaxhighlight>Instead of using <code>[SerializeField]</code>, you can make the variable <code>public</code> instead. However, this '''also''' makes those variables accessible from any other UdonBehaviour. If that's what you want, you should consider using <code>[HideInInspector]</code> attribute to prevent your public variables from causing clutter in the inspector.

=== Tooltip and Header ===
Use the <code>[Header]</code> and <code>[Tooltip]</code> attributes to organize variables in the Unity inspector. For example:<syntaxhighlight lang="c#">
[Header("Materials")]
[SerializeField] private Material materialFoo;
[SerializeField] private Material materialBar;
[SerializeField] private Material materialBaz;

[Header("Transforms")]
[Tooltip("This tooltip appears when hovering your mouse over transformFoo in the inspector.")]
[SerializeField] private Transform transformFoo;
</syntaxhighlight>

= Networking =
This section contains some tips related to networking and synchronizing changes between players.

=== Call OnDeserialization locally ===
When the networking owner of an UdonBehaviour uses <code>RequestSerialization()</code>, all players '''except''' the owner execute <code>OnDeserialization()</code>.

But if you override <code>OnDeserialization()</code> in your script, the owner can manually execute it. This is useful if you'd like the owner of the script to execute <code>OnDeserialization()</code>, to replicate the same behaviour as other players.

For example, the following script allows the owner to increase a <code>score</code> variable and update <code>scoreText</code> for all players:<syntaxhighlight lang="c#" line="1">[UdonSynced] private int score;
[SerializeField] private TextMeshProUGUI scoreText;

// If the owner calls the method below, the score increases by one.
private void IncreaseScore()
{
if (!Networking.IsOwner(gameObject)) return;
score++;
RequestSerialization();
OnDeserialization();
}

public override void OnDeserialization()
{
scoreText.text = score.ToString();
}</syntaxhighlight>Note that <code>OnDeserialization()</code> ''without'' parameters is a deprecated method. More complex scripts may require <code>OnDeserialization(DeserializationResult)</code> , so consider the following approach:

# Write your own method, e.g., <code>UpdateScoreText()</code>.
# Make the owner call it immediately after <code>RequestSerialization()</code>.
# Make remote players call it from <code>OnDeserialization(DeserializationResult result)</code>.

=== FieldChangeCallback ===
Use the <code>[FieldChangeCallback]</code> attribute to respond to synced variable changes without using <code>OnDeserialization()</code>. For example:<syntaxhighlight lang="c#" line="1">[SerializeField] private TextMeshProUGUI scoreText;
[UdonSynced, FieldChangeCallback(nameof(Score))] private int score;

private bool Score
{
get => score;
set
{
score = value;
scoreText.text = score.ToString();
}
}

// If the owner calls the method below, the score increases by one.
private void IncreaseScore()
{
if (!Networking.IsOwner(gameObject)) return;
Score++;
RequestSerialization();
}</syntaxhighlight>This approach is especially useful for synced variables that interact with your scene in simple ways, e.g., updating text or animators. You can still use <code>OnDeserialization()</code> elsewhere, where appropriate. Especially because <code>[FieldChangeCallback]</code> has a drawback that's easy to forget:

=== FieldChangeCallback execution order issues ===
''Note: This section has not been proofread yet! It may contain factual errors.''

If you use <code>[FieldChangeCallback]</code>to execute cute, avoid referencing other variables that may not have been deserialized yet. For example:<syntaxhighlight>[SerializeField] private TextMeshProUGUI scoreText;
[SerializeField] private TextMeshProUGUI roundText;
[UdonSynced, FieldChangeCallback(nameof(Score))] private int score;
[UdonSynced] private int round;

private bool Score
{
get => score;
set
{
score = value;
scoreText.text = score.ToString();
roundText.text = round.ToString(); // ⚠️ round might be outdated for remote players!
}
}

// If the owner calls the method below, the score and round increase by one.
private void IncreaseScoreAndRound()
{
if (!Networking.IsOwner(gameObject)) return;
round++;
Score++; // ⚠️ Only the owner will see the round and score text correctly.
RequestSerialization();
}</syntaxhighlight>That's because <code>[FieldChangeCallback]</code> may execute ''before'' all synced variables have been deserialized. You may accidentally use outdated values without realizing it! Instead, use <code>OnDeserialization</code> or <code>SendCustomEventDelayed</code> to wait until all variables are deserialized.

== Optimization ==
These tips can help reduce the CPU utilization caused by your scripts.

=== Cache LocalPlayer ===
Cache <code>Networking.LocalPlayer</code> by saving it as a local variable. Re-use the variable instead of calling <code>Networking.LocalPlayer</code> again. For example:<syntaxhighlight lang="c#">
private VRCPlayerApi localPlayer;

private void Start()
{
localPlayer = Networking.LocalPlayer;
}

private void Update()
{
Debug.Log(localPlayer.GetPosition());
}
</syntaxhighlight>This ''slightly'' improves the performance of your behaviour, especially if you reference the local player one or more times per update.

Guides:UdonSharp Nitpicks

2026-05-02T19:43:12Z

Usr 923acdda-9202-4f4d-91c0-d0d7269c96a5: Created page with "{{Noticebox/Community}}{{Noticebox/wip}}Here are some things that Fax considers useful or practical when writing U# code, in no particular order. ''This page was originally posted on [https://vrclibrary.com/wiki/books/faxs-retrospectives-and-prefabs/page/udonsharp-nitpicks VRCLibrary], and was updated for the VRChat wiki. These suggestions are somewhat personal, so if you have any suggestions, please discuss them!'' = A..."

{{Noticebox/Community}}{{Noticebox/wip}}Here are some things that [[User:Usr 923acdda-9202-4f4d-91c0-d0d7269c96a5|Fax]] considers useful or practical when writing U# code, in no particular order.

''This page was originally posted on [https://vrclibrary.com/wiki/books/faxs-retrospectives-and-prefabs/page/udonsharp-nitpicks VRCLibrary], and was updated for the VRChat wiki. These suggestions are somewhat personal, so if you have any suggestions, please discuss them!''

= Attributes =
Attributes, such as <code>[SerializeField]</code>, can help make your classes, variables, or methods more useful.

=== UdonBehaviourSyncMode ===
Use U#'s <code>[https://udonsharp.docs.vrchat.com/udonsharp/#udonbehavioursyncmode UdonBehaviourSyncMode]</code> attribute to make sure your <code>UdonBehaviour</code> always uses the sync mode you intended. For example:<syntaxhighlight lang="c#">using UdonSharp;
using UnityEngine;

[UdonBehaviourSyncMode(BehaviourSyncMode.Manual)]
public class Foo : UdonSharpBehaviour
{
// This behaviour always uses manual sync.
}</syntaxhighlight>Alternatively, you can choose the sync mode UdonBehaviours in the Unity inspector. This is more flexible and allows you to use different sync modes for different instances of the same behaviour - but that's a very rare use case. Instead, you may accidentally select the wrong mode without realizing it, causing networking to break unexpectedly. <code>UdonBehaviourSyncMode</code> is usually more reliable.

=== SerializeField ===
Use the <code>[SerializeField]</code> attribute to make <code>private</code> variable visible in the Unity inspector, allowing you to assign references to assets or scene objects:<syntaxhighlight>
[SerializeField] private Transform foo; // This shows up in the Unity inspector.
</syntaxhighlight>Instead of using <code>[SerializeField]</code>, you can make the variable <code>public</code> instead. However, this '''also''' makes those variables accessible from any other UdonBehaviour. If that's what you want, you should consider using <code>[HideInInspector]</code> attribute to prevent your public variables from causing clutter in the inspector.

=== Tooltip and Header ===
Use the <code>[Header]</code> and <code>[Tooltip]</code> attributes to organize variables in the Unity inspector. For example:<syntaxhighlight lang="c#">
[Header("Materials")]
[SerializeField] private Material materialFoo;
[SerializeField] private Material materialBar;
[SerializeField] private Material materialBaz;

[Header("Transforms")]
[Tooltip("This tooltip appears when hovering your mouse over transformFoo in the inspector.")]
[SerializeField] private Transform transformFoo;
</syntaxhighlight>

= Networking =
This section contains some tips related to networking and synchronizing changes between players.

=== Call <code>OnDeserialization</code> locally ===
When the networking owner of an UdonBehaviour uses <code>RequestSerialization()</code>, all players '''except''' the owner execute <code>OnDeserialization()</code>.

But if you override <code>OnDeserialization()</code> in your script, the owner can manually execute it. This is useful if you'd like the owner of the script to execute <code>OnDeserialization()</code>, to replicate the same behaviour as other players.

For example, here is a simple script that the master can use to increase a <code>score</code> variable. The <code>scoreText</code> is updated for everyone in <code>OnDeserialization</code>.<syntaxhighlight lang="c#" line="1">[UdonSynced] private int score;
[SerializeField] private TextMeshProUGUI scoreText;

// The owner can call IncreaseScore anywhere to increase the score by 1.
public void IncreaseScore()
{
score++;
RequestSerialization();
OnDeserialization();
}

public override void OnDeserialization()
{
scoreText.text = score.ToString();
}</syntaxhighlight>Note that <code>OnDeserialization()</code> ''without'' parameters is a deprecated method. More complex scripts may require the overload <code>OnDeserialization(DeserializationResult)</code>, and executing the overload locally may not make sense for the owner. Instead, consider writing your own method (e.g., <code>UpdateScoreText()</code>, and calling it from <code>OnDeserialization()</code> ''and'' manually calling it for the owner immediately after <code>RequestSerialization()</code>.

''⚠️This section is incomplete! Two sections have not been transferred from VRCLibrary yet.''

== Optimization ==
These tips can help reduce the CPU utilization causing by your scripts.

=== Cache LocalPlayer ===
Cache <code>Networking.LocalPlayer</code> by saving it as a local variable. Re-use the variable instead of calling <code>Networking.LocalPlayer</code> again. For example:<syntaxhighlight lang="c#">
private VRCPlayerApi localPlayer;

private void Start()
{
localPlayer = Networking.LocalPlayer;
}

private void Update()
{
Debug.Log(localPlayer.GetPosition());
}
</syntaxhighlight>This ''slightly'' improves the performance of your behaviour, especially if you reference the local player one or more times per update.

User:Usr 923acdda-9202-4f4d-91c0-d0d7269c96a5

2026-05-02T17:03:40Z

Usr 923acdda-9202-4f4d-91c0-d0d7269c96a5: Created page with "{{DISPLAYTITLE:User: Faxmashine}} Hi!"

{{DISPLAYTITLE:User: Faxmashine}}

Hi!

Creator Economy

2025-03-11T14:06:55Z

Usr 923acdda-9202-4f4d-91c0-d0d7269c96a5: Corrects the release date of the Creator Economy. Adds a citation for the release dates. Updates the application URL to use the new application form. Adds comment about criteria being incomplete.

{{Noticebox/Official}}
VRChat's Creator Economy is a service introduced to VRChat offering users to purchase “VRChat Credits” to support their favorite creators. Creators may also set up a store, if they apply to the Creator Economy Program, and are accepted. All transactions are powered by VRChat's partner, [https://www.tilia.io/ Tilia].

This service was teased during VRChat's [https://youtu.be/QBQnCxtDaso?t=5563 Developer Steam] in April 2021, and its initial testing period was launched to [[Special:MyLanguage/Open Beta|Open Beta]] starting on November 22nd, 2023 and finally released publicly on November 30, 2023<ref>[https://docs.vrchat.com/docs/vrchat-202342 VRChat Release 2023.4.2] from November 30, 2023.</ref>.

==VRChat Credits==
{{credits}} VRChat Credits ''(symbolized by a '''\V''' symbol in plaintext)'', VRC Credits, or simply ''''credits'''<nowiki/>', are digital currency offered to VRChat users to exchange with other VRChat creators for perks. VRChat Credits can be purchased through the Steam Store, Meta Store, or Google Play Store.

=== Purchasing===
[[File:Purchasingscreen.png|thumb|316x316px|VRChat Credits Menu (USD)]]
A user can purchase VRChat Credits by opening up their [[Special:MyLanguage/Main Menu|Main Menu]], going to the '''Marketplace''' tab, and then proceeding to the '''Wallet''' section. Or, by simply clicking the '''Wallet''' button in the top right of the Quick Menu or Main Menu.

There are 5 different VRChat Credits Bundles that can be purchased, ranging from {{credits}}600 to {{credits}}12,000. From there, the user must have sufficient funds available to use on the Steam Store, or Meta Store, depending on where the credits are being purchased from. After completing the transaction, credits will immediately be applied to your account.

====VRChat Credits Bundles ====

{| class="wikitable sortable"
!{{credits}} VRChat Credits
!Value
($USD)
!Value
(€Euro)<small>*</small>
!Value
(¥JPY)
!Value
(¥CNY)
|-
|600
|4.99
|5.75 (Meta) / 5.46 (Steam)
|841 (Meta) / 810 (Steam)
|35.29 (Steam)
|-
|1,200
|9.99
|
|
|
|-
|2,400
|19.99
|
|
|
|-
|6,000
| 49.99
|
|
|
|-
|12,000
|99.99
|
|
|
|}
''*Purchasing credits may include Value-Added Tax (VAT)<ref>{{VRC link|https://hello.vrchat.com/blog/euro-price-vat-change |European Pricing Update for VRChat Plus/Credits}} from 24 May, 2024</ref>''
===Spending ===
Users can spend their VRChat Credits on the {{VRC link|https://vrchat.com/home/marketplace/welcome |website}}, or in the client, through either, [[Special:MyLanguage/Groups|group]] stores or [[Special:MyLanguage/Worlds|world]] stores. Users can buy a listing or a subscription with their VRChat Credits, each listing and subscription has products attached to them, these are ''in layman's terms'' the benefits you receive from the listing or subscription.

The '''Spotlight''' section of the Marketplace tab offers suggestions of worlds and groups that are currently enrolled in the Creator Economy Program.

For more creator-related information, see the Creator Economy documentation.<ref>{{VRC link|https://creators.vrchat.com/economy/ |Creator Economy Documentation}} from 24 May, 2024</ref>''.''
==== Listings====
Listings are what users can buy from world stores. While listings can be anything the world creator decides, users can expect to see common types of listing such as: Unlocking new areas of a world, customization options, and more.

There are 3 types of listings world creators can offer, each type has a different duration type.
{| class="wikitable"
!Listing
!Duration
!Description
|-
|Instant

|None
|Users can purchase this type as many times as they want. Benefits are instantly awarded. This type is only purchasable if you are in the world.
|-
| Temporary
| 5 minutes - 3 months
|Users can purchase this type as many times as they want '''but''' can't repurchase until its duration expires. Benefits earned are only available until its duration expires.
|-
|Permanent
|Unlimited
|Users can only purchase this type once. Benefits are permanently available to the buyer.
|}
====Subscriptions====
Subscriptions are what users can buy from group stores. While listings can be anything the world creator decides, users can expect to see common types of listing such as: VIP access.

Users have 4 default duration options, they can choose from when buying a subscription.

*1 month
*3 months
* 6 months
*12 months

There is also a custom duration option users can choose, which ranges from 1 month to 99 months. Subscriptions do not automatically renew.

When a user buys a subscription, they will be automatically added to the group they bought the subscription from. Buyers will also a group role, which creators can offer group specific benefits.
=== Viewing transaction history===
To view the history of your transactions, navigate to the '''Marketplace''' page on the [[Special:MyLanguage/Main Menu|Main Menu]], proceed to the '''Wallet''' section, and then choose the '''Transactions''' tab. Alternatively, you can view it on the {{VRC link|https://vrchat.com/home/marketplace/wallet |VRChat website}}.

The Transactions tab shows the history of the user's VRChat Credits on their account. Listing the name of the product, the amount of credits, the remaining balance after the purchase, the recipient, the date of purchase, and the type of transaction.

To view your purchases or active and expired subscriptions, navigate to the '''Purchases & Subscriptions''' tab of the '''Marketplace''' page.

The Purchases tab lists any listing you bought, including its type, date of purchase and expiration, and details. While, the Subscriptions tab includes the same details as the Purchases tab, just instead for subscriptions. It is split up by an "Active" and "Expired" dropdown, and also includes an option to renew the subscription or cancel it.

==Enrolling in the Creator Economy Program ==
To be able to enroll in the Creator Economy Program, a user must have uploaded content and have access to the VRChat Creator Companion, and then [https://www.surveymonkey.com/r/vrc-econ-apply apply to become a seller], as long as they are eligible:

====Eligibility====

*Be a User who is 18 years of age or older.
*Have a VRChat account that has been active for at least 30 days.
*Have a current and active subscription to VRChat Plus.
*Have a verified email address associated with your Account.
*Be a community member in good standing at all times while using the Platform, with no suspensions or bans from the Platform or the VRC Creator Economy in the last 90 days.
* Use the Platform in strict compliance with CE Rules, the Terms, the Community Guidelines, and the requirements set out in ''Creator Economy Program Rules Section 5''.
*Not engage in any of the following activities: scamming, phishing, false advertising, attempting to exchange Credits for real currency other than through the Platform, or any illegal or unethical activities.
* Meet any other eligibility requirements that we or our CE Partner may establish from time to time in our or their sole discretion, including but not limited to:
**Having all applicable tax forms on file with the relevant CE Partner
**Completing any applicable CE Partner’s Know Your Customer registration, as required by such CE Partner
{{VRC link|https://hello.vrchat.com/legal/economy |See here}} to view the full Creator Economy Program Rules.

==Resources==
*{{VRC link|https://creators.vrchat.com/economy/ |"Resources for Creator Economy"}} at ''creators.vrchat.com''
*{{VRC link|https://hello.vrchat.com/blog/creator-economy |"Introducing the Creator Economy!"}} at ''hello.vrchat.com''
*{{VRC link|https://hello.vrchat.com/blog/paid-subscriptions-beta |"Paid Subscriptions Beta"}} at ''hello.vrchat.com''
*[https://www.tilia.io/ Tilia's website] at ''tilia.io''

==References==
{{Reflist}}