Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


StringToHash(string)

Generates a parameter id from a string.
Read time 1 minuteLast updated 7 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AnimationModule
public static int StringToHash(string name)

Parameters

name

The string to convert to an id.

Returns

Type

Description

intThe hash of the input string.

Remarks

This method uses CRC32 to generate an id from a string. Use a generated id to optimize assigning and retrieving parameters. A generated id is valid as long as the input string doesn't change. This means that a generated id persists between sessions and can be used for networking.

Examples

using UnityEngine;// Press the space key in Play Mode to switch to the Bounce state.[RequireComponent(typeof(Animator))]public class AnimatorPlayExample : MonoBehaviour{ // The Animator component on the GameObject this script is attached to. Animator m_Animator; // Cache the hash of the bounce state. int m_BounceStateHash; void Start() { m_Animator = GetComponent<Animator>(); m_BounceStateHash = Animator.StringToHash("Base Layer.Bounce"); } void Update() { if (Input.GetKeyDown(KeyCode.Space)) { // Play Bounce but start at a quarter of the way through m_Animator.Play(m_BounceStateHash, 0, 0.25f); } }}