Sprite Factory

ReadMe
Release Notes
Overview
Using the Editor
Upgrading

Concepts
Sprites
Master Sprites
Sprite Groups
Colliders
Locators
Material Sets
SpriteUpdater
SpriteCamera

Advanced
Working in Multiple Projects

Classes
Runtime Classes

Videos
Overview
Creating Sprites
Sprite Inspector
Frame Events
Collision System
Locator System
Material Sets

Links
Sprite Factory Site
Web Documentation
Support
Contact

SpriteFactory.SpriteCollider.OnMouseOverSprite

C#: void OnMouseOverSprite (SpriteFactory.SpriteCollider.CollisionData collisionData)
JS: function OnMouseOverSprite (collisionData : SpriteFactory.SpriteCollider.CollisionData) : void

Description
Called every frame while the mouse is over the Collider. This message is sent to all component siblings of the Sprite which owns this SpriteCollider.

The collisionData object contains information about the collision. collisionData.spriteColliderId and collisionData.spriteColliderName can be used to determine which collider the mouse is interacting with.

This function is not called on objects that belong to Ignore Raycast layer.

IMPORTANT: This message is not sent on mobile platforms.

NOTE: SpriteColliders set to Parent in the Sprite Factory editor do not send this message. For Parent colliders (generated colliders that exist on the same GameObject as the main Sprite component), use the standard Unity OnMouseOver instead.

Example:

C#:
// Attach this script to the GameObject that contains your main Sprite component
using UnityEngine;
using System.Collections;
using SpriteFactory;

public class MouseOver : MonoBehaviour {
   void OnMouseOverSprite(SpriteFactory.SpriteCollider.CollisionData collisionData) {
       if(collisionData.spriteColliderName == "MouseCollider") { // test collider name to determine which responded
           Debug.Log(collisionData.spriteColliderName + " was moused over!");
       }
   }
}

JS:

// Attach this script to the GameObject that contains your main Sprite component
import SpriteFactory;

function OnMouseOverSprite(collisionData : SpriteFactory.SpriteCollider.CollisionData) : void {
    if(collisionData.spriteColliderName == "MouseCollider") { // test collider name to determine which responded
        Debug.Log(collisionData.spriteColliderName + " was moused over!");
    }
}