Version: 2017.3 (switch to 2018.1b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

LineRenderer.widthMultiplier

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public var widthMultiplier: float;
public float widthMultiplier;

Description

Set an overall multiplier that is applied to the LineRenderer.widthCurve to get the final width of the line.

#pragma strict
public var width: float = 1.0f;
public var useCurve: boolean = true;
private var lr: LineRenderer;
function Start() {
	lr = GetComponent.<LineRenderer>();
	lr.material = new Material(Shader.Find("Sprites/Default"));
	// Set some positions
	var positions: Vector3[] = new Vector3[3];
	positions[0] = new Vector3(-2.0f, -2.0f, 0.0f);
	positions[1] = new Vector3(0.0f, 2.0f, 0.0f);
	positions[2] = new Vector3(2.0f, -2.0f, 0.0f);
	lr.positionCount = positions.Length;
	lr.SetPositions(positions);
}
function Update() {
	var curve: AnimationCurve = new AnimationCurve();
	if (useCurve) {
		curve.AddKey(0.0f, 0.0f);
		curve.AddKey(1.0f, 1.0f);
	}
	else {
		curve.AddKey(0.0f, 1.0f);
		curve.AddKey(1.0f, 1.0f);
	}
	lr.widthCurve = curve;
	lr.widthMultiplier = width;
}
function OnGUI() {
	GUI.Label(new Rect(25, 20, 200, 30), "Width");
	width = GUI.HorizontalSlider(new Rect(125, 25, 200, 30), width, 0.1f, 1.0f);
	useCurve = GUI.Toggle(new Rect(25, 65, 200, 30), useCurve, "Use Curve");
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public float width = 1.0f; public bool useCurve = true; private LineRenderer lr;

void Start() { lr = GetComponent<LineRenderer>(); lr.material = new Material(Shader.Find("Sprites/Default"));

// Set some positions Vector3[] positions = new Vector3[3]; positions[0] = new Vector3(-2.0f, -2.0f, 0.0f); positions[1] = new Vector3(0.0f, 2.0f, 0.0f); positions[2] = new Vector3(2.0f, -2.0f, 0.0f); lr.positionCount = positions.Length; lr.SetPositions(positions); }

void Update() { AnimationCurve curve = new AnimationCurve(); if (useCurve) { curve.AddKey(0.0f, 0.0f); curve.AddKey(1.0f, 1.0f); } else { curve.AddKey(0.0f, 1.0f); curve.AddKey(1.0f, 1.0f); }

lr.widthCurve = curve; lr.widthMultiplier = width; }

void OnGUI() { GUI.Label(new Rect(25, 20, 200, 30), "Width"); width = GUI.HorizontalSlider(new Rect(125, 25, 200, 30), width, 0.1f, 1.0f); useCurve = GUI.Toggle(new Rect(25, 65, 200, 30), useCurve, "Use Curve"); } }

Did you find this page useful? Please give it a rating: