key | The key identifying the setting. |
T An instance of the object with fields assigned the corresponding remote values.
Gets the object corresponding to the remote setting identified by key, if it exists.
Remote Settings constructs an object of type T
and sets its fields or properties to the corresponding remote value, matching field name to key name. The process ignores fields in the object that do not correspond to a remote value and, likewise, ignores remote values that do not correspond to a field or property in the type.
If you do not specify a key when calling GetObject()
, Remote Settings treats all of your remote settings as a single object. If you specify a key that does not exist, this function returns null.
Remote Settings converts numbers and boolean types, but it does not convert string types. For example, if you map a float setting to an integer field, the float value is cast to an integer. However, if you attempt to map a numeric or boolean setting to a string field, the string field is left as null. If a remote setting contains an object, that object is converted according to the type of the field in the parent object struct or class.
using UnityEngine;
public class HandleRemoteSettingsGetObject : MonoBehaviour { [System.Serializable] public struct MySettings { public bool enableBoss; public int maxLevelDifficulty; public string defaultPlayerName; public float gameBaseAcceleration; }
private void Start() { MySettings ms = RemoteSettings.GetObject<MySettings>("myGameSettings"); Debug.Log(ms.maxLevelDifficulty); } }
key | The key identifying the setting. |
type | The type of object represented in RemoteSettings. |
object An instance of the object with fields assigned the corresponding remote values.
Gets the object corresponding to the remote setting identified by key, if it exists.
Remote Settings constructs an object of the type specified by the type
parameter and sets its fields or properties to the corresponding remote value, matching field name to key name. The process ignores fields in the object that do not correspond to a remote value and, likewise, ignores remote values that do not correspond to a field or property in the type.
If you do not specify a key when calling GetObject()
, Remote Settings treats all of your remote settings as a single object. If you specify a key that does not exist, this function returns null.
Remote Settings converts numbers and boolean types, but it does not convert string types. For example, if you map a float setting to an integer field, the float value is cast to an integer. However, if you attempt to map a numeric or boolean setting to a string field, the string field is left as null. If a remote setting contains an object, that object is converted according to the type of the field in the parent object struct or class.
using UnityEngine;
public class HandleRemoteSettingsGetObjectWithType : MonoBehaviour { [System.Serializable] public struct MyCustomSettings { public bool enableBoss; public int maxLevelDifficulty; public string defaultPlayerName; public float gameBaseAcceleration; }
private void Start() { MyCustomSettings ms = (MyCustomSettings)RemoteSettings.GetObject(typeof(MyCustomSettings), "myGameSettings"); Debug.Log(ms.maxLevelDifficulty); } }
defaultValue | The object that should be for default values. |
key | The key identifying the setting. |
object An instance of the object with fields assigned the corresponding remote values.
Gets the object corresponding to the remote setting identified by key, if it exists.
Remote Settings constructs an object of the type specified by the type
parameter and sets its fields or properties to the corresponding remote value, matching field name to key name. The process ignores fields in the object that do not correspond to a remote value and, likewise, ignores remote values that do not correspond to a field or property in the type.
If you do not specify a key when calling GetObject()
, Remote Settings treats all of your remote settings as a single object. If you specify a key that does not exist, this function returns null.
Remote Settings converts numbers and boolean types, but it does not convert string types. For example, if you map a float setting to an integer field, the float value is cast to an integer. However, if you attempt to map a numeric or boolean setting to a string field, the string field is left as null. If a remote setting contains an object, that object is converted according to the type of the field in the parent object struct or class.
using UnityEngine;
public class HandleRemoteSettingsGetObjectWithDefault : MonoBehaviour { [System.Serializable] public struct MySettingValues { public bool enableBoss; public int maxLevelDifficulty; public string defaultPlayerName; public float gameBaseAcceleration; }
private void Start() { MySettingValues defaultValue = new MySettingValues(); defaultValue.enableBoss = true; MySettingValues ms = (MySettingValues)RemoteSettings.GetObject("myGameSettings", defaultValue); Debug.Log(ms.maxLevelDifficulty); } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.