gd::TilemapResource Class Reference

Describe a tilemap file used by a project. More...

#include <ResourcesManager.h>

Inherits gd::Resource.

Public Member Functions
virtual TilemapResource *	Clone () const override
virtual const gd::String &	GetFile () const override
	Return, if applicable, the String containing the file used by the resource. The file is relative to the project directory. More...
virtual void	SetFile (const gd::String &newFile) override
	Change, if applicable, the file of the resource. More...
virtual bool	UseFile () const override
	Return true if the resource use a file. More...
std::map< gd::String, gd::PropertyDescriptor >	GetProperties () const override
	Called when the IDE wants to know about the custom properties of the resource. More...
bool	UpdateProperty (const gd::String &name, const gd::String &value) override
	Called when the IDE wants to update a custom property of the resource. More...
void	SerializeTo (SerializerElement &element) const override
	Serialize the object.
void	UnserializeFrom (const SerializerElement &element) override
	Unserialize the object.
bool	IsPreloadDisabled () const
	Return true if the loading at game startup must be disabled.
void	DisablePreload (bool disable=true)
	Set if the tilemap preload at game startup must be disabled.
Public Member Functions inherited from gd::Resource
virtual void	SetName (const gd::String &name_)
	Change the name of the resource with the name passed as parameter.
virtual const gd::String &	GetName () const
	Return the name of the resource.
virtual void	SetKind (const gd::String &newKind)
	Change the kind of the resource.
virtual const gd::String &	GetKind () const
	Return the kind of the resource.
virtual void	SetUserAdded (bool isUserAdded)
	Change if the resource is user added or not.
virtual bool	IsUserAdded () const
	Return true if the resource was added by the user.
virtual void	SetOrigin (const gd::String &originName_, const gd::String &originIdentifier_)
virtual const gd::String &	GetOriginName () const
virtual const gd::String &	GetOriginIdentifier () const
virtual void	SetMetadata (const gd::String &metadata_)
	Set the metadata (any string) associated to the resource. More...
virtual const gd::String &	GetMetadata () const
	Return the (optional) metadata associated to the resource.

Detailed Description

Describe a tilemap file used by a project.

See also

Resource

Member Function Documentation

GetFile()

virtual const gd::String& gd::TilemapResource::GetFile ( ) const

inlineoverridevirtual

Return, if applicable, the String containing the file used by the resource. The file is relative to the project directory.

See also

gd::Resource::UseFile

gd::Resource::SetFile

Reimplemented from gd::Resource.

GetProperties()

std::map< gd::String, gd::PropertyDescriptor > gd::TilemapResource::GetProperties ( ) const

overridevirtual

Called when the IDE wants to know about the custom properties of the resource.

Usage example:

std::map<gd::String, gd::PropertyDescriptor> properties;
properties[ToString(_("Text"))].SetValue("Hello world!");
 
return properties;

Returns

a std::map with properties names as key.

See also

gd::PropertyDescriptor

Reimplemented from gd::Resource.

SetFile()

void gd::TilemapResource::SetFile ( const gd::String &  newFile )

overridevirtual

Change, if applicable, the file of the resource.

See also

gd::Resource::UseFile

gd::Resource::GetFile

Reimplemented from gd::Resource.

UpdateProperty()

bool gd::TilemapResource::UpdateProperty ( const gd::String &  name, const gd::String &  value  )

overridevirtual

Called when the IDE wants to update a custom property of the resource.

Returns

false if the new value cannot be set

Reimplemented from gd::Resource.

UseFile()

virtual bool gd::TilemapResource::UseFile ( ) const

inlineoverridevirtual

Return true if the resource use a file.

See also

gd::Resource::GetFile

gd::Resource::SetFile

Reimplemented from gd::Resource.

---

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

• ResourcesManager.h
• ResourcesManager.cpp