Resource keyword - Revision history

Sunjammer: Updating links

2011-08-15T11:23:37Z

Updating links

Sunjammer at 22:38, 2 August 2011

2011-08-02T22:38:09Z

Sunjammer: Fixing category

2011-08-02T22:28:22Z

Fixing category

Sunjammer: moved Resource (dascript type) to Resource keyword

2011-08-02T22:22:41Z

moved Resource (dascript type) to Resource keyword

Sunjammer: /* Examples */

2009-11-20T09:16:22Z

‎Examples

Sunjammer: /* Examples */

2009-11-20T09:16:10Z

‎Examples

Sunjammer: /* See Also */

2009-11-20T09:15:37Z

‎See Also

Sunjammer: Initial layout for dascript types

2009-11-20T09:14:46Z

Initial layout for dascript types

New page

__NOTOC__
The '''resource''' type represents a game resource file.

== Literals ==

A literal is a textual representation of a particular value of a type.

A resource literal must adhere to the pattern '''R"<ResourceName>"'''. The <ResourceName> element must adhere to the pattern '''<ResRef>.<ResType>''' and can be no more than 32 characters including the ".". The <ResRef> and <ResType> elements must only contain lower case letters, numbers, and/or underscores.

<dascript>
// valid resource literals
resource rLiteral1 = R"abomination.utc"; // a creature resource literal
resource rLiteral2 = R"it_some_ale.uti"; // an item resource literal

// invalid resource literals
resource rInvalid1 = "no_prefix_literal.uti"; // causes "Mismatch types" error
resource rInvalid2 = R"no_extension_literal"; // causes "Unknown error" error
resource rInvalid3 = R"too__many__characters__literal.uti"; // causes "Unknown error" error
</dascript>

== Conversion ==

=== Explicit ===

There are no native functions that can be used to convert another data type to a resource.

The following functions can be used to convert a resource to another data type:

* [[ResourceToString]]

=== Implicit ===

There is no implicit conversion to a resource.

== Persistence ==

The following functions allow a resource to exist outside of the scope of the current script by storing it on an object or event:

* [[SetLocalResource]]
* [[SetEventResource]]

The following functions allow a resource which exist outside of the scope of the current script to be used in the current script by retrieving it from an object or event:

* [[GetLocalResource]]
* [[GetEventResource]]


== Examples ==

<dascript>
void main()
{
// uninitialised
resource rDefault;

// initialised using a literal: value = R"resource_test.nss"
resource rLiteral = R"resource_test.nss";

// initialised using a function: value = R"resource_test.nss"
resource rFunction = GetCurrentScriptResource();
}
</dascript>

== See Also ==

[[:Category:Resource functions]], [[:Category:Resource constants]]

[[Category:DAScript types]]

← Older revision		Revision as of 22:38, 2 August 2011
Line 66:		Line 66:
	[[:Category:Resource_functions\|Resource functions]], [[:Category:Resource_constants\|Resource constants]]		[[:Category:Resource_functions\|Resource functions]], [[:Category:Resource_constants\|Resource constants]]

−	[[Category:~~Scripting keywords~~]]	+	[[Category:Keywords]]

← Older revision		Revision as of 22:28, 2 August 2011
Line 66:		Line 66:
	[[:Category:Resource_functions\|Resource functions]], [[:Category:Resource_constants\|Resource constants]]		[[:Category:Resource_functions\|Resource functions]], [[:Category:Resource_constants\|Resource constants]]

−	[[Category:~~DAScript types~~]]	+	[[Category:Scripting keywords]]

@@ Line 55: / Line 55: @@
      // initialised using a literal: value = R"resource_test.nsc"
-     resource rLiteral = R"resource_test.nss";
+     resource rLiteral = R"resource_test.nsc";
      // initialised using a function: value = R"resource_test.nsc"

@@ Line 4: / Line 4: @@
 == Literals ==
-A literal is a textual representation of a particular value of a type.
+A resource [[Scripting terminology#literal|literal]] must adhere to the pattern '''R"<ResourceName>"'''. The <ResourceName> element must adhere to the pattern '''<ResRef>.<ResType>''' and can be no more than 32 characters including the ".". The <ResRef> and <ResType> elements must only contain lower case letters, numbers, and/or underscores.
-−
 A resource literal must adhere to the pattern '''R"<ResourceName>"'''. The <ResourceName> element must adhere to the pattern '''<ResRef>.<ResType>''' and can be no more than 32 characters including the ".". The <ResRef> and <ResType> elements must only contain lower case letters, numbers, and/or underscores.
 <dascript>

← Older revision	Revision as of 22:22, 2 August 2011
(No difference)

@@ Line 54: / Line 54: @@
      resource rDefault;
-     // initialised using a literal: value = R"resource_test.nss"
+     // initialised using a literal: value = R"resource_test.nsc"
      resource rLiteral = R"resource_test.nss";
-     // initialised using a function: value = R"resource_test.nss"
+     // initialised using a function: value = R"resource_test.nsc"
      resource rFunction = GetCurrentScriptResource();
+}

@@ Line 64: / Line 64: @@
 == See Also ==
-[[:Category:Resource functions]], [[:Category:Resource constants]]
+[[:Category:Resource_functions|Resource functions]], [[:Category:Resource_constants|Resource constants]]
 [[Category:DAScript types]]