Drag[en]gine Script Module DragonScript Script API  1.0
LanguagePack Class Reference

Immutable language pack resources. More...

Inheritance diagram for LanguagePack:

Public Member Functions

String getFilename ()
 Normalized filename the language pack has been loaded from. More...
UnicodeString getName ()
 Name. More...
UnicodeString getDescription ()
 Description. More...
bool equals (Object other)
 LanguagePack is equal to another object. More...
int hashCode ()
 Hash code for use as dictionary keys. More...


LanguagePack new (String filename)
 Load language pack from file. More...
static void loadAsynchron (String filename, ResourceNotifier notifier)
 Load language pack from file asynchronously. More...

Detailed Description

Immutable language pack resources.

LanguagePack resources provide static precanned language pack data to be used with Animators to produce dynamic language packs.

This is a native class. It can not be subclassed.

Roland Pl├╝ss

Member Function Documentation

◆ equals()

bool equals ( Object  other)

LanguagePack is equal to another object.

Implements Object.equals(Object).

true if other is of type LanguagePack and both point to the same engine language pack resource.

◆ getDescription()

UnicodeString getDescription ( )


◆ getFilename()

String getFilename ( )

Normalized filename the language pack has been loaded from.

◆ getName()

UnicodeString getName ( )


◆ hashCode()

int hashCode ( )

Hash code for use as dictionary keys.

Implements Object.hashCode().

◆ loadAsynchron()

static void loadAsynchron ( String  filename,
ResourceNotifier  notifier 

Load language pack from file asynchronously.

Registers a request in the game engine to load an language pack. Once finished or if the file is already loaded the notifier is used to deliver the loaded language pack or null if the loading failed.

◆ new()

LanguagePack new ( String  filename)

Load language pack from file.

If the language pack file has been already loaded it is assigned to this object. If the language pack is not loaded yet the engine loads the language pack. This call blocks until the language pack is fully loaded and ready to be used. For asynchronous loading use loadAsynchron(). Multiple objects can point to the same loaded language pack resource. Once no object instance uses an language pack file anymore it is released from memory.

The documentation for this class was generated from the following file: