ShowCursorIcon | Vanda Engine

Definition

ShowCursorIcon(string resourceDirectoryName_resourceFileName.dds, float cursorSize)

Description

This function shows the resource image resourceDirectoryName_resourceFileName.dds. To find the resource name in this function, first go to Script Editor (Tools > Script Editor). Then, use the Tools > Script Utility menu to open the Script Utility dialog and press the Project Resource button. You can now see all the resources in Script Utility dialog. In this dialog, you can find the desired resource image and click on the Copy Folder_File Name button to copy its full name. Then paste this name into the ShowCursorIcon function. In order for the ShowCursorIcon function to recognize this name, you must first have loaded the resource image through the LoadResource function (see the example).

Parameters

resourceDirectoryName_resourceFileName.dds

Specifies the full name of the resource image.

cursorSize

Specifies the size of the resource image. This value must be greater than 0.0.

Example

timer = 0.0
hidden = false

function Init()
    LoadResource("Images", "Cursor.dds")
    ShowCursorIcon("Images_Cursor.dds", 5.0)
end

function Update()
    if timer < 5.0 then timer = timer + GetElapsedTime() end

    if timer >= 5.0 and not hidden then
          HideCursorIcon("Images_Cursor.dds")
          hidden = true
    end
end

First, using the LoadResource function, we load the “Cursor.dds” image located in the “Images” folder. Then we display this image with size 5.0 using the ShowCursorIcon function. After 5.0 seconds have passed in the Update() event, we hide this resource image using the HideCursorIcon function.